> ## Documentation Index
> Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 文档

# `openclaw docs`

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

## 用法

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw docs                              # 打印文档入口和示例搜索
openclaw docs --json                       # 以 JSON 格式打印相同的指引
openclaw docs <query...> [--json]          # 搜索实时文档索引
```

| 参数/选项        | 描述                             |
| ------------ | ------------------------------ |
| `[query...]` | 自由格式的搜索查询。多词查询会以空格连接后作为一个整体发送。 |
| `--json`     | 在标准输出上生成一个机器可读的 JSON 对象。       |

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

## 示例

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw docs browser existing-session
openclaw docs browser existing-session --json
openclaw docs sandbox allowHostControl
openclaw docs gateway token secretref
```

## 它是如何工作的

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

## 输出

在富文本（TTY）终端中，结果会渲染为一个标题，后跟一个项目符号列表：页面标题、链接的文档 URL，以及下一行上的一小段摘要。空结果会输出“没有结果。”。

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

```markdown theme={"theme":{"light":"min-light","dark":"min-dark"}}
# 文档搜索：<query>

- [标题](https://docs.openclaw.ai/...) - 摘要
- [标题](https://docs.openclaw.ai/...) - 摘要
```

使用 `--json` 时，stdout 包含一个对象，其中包含规范化的查询和结果列表。未提供查询时，`query` 为 `null`，`url` 为文档入口点，`results` 为空。此时会抑制样式和标题；请求诊断信息仍会输出到 stderr，因此 stdout 可以直接通过管道传递给 JSON 解析器。

## 退出代码

| 代码  | 含义                              |
| --- | ------------------------------- |
| `0` | 搜索成功，包括零结果响应。                   |
| `1` | 托管文档搜索 API 调用失败；stderr 会打印错误消息。 |

## 相关

* [CLI 参考](/cli)
* [在线文档](https://docs.openclaw.ai)