CLI commands

Documentatie

openclaw docs

Doorzoek de live OpenClaw-documentatie-index vanuit de terminal.

Gebruik

bash
openclaw docs                       # print docs entrypoint and example searchopenclaw docs <query...>            # search the live docs index
Argument Beschrijving
[query...] Vrije zoekopdracht. Zoekopdrachten met meerdere woorden worden met spaties samengevoegd en als één geheel verzonden.

Zonder zoekopdracht toont openclaw docs de URL van het documentatie-ingangspunt en een voorbeeld van een zoekopdracht, in plaats van een zoekactie uit te voeren.

Voorbeelden

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

Werking

openclaw docs roept https://docs.openclaw.ai/api/search aan en geeft de JSON-resultaten weer. Voor het zoekverzoek geldt een vaste time-out van 30 seconden.

Uitvoer

In een terminal met uitgebreide opmaak (TTY) worden de resultaten weergegeven als een kop gevolgd door een lijst met opsommingstekens: de paginatitel, een gekoppelde documentatie-URL en op de volgende regel een kort fragment. Bij lege resultaten wordt "Geen resultaten." weergegeven.

In uitvoer zonder uitgebreide opmaak (via een pipe, --no-color, scripts) worden dezelfde gegevens als Markdown weergegeven:

markdown
# Docs search: <query> - [Title](https://docs.openclaw.ai/...) - snippet- [Title](https://docs.openclaw.ai/...) - snippet

Afsluitcodes

Code Betekenis
0 De zoekactie is geslaagd, ook bij antwoorden zonder resultaten.
1 De aanroep van de gehoste API voor het doorzoeken van de documentatie is mislukt; stderr toont de foutmelding.

Gerelateerd

Was this useful?
On this page

On this page