BIBLEIT / Documentação

Referência do protocolo

O protocolo de comandos versão 1 é compartilhado por SSH e pelo endpoint HTTP. Palavras-chave não diferenciam maiúsculas e minúsculas. Use aspas em argumentos com espaços. Comece com HELP para descobrir os comandos permitidos para sua identidade.

Conecte via SSH

Cadastre a chave pública em Configurações → Chaves SSH antes de conectar. O ambiente local usa a porta 2222; o endpoint hospedado usa a porta 22. Uma chave desconhecida ou revogada é rejeitada na negociação.

ssh -p 2222 -i ~/.ssh/bibleit_local_dev -o IdentitiesOnly=yes bibleit-cli@127.0.0.1

HELP
HELP TRANSLATION
HELP LIVE

Respostas e streaming

Cada comando retorna um envelope: OK para sucesso, ERR para falha, ou OK seguido de registros e END para múltiplos registros. Mensagens EVENT são atualizações espontâneas de assinaturas. Associe respostas na ordem FIFO; a versão 1 não tem IDs de requisição. Eventos podem chegar entre envelopes, nunca dentro deles.

Strings usam aspas e escapam aspas e barras invertidas. Booleanos são true/false e contagens são inteiros. translation identifica a edição; book, chapter e verse localizam a passagem; text contém o texto bíblico. verses/results/count indicam a quantidade de registros. Aceite novos campos para compatibilidade futura.

ERR forbidden
ERR rate_limited retry_after_ms=250
EVENT clear

Os exemplos usam dados demonstrativos fixos e o codificador de respostas do servidor. Sua biblioteca, IDs e resultados serão diferentes. Uma resposta demonstrativa não é uma requisição ao servidor em execução.

`PING`

Confira a conexão. pong=true confirma o sucesso.

Permissão necessária none

Comando / requisição

PING

Exemplo de resposta

OK pong=true

Testar no Shell →

`SERVER INFO`

Confira version, protocol_version e capabilities. Exige conexão autenticada.

Permissão necessária server.get

Comando / requisição

SERVER INFO

Exemplo de resposta

OK protocol_version=1 version="0.0.1" capabilities="help,auth,translation,read,search,live"

Testar no Shell →

`TRANSLATION LIST`

Liste traduções instaladas. TRANSLATION LIST ALL inclui o catálogo local. Isso não lista a biblioteca ativada da sua conta.

Permissão necessária translation.list

Comando / requisição

TRANSLATION LIST

Exemplo de resposta

OK translations="WEB"

Testar no Shell →

`ACCOUNT TRANSLATION LIST`

Liste edições ativadas na conta. ACCOUNT TRANSLATION ADD SLUG ativa uma edição instalada; REMOVE a desativa. Ambos exigem translation.list e respeitam os limites da conta.

Permissão necessária translation.list

Comando / requisição

ACCOUNT TRANSLATION LIST

Exemplo de resposta

OK translations="WEB" count=1

Testar no Shell →

`READ WEB 19 23 1`

Leia um versículo. Exige edição ativada. O livro pode ser ID numérico ou nome localizado; capítulo:versículo também é aceito.

Permissão necessária translation.read

Comando / requisição

READ WEB 19 23 1

Exemplo de resposta

OK translation="WEB" book=19 chapter=23 verse=1 text="The LORD is my shepherd; I shall lack nothing."

Testar no Shell →

`READ WEB 19 117`

Leia um capítulo inteiro. verses conta os registros VERSE; END encerra a resposta. Omita o capítulo para ler um livro.

Permissão necessária translation.read

Comando / requisição

READ WEB 19 117

Exemplo de resposta

OK translation="WEB" book=19 chapter=117 verses=2
VERSE text="Praise the LORD, all you nations! Extol him, all you peoples!"
VERSE text="For his loving kindness is great toward us. The LORD's faithfulness endures forever. Praise the LORD!"
END

Testar no Shell →

`SEARCH WEB shepherd`

Busque texto em uma edição ativada. results conta registros retornados. Este exemplo tem um resultado; os resultados reais dependem da edição. O limite padrão é 100.

Permissão necessária translation.search

Comando / requisição

SEARCH WEB shepherd

Exemplo de resposta

OK translation="WEB" results=1
VERSE text="The LORD is my shepherd; I shall lack nothing."
END

Testar no Shell →

`LIVE CREATE "Sunday Service"`

Crie um Live em execução. Copie o id retornado nos próximos comandos e abra /lives/LIVE_ID para o público. A criação usa uma vaga de Live armazenado.

Permissão necessária live.create

Comando / requisição

LIVE CREATE "Sunday Service"

Exemplo de resposta

OK id="demoLive01" name="Sunday Service" paused=false status=running translations="web"

Testar no Shell →

`LIVE LIST`

Liste Lives acessíveis. Um resultado vazio ainda contém count e END.

Permissão necessária live.list

Comando / requisição

LIVE LIST

Exemplo de resposta

OK count=0
END

Testar no Shell →

`LIVE demoLive01 STACK PUSH WEB 19 23 1`

Apresente um versículo em um Live gerenciável em execução. A tradução deve estar ativada. A resposta contém um VERSE por tradução selecionada.

Permissão necessária live.update

Comando / requisição

LIVE demoLive01 STACK PUSH WEB 19 23 1

Exemplo de resposta

OK event=verse translations=1
VERSE translation="WEB" reference="Psalms 23:1" text="The LORD is my shepherd; I shall lack nothing."
END

Testar no Shell →

`LIVE demoLive01 CLEAR`

Limpe a apresentação atual sem excluir o Live. O sucesso retorna event=clear.

Permissão necessária live.update

Comando / requisição

LIVE demoLive01 CLEAR

Exemplo de resposta

OK event=clear

Testar no Shell →

Referência completa de comandos (Markdown)

A referência completa inclui gerenciamento de contas, comandos de operadores, argumentos, segredos de Live, operações da pilha, permissões e ciclo de vida.

Referência completa de comandos (Markdown) ↗