CLI 参考
openclaw 是主要的 CLI 入口点。每个核心命令都有一个专门的参考页面,或者在它所别名的命令下进行记录;该索引列出了这些命令、全局标志以及适用于整个 CLI 的输出样式规则。
根据意图使用设置命令:
openclaw setup创建基准配置和工作区,而无需经历完整的引导式新手引导流程。openclaw onboard是网关、模型身份验证、工作区、渠道、技能和健康检查的完整首次运行引导路径。openclaw configure更改现有设置的特定部分,例如模型身份验证、网关、渠道、插件或技能。openclaw channels add在基准存在后配置渠道账户;不带标志运行以进行引导式渠道设置,或使用特定于渠道的标志以用于脚本。
| 区域 | 命令 |
|---|---|
| 设置和新手引导 | crestodian · setup · onboard · configure · config · completion · doctor · dashboard |
| 重置和卸载 | backup · reset · uninstall · update |
| 消息和代理 | message · agent · agents · acp · mcp |
| 健康检查和会话 | status · health · sessions |
| Gateway(网关) 和日志 | gateway · logs · system |
| 模型和推理 | models · infer · capability (infer 的别名) · memory · commitments · wiki |
| 网络和节点 | directory · nodes · devices · node |
| 运行时和沙盒 | approvals · exec-policy (参见 approvals) · sandbox · tui · chat/terminal (tui --local 的别名) · browser |
| 自动化 | cron · tasks · hooks · webhooks |
| 设备发现和文档 | dns · docs |
| 配对和频道 | pairing · qr · channels |
| 安全性与插件 | security · secrets · skills · plugins · proxy |
| 旧版别名 | daemon (网关服务) · clawbot (命名空间) |
| 插件(可选) | path · voicecall (如果已安装) |
| 标志 | 用途 |
|---|---|
--dev | 将状态隔离在 ~/.openclaw-dev 下并偏移默认端口 |
--profile <name> | 将状态隔离在 ~/.openclaw-<name> 下 |
--container <name> | 指定命名的容器以供执行 |
--no-color | 禁用 ANSI 颜色(也会遵守 NO_COLOR=1) |
--update | openclaw update 的简写(仅限源码安装) |
-V, --version, -v | 打印版本并退出 |
- ANSI 颜色和进度指示器仅在 TTY 会话中渲染。
- OSC-8 超链接在支持的地方渲染为可点击链接;否则 CLI 会回退到纯文本 URL。
--json(以及在支持的地方--plain)会禁用样式以获得干净输出。- 长时间运行的命令会显示进度指示器(支持时使用 OSC 9;4)。
调色板真实来源:src/terminal/palette.ts。
完整命令树
openclaw [--dev] [--profile]
crestodian setup onboard configure config get set unset file schema validate completion doctor dashboard backup create verify security audit secrets reload audit configure apply reset uninstall update wizard status channels list status capabilities resolve logs add remove login logout directory self peers list groups list|members skills search install update list info check plugins list inspect install uninstall update enable disable doctor marketplace list memory status index search path resolve find set validate emit commitments list dismiss wiki status doctor init ingest compile lint search get apply bridge import unsafe-local import obsidian status|search|open|command|daily message send broadcast poll react reactions read edit delete pin unpin pins permissions search thread create|list|reply emoji list|upload sticker send|upload role info|add|remove channel info|list member info voice status event list|create timeout kick ban agent agents list add delete bindings bind unbind set-identity acp mcp serve list show set unset status health sessions cleanup tasks list audit maintenance show notify cancel flow list|show|cancel gateway call usage-cost health status probe discover install uninstall start stop restart run daemon status install uninstall start stop restart logs system event heartbeat last|enable|disable presence models list status set set-image aliases list|add|remove fallbacks list|add|remove|clear image-fallbacks list|add|remove|clear scan infer (alias: capability) list inspect model run|list|inspect|providers|auth login|logout|status image generate|edit|describe|describe-many|providers audio transcribe|providers tts convert|voices|providers|status|enable|disable|set-provider video generate|describe|providers web search|fetch|providers embedding create|providers auth add|login|login-github-copilot|setup-token|paste-token auth order get|set|clear sandbox list recreate explain cron status list get add edit rm enable disable runs run nodes status describe list pending approve reject rename invoke notify push canvas snapshot|present|hide|navigate|eval canvas a2ui push|reset camera list|snap|clip screen record location get devices list remove clear approve reject rotate revoke node run status install uninstall stop restart approvals get set allowlist add|remove exec-policy show preset set browser status start stop reset-profile tabs open focus close profiles create-profile delete-profile screenshot snapshot navigate resize click type press hover drag select upload fill dialog wait evaluate console pdf hooks list info check enable disable install update webhooks gmail setup|run proxy start run coverage sessions query blob purge pairing list approve qr clawbot qr docs dns setup tui chat (alias: tui —local) terminal (alias: tui —local)
插件可以添加额外的顶层命令(例如 `openclaw voicecall`)。聊天斜杠命令
Section titled “聊天斜杠命令”聊天消息支持 /... 命令。请参阅 斜杠命令。
亮点:
/status— 快速诊断。/trace— 会话范围的插件跟踪/调试行。/config— 持久化的配置更改。/debug— 仅运行时的配置覆盖(内存,非磁盘;需要commands.debug: true)。
使用情况跟踪
Section titled “使用情况跟踪”openclaw status --usage 和控制 UI 会在提供 OAuth/API 凭据时显示提供商使用量/配额。数据直接来自提供商使用量端点,并标准化为 X% left。具有当前使用量窗口的提供商:Anthropic、GitHub Copilot、Gemini CLI、OpenAI Codex、MiniMax、Xiaomi 和 z.ai。
有关详细信息,请参阅 使用情况跟踪。