CLI commands

Dokumentation

openclaw docs

Durchsuchen Sie den Live-Index der OpenClaw-Dokumentation über das Terminal.

Verwendung

bash
openclaw docs                       # Einstiegspunkt der Dokumentation und Beispielsuche ausgebenopenclaw docs <query...>            # Live-Index der Dokumentation durchsuchen
Argument Beschreibung
[query...] Frei formulierte Suchanfrage. Mehrteilige Anfragen werden mit Leerzeichen verbunden und als eine übermittelt.

Ohne Suchanfrage gibt openclaw docs die URL des Dokumentationseinstiegspunkts und einen Beispielbefehl für die Suche aus, anstatt eine Suche durchzuführen.

Beispiele

bash
openclaw docs browser existing-sessionopenclaw docs sandbox allowHostControlopenclaw docs gateway token secretref

Funktionsweise

openclaw docs ruft https://docs.openclaw.ai/api/search auf und stellt die JSON-Ergebnisse dar. Für die Suchanfrage gilt ein festes Zeitlimit von 30 Sekunden.

Ausgabe

In einem ausgabestarken Terminal (TTY) werden die Ergebnisse als Überschrift mit anschließender Aufzählung dargestellt: Seitentitel, verlinkte URL der Dokumentation und ein kurzer Textausschnitt in der nächsten Zeile. Bei leeren Ergebnissen wird „Keine Ergebnisse.“ ausgegeben.

Bei nicht ausgabestarker Ausgabe (weitergeleitet, --no-color, Skripte) werden dieselben Daten als Markdown dargestellt:

markdown
# Dokumentationssuche: <query> - [Titel](https://docs.openclaw.ai/...) - Textausschnitt- [Titel](https://docs.openclaw.ai/...) - Textausschnitt

Exit-Codes

Code Bedeutung
0 Suche erfolgreich, einschließlich Antworten ohne Ergebnisse.
1 Der Aufruf der gehosteten Such-API für die Dokumentation ist fehlgeschlagen; stderr gibt die Fehlermeldung aus.

Verwandte Themen

Was this useful?
On this page

On this page