Skip to main content

​
openclaw docs

Search the live OpenClaw docs index from the terminal.

​
Usage

With no query, openclaw docs prints the docs entrypoint URL and a sample search command instead of running a search.

​
Examples

​
How it works

openclaw docs calls https://docs.openclaw.ai/api/search and renders the JSON results. The search request uses a fixed 30 second timeout.

​
Output

In a rich (TTY) terminal, results render as a heading followed by a bullet list: page title, linked docs URL, and a short snippet on the next line. Empty results print “No results.”. In non-rich output (piped, --no-color, scripts), the same data renders as Markdown:
With --json, stdout contains one object with the normalized query and result list. With no query, query is null, url is the docs entrypoint, and results is empty. Styling and headings are suppressed; request diagnostics stay on stderr so stdout can be piped directly to a JSON parser.

​
Exit codes