BIBLEIT / Dokumentation

Protokollreferenz

Das Befehlsprotokoll Version 1 wird von SSH und dem HTTP-Endpunkt verwendet. Groß- und Kleinschreibung spielt bei Schlüsselwörtern keine Rolle. Setze Argumente mit Leerzeichen in Anführungszeichen. HELP zeigt die für deine Identität erlaubten Befehle.

Über SSH verbinden

Registriere deinen öffentlichen Schlüssel unter Einstellungen → SSH-Schlüssel. Lokal wird Port 2222 verwendet, gehostet Port 22. Unbekannte oder widerrufene Schlüssel werden beim Verbindungsaufbau abgelehnt.

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

HELP
HELP TRANSLATION
HELP LIVE

Antworten und Streaming

Jeder Befehl liefert eine Antwort: OK bei Erfolg, ERR bei Fehlern oder OK mit Datensätzen und END. EVENT-Nachrichten sind spontane Abonnementupdates. Ordne Antworten in FIFO-Reihenfolge zu; Version 1 hat keine Anfrage-IDs. Ereignisse können zwischen Antwortblöcken eintreffen, niemals darin.

Strings stehen in Anführungszeichen; Anführungszeichen und Backslashes werden maskiert. Boolesche Werte sind true/false, Zähler sind Ganzzahlen. translation bezeichnet die Ausgabe; book, chapter und verse die Stelle; text den Bibeltext. verses/results/count geben die Anzahl der Datensätze an. Akzeptiere zusätzliche Felder für zukünftige Kompatibilität.

ERR forbidden
ERR rate_limited retry_after_ms=250
EVENT clear

Beispiele verwenden feste Demodaten und den Antwortencoder des Servers. Deine Bibliothek, IDs und Ergebnisse unterscheiden sich. Eine Demoantwort ist keine Anfrage an den laufenden Server.

`PING`

Prüfe die Verbindung. pong=true bestätigt einen erfolgreichen Befehl.

Erforderliche Berechtigung none

Befehl / Anfrage

PING

Beispielantwort

OK pong=true

In Shell ausprobieren →

`SERVER INFO`

Prüfe version, protocol_version und capabilities. Eine authentifizierte Verbindung ist erforderlich.

Erforderliche Berechtigung server.get

Befehl / Anfrage

SERVER INFO

Beispielantwort

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

In Shell ausprobieren →

`TRANSLATION LIST`

Liste installierte Übersetzungen auf. TRANSLATION LIST ALL enthält den lokalen Katalog. Dies ist nicht die aktivierte Kontobibliothek.

Erforderliche Berechtigung translation.list

Befehl / Anfrage

TRANSLATION LIST

Beispielantwort

OK translations="WEB"

In Shell ausprobieren →

`ACCOUNT TRANSLATION LIST`

Liste aktivierte Ausgaben des Kontos auf. ACCOUNT TRANSLATION ADD SLUG aktiviert eine installierte Ausgabe; REMOVE deaktiviert sie. Beide benötigen translation.list und beachten Kontolimits.

Erforderliche Berechtigung translation.list

Befehl / Anfrage

ACCOUNT TRANSLATION LIST

Beispielantwort

OK translations="WEB" count=1

In Shell ausprobieren →

`READ WEB 19 23 1`

Lies einen Vers aus einer aktivierten Ausgabe. Buch kann eine numerische ID oder ein lokalisierter Name sein; Kapitel:Vers wird ebenfalls akzeptiert.

Erforderliche Berechtigung translation.read

Befehl / Anfrage

READ WEB 19 23 1

Beispielantwort

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

In Shell ausprobieren →

`READ WEB 19 117`

Lies ein vollständiges Kapitel. verses zählt die VERSE-Datensätze; END beendet die Antwort. Ohne Kapitel wird ein Buch gelesen.

Erforderliche Berechtigung translation.read

Befehl / Anfrage

READ WEB 19 117

Beispielantwort

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

In Shell ausprobieren →

`SEARCH WEB shepherd`

Suche Versetext in einer aktivierten Ausgabe. results zählt die Datensätze. Das Beispiel enthält einen Treffer; tatsächliche Ergebnisse hängen von der Ausgabe ab. Standardlimit: 100 Treffer.

Erforderliche Berechtigung translation.search

Befehl / Anfrage

SEARCH WEB shepherd

Beispielantwort

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

In Shell ausprobieren →

`LIVE CREATE "Sunday Service"`

Erstelle ein laufendes Live. Verwende die zurückgegebene id in weiteren Befehlen und öffne /lives/LIVE_ID für Zuschauer. Das Erstellen belegt einen gespeicherten Live-Platz.

Erforderliche Berechtigung live.create

Befehl / Anfrage

LIVE CREATE "Sunday Service"

Beispielantwort

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

In Shell ausprobieren →

`LIVE LIST`

Liste zugängliche Lives auf. Auch ein leeres Ergebnis enthält count und END.

Erforderliche Berechtigung live.list

Befehl / Anfrage

LIVE LIST

Beispielantwort

OK count=0
END

In Shell ausprobieren →

`LIVE demoLive01 STACK PUSH WEB 19 23 1`

Präsentiere einen Vers in einem verwaltbaren, laufenden Live. Die Übersetzung muss aktiviert sein. Die Antwort enthält einen VERSE-Datensatz pro ausgewählter Übersetzung.

Erforderliche Berechtigung live.update

Befehl / Anfrage

LIVE demoLive01 STACK PUSH WEB 19 23 1

Beispielantwort

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

In Shell ausprobieren →

`LIVE demoLive01 CLEAR`

Leere die aktuelle Zuschauerpräsentation, ohne das Live zu löschen. Erfolg liefert event=clear.

Erforderliche Berechtigung live.update

Befehl / Anfrage

LIVE demoLive01 CLEAR

Beispielantwort

OK event=clear

In Shell ausprobieren →

Vollständige Befehlsreferenz (Markdown)

Die vollständige Referenz enthält Kontoverwaltung, Operatorbefehle, Argumente, Live-Geheimnisse, Stapeloperationen, Berechtigungen und Lebenszyklus.

Vollständige Befehlsreferenz (Markdown) ↗