CLI commands

Documentatie

`openclaw docs`

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

Gebruik

bash

openclaw docs                       # toon het beginpunt van de documentatie en een voorbeeldzoekopdrachtopenclaw docs <query...>            # doorzoek de live documentatie-index

Argument	Beschrijving
`[query...]`	Vrije zoekopdracht. Zoekopdrachten met meerdere woorden worden met spaties samengevoegd en als één zoekopdracht verzonden.

Zonder zoekopdracht toont openclaw docs de URL van het beginpunt van de documentatie en een voorbeeldzoekopdracht in plaats van een zoekopdracht 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 de zoekaanvraag geldt een vaste time-out van 30 seconden.

Uitvoer

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

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

markdown

# Documentatie doorzoeken: <query> - [Titel](https://docs.openclaw.ai/...) - fragment- [Titel](https://docs.openclaw.ai/...) - fragment

Afsluitcodes

Code	Betekenis
`0`	De zoekopdracht is geslaagd, ook als er geen resultaten zijn.
`1`	De API-aanroep voor het doorzoeken van de gehoste documentatie is mislukt; stderr toont de foutmelding.

Gerelateerd

Was this useful?

Op deze pagina