CLI commands

Dokumentation

openclaw docs

Durchsuchen Sie den Live-Index der OpenClaw-Dokumentation vom Terminal aus.

Verwendung

bash
openclaw docs                       # Einstiegspunkt der Dokumentation und Beispielsuche ausgebenopenclaw docs <query...>            # Live-Index der Dokumentation durchsuchen
Argument Beschreibung
[query...] Freiform-Suchabfrage. Abfragen mit mehreren Wörtern werden mit Leerzeichen verbunden und als eine Abfrage gesendet.

Ohne Abfrage gibt openclaw docs die URL des Dokumentationseinstiegspunkts und einen Beispiel-Suchbefehl aus, anstatt eine Suche auszufü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 Auszug in der nächsten Zeile. Bei leeren Ergebnissen wird „Keine Ergebnisse.“ ausgegeben.

Bei einer Ausgabe ohne Rich-Darstellung (über eine Pipe, --no-color, Skripte) werden dieselben Daten als Markdown dargestellt:

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

Exit-Codes

Code Bedeutung
0 Die Suche war erfolgreich, einschließlich Antworten ohne Ergebnisse.
1 Der API-Aufruf der gehosteten Dokumentationssuche ist fehlgeschlagen; stderr gibt die Fehlermeldung aus.

Verwandte Themen

Was this useful?
On this page

On this page