openclaw docs¶

从终端搜索实时 OpenClaw 文档索引。

用法¶

openclaw docs                              # print docs entrypoint and example search
openclaw docs --json                       # print the same guidance as JSON
openclaw docs <query...> [--json] [--limit <count>]

在没有查询时，openclaw docs 会打印文档入口 URL 和一条示例搜索命令，而不是执行搜索。

省略 --limit 可显示搜索服务返回的全部结果。限制仅适用于显示的结果，不会减少下载的响应大小。

示例¶

openclaw docs browser existing-session
openclaw docs browser existing-session --json
openclaw docs plugin --limit 5
openclaw docs sandbox allowHostControl
openclaw docs gateway token secretref

工作原理¶

openclaw docs 调用 https://docs.openclaw.ai/api/search 并渲染 JSON 结果。搜索请求使用固定的 30 秒超时。

输出¶

在富格式（TTY）终端中，结果会渲染为一个标题后接项目符号列表：页面标题、文档 URL 链接和下一行的简短摘要。空结果会打印 "No results."。

没有结果数组的响应属于格式错误，会导致命令失败；不会将其视为成功但无匹配项的搜索。

在非富格式输出中（管道、--no-color、脚本），相同的数据会以 Markdown 格式渲染：

# Docs search: <query>

- [Title](https://docs.openclaw.ai/...) - snippet
- [Title](https://docs.openclaw.ai/...) - snippet

使用 --json 时，stdout 会包含一个对象，内含规范化后的查询和结果列表。如果没有查询，query 为 null，url 为文档入口，results 为空。样式和标题会被抑制；请求诊断信息保留在 stderr 中，因此 stdout 可以直接通过管道传递给 JSON 解析器。

失败时，--json 会在 stdout 上输出 CLI JSON 失败信封，同时将错误消息保留在 stderr 上。

退出码¶

相关¶

• CLI 参考
• 在线文档