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...]`	Freie Suchanfrage. Abfragen mit mehreren Wörtern werden mit Leerzeichen verbunden und als eine Abfrage gesendet.

Ohne Suchanfrage gibt openclaw docs die URL des Dokumentationseinstiegspunkts und einen Beispiel-Suchbefehl aus, statt 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 Rich-Terminal (TTY) werden die Ergebnisse als Überschrift mit anschließender Aufzählung dargestellt: Seitentitel, verlinkte Dokumentations-URL und ein kurzer Ausschnitt in der nächsten Zeile. Bei leeren Ergebnissen wird „Keine Ergebnisse.“ ausgegeben.

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

markdown

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

Exit-Codes

Code	Bedeutung
`0`	Die Suche war erfolgreich, einschließlich Antworten mit null Ergebnissen.
`1`	Der API-Aufruf für die gehostete Dokumentationssuche ist fehlgeschlagen; stderr gibt die Fehlermeldung aus.