Documentation Index
Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
openclaw docs
从终端搜索实时 OpenClaw 文档索引。该命令会调用公开的 Mintlify 托管文档 MCP 搜索端点 https://docs.openclaw.ai/mcp.SearchOpenClaw,并在你的终端中呈现结果。
用法
| 参数 | 描述 |
|---|---|
[query...] | 自由格式搜索查询。多词查询会用空格连接,并作为一个查询发送。 |
示例
openclaw docs 会打印文档入口 URL 和一个示例搜索命令,而不是运行搜索。
工作原理
openclaw docs 会调用 mcporter CLI 来调用文档搜索 MCP 工具,然后将工具输出中的 Title: / Link: / Content: 块解析为结果列表。
为解析 mcporter,OpenClaw 会按顺序检查:
PATH上的mcporter(如果存在则直接使用)。- 如果已安装
pnpm,则使用pnpm dlx mcporter ...。 - 如果已安装
npx,则使用npx -y mcporter ...。
pnpm(npm install -g pnpm)。
搜索调用使用固定的 30 秒超时。结果摘要会被截断为每条约 220 个字符。
输出
在富文本(TTY)终端中,结果会呈现为一个标题,后跟项目符号列表。每个项目符号会显示页面标题、链接的文档 URL,以及下一行的简短摘要。空结果会打印 “No results.”。 在非富文本输出中(管道、--no-color、脚本),相同数据会呈现为 Markdown:
退出代码
| 代码 | 含义 |
|---|---|
0 | 搜索成功(包括零结果响应)。 |
1 | MCP 工具调用失败;stderr 会内联打印。 |