Skip to main content

openclaw docs

从终端搜索在线 OpenClaw 文档索引。该命令调用 OpenClaw 托管在 Cloudflare 上的文档搜索 API,并将结果渲染到你的终端中。

用法

openclaw docs                       # 打印文档入口和示例搜索
openclaw docs <query...>            # 搜索实时文档索引
参数:
ArgumentDescription
[query...]自由格式的搜索查询。多词查询会用空格连接,并作为一个整体发送。

示例

openclaw docs browser existing-session
openclaw docs sandbox allowHostControl
openclaw docs gateway token secretref
如果不提供查询,openclaw docs 会打印文档入口 URL 和一个示例搜索命令,而不是执行搜索。

工作原理

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

退出码

CodeMeaning
0搜索成功(包括零结果响应)。
1托管的文档搜索 API 调用失败;stderr 会就地打印。

相关