CLI commands
Docs
openclaw docs
Search the live OpenClaw docs index from the terminal.
Usage
openclaw docs # print docs entrypoint and example searchopenclaw docs --json # print the same guidance as JSONopenclaw docs <query...> [--json] [--limit <count>]| Argument/option | Description |
|---|---|
[query...] |
Free-form search query. Multi-word queries are joined with spaces and sent as one. |
--json |
Emit one machine-readable JSON object on stdout. |
--limit <count> |
Return at most this many results. The value must be a positive integer. |
With no query, openclaw docs prints the docs entrypoint URL and a sample search command instead of running a search.
Omit --limit to show all results returned by the search service. The limit applies to displayed results and does not reduce the downloaded response size.
Examples
openclaw docs browser existing-sessionopenclaw docs browser existing-session --jsonopenclaw docs plugin --limit 5openclaw docs sandbox allowHostControlopenclaw docs gateway token secretrefHow 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:
# Docs search: <query> - [Title](https://docs.openclaw.ai/...) - snippet- [Title](https://docs.openclaw.ai/...) - snippetWith --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
| Code | Meaning |
|---|---|
0 |
Search succeeded, including zero-result responses. |
1 |
The hosted docs search API call failed; stderr prints the error message. |
