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.
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
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.”. A response without a results array is malformed and fails the command; it is not treated as a successful search with no matches. In non-rich output (piped,--no-color, scripts), the same data renders as Markdown:
--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.
On failure, --json emits the CLI JSON failure envelope on stdout
while retaining the error message on stderr.