`openclaw docs`

Search the live OpenClaw docs index from the terminal. The command shells out to the public Mintlify-hosted docs MCP search endpoint at https://docs.openclaw.ai/mcp.SearchOpenClaw and renders the results in your terminal.

Usage

openclaw docs                       # print docs entrypoint and example search
openclaw docs <query...>            # search the live docs index

Arguments:

Argument	Description
`[query...]`	Free-form search query. Multi-word queries are joined with spaces and sent as one.

Examples

openclaw docs browser existing-session
openclaw docs sandbox allowHostControl
openclaw docs gateway token secretref

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

How it works

openclaw docs invokes the mcporter CLI to call the docs search MCP tool, then parses the Title: / Link: / Content: blocks from the tool output into a list of results.

To resolve mcporter, OpenClaw checks in order:

mcporter on PATH (used directly if present).
pnpm dlx mcporter ... if pnpm is installed.
npx -y mcporter ... if npx is installed.

If none are available, the command fails with a hint to install pnpm (npm install -g pnpm).

The search call uses a fixed 30 second timeout. Result snippets are truncated to ~220 characters per entry.

Output

In a rich (TTY) terminal, results render as a heading followed by a bullet list. Each bullet shows the page title, the 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/...) - snippet

Exit codes

Code	Meaning
`0`	Search succeeded (including zero-result responses).
`1`	The MCP tool call failed; stderr is printed inline.

2.6 KiB Raw Blame History

openclaw docs