Skip to content

openclaw docs 让你无需打开浏览器,直接在终端搜索 OpenClaw 官方文档。支持多词模糊查询,结果包含标题、链接和摘要(约220字符)。如果未安装 mcporter,命令会自动尝试 pnpm dlx 或 npx。无参数时打印文档入口和示例命令。

openclaw docs 命令 - 终端搜索 OpenClaw 实时文档

从终端搜索 OpenClaw 实时文档索引。该命令会调用公开的 Mintlify 托管文档 MCP 搜索端点(https://docs.openclaw.ai/mcp.search_open_claw),并将结果渲染到终端。

用法

bash
openclaw docs                       # 打印文档入口和示例搜索
openclaw docs <query...>            # 搜索实时文档索引

参数说明

参数描述
[query...]自由文本搜索查询。多个单词将以空格拼接后作为单一查询发送。

示例

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

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

工作原理

openclaw docs 调用 mcporter CLI 来运行文档搜索的 MCP 工具,然后从工具输出中解析 Title: / Link: / Content: 区块,整理成结果列表。

它按以下顺序查找 mcporter

  1. PATH 上的 mcporter(如果存在则直接使用)。
  2. 如果安装了 pnpm,则使用 pnpm dlx mcporter ...
  3. 如果安装了 npx,则使用 npx -y mcporter ...

如果上述方式均不可用,命令会失败并提示安装 pnpmnpm install -g pnpm)。

搜索调用使用固定的 30 秒超时。每条结果摘要截断至约 220 字符。

输出格式

在富文本(TTY)终端中,结果呈现为标题后跟无序列表。每条结果显示页面标题、文档 URL 链接以及下一行的简短摘要。空结果显示 "No results."。

在非富文本输出(管道重定向、--no-color、脚本)中,相同数据以 Markdown 格式呈现:

markdown
# Docs search: <query>

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

退出码

退出码含义
0搜索成功(包括返回零条结果)。
1MCP 工具调用失败;错误信息直接输出到 stderr。

相关文档

常见问题

怎么在终端搜索 OpenClaw 文档?

直接运行 openclaw docs <关键词>,例如 openclaw docs gateway token。不传关键词会显示入口和示例。

openclaw docs 搜索结果不显示内容怎么办?

检查网络连接是否正常。如果命令报错提示找不到 mcporter,请安装 pnpmnpm install -g pnpm)或确保 mcporter 已加入系统 PATH。

openclaw docs 依赖什么工具?

依赖 mcporter 命令行工具。OpenClaw 会优先使用 PATH 中的 mcporter,其次尝试 pnpm dlxnpx。搜索超时为 30 秒,结果摘要约 220 字符。