Skip to content
广告 · 本站推荐广告

openclaw docs

快速访问 OpenClaw 文档,支持在浏览器中打开在线文档或启动本地文档服务器。

命令签名

bash
openclaw docs [topic] [选项]

选项

选项类型说明
--localboolean启动本地文档服务器
--port <port>number本地服务器端口(默认 18792

说明

openclaw docs 提供多种文档访问方式:

  • 不带参数 — 在浏览器中打开文档首页
  • 带主题参数 — 直接跳转到指定主题的文档
  • 本地模式 — 启动本地文档服务器(离线访问)

可用主题

主题说明
quickstart快速入门指南
config配置参考
channels渠道配置指南
agentsAgent 配置指南
cron定时任务指南
hooks钩子开发指南
apiAPI 参考文档
cliCLI 命令参考

示例

bash
# 打开文档首页
openclaw docs

# 查看快速入门
openclaw docs quickstart

# 查看配置参考
openclaw docs config

# 查看渠道指南
openclaw docs channels

# 启动本地文档服务器
openclaw docs --local

# 指定端口
openclaw docs --local --port 3000

本地文档服务器

使用 --local 标志启动一个本地 Web 服务器,提供离线文档浏览:

bash
openclaw docs --local
✔ 文档服务器已启动
  → http://localhost:18792

TIP

本地文档随 OpenClaw 安装版本一起分发,可能不包含最新的在线更新。

另请参阅

基于MIT协议开源 | 内容翻译自 官方文档,同步更新