CLI 参考

CLI 参考

这篇文档描述了当前 CLI 的行为。如果命令有变动,记得更新本文档。

命令页面

全局标志

输出样式

配色方案

OpenClaw 使用龙虾配色方案进行 CLI 输出。

配色方案源文件:src/terminal/palette.ts(又称 "lobster seam")

命令树

openclaw [--dev] [--profile <name>] <command>
  setup                    # 初始化配置
  onboard                  # 交互式引导
  configure                # 配置向导
  config                   # 配置管理
    get                    # 获取配置值
    set                    # 设置配置值
    unset                  # 删除配置值
  doctor                   # 健康检查
  security                 # 安全相关
    audit                  # 安全审计
  reset                    # 重置
  uninstall                # 卸载
  update                   # 更新
  channels                 # 频道管理
    list                   # 列出频道
    status                 # 检查频道状态
    logs                   # 查看频道日志
    add                    # 添加频道
    remove                 # 移除频道
    login                  # 登录频道
    logout                 # 登出频道
  skills                   # 技能管理
    list                   # 列出技能
    info                   # 技能详情
    check                  # 检查技能状态
  plugins                  # 插件管理
    list                   # 列出插件
    info                   # 插件详情
    install                # 安装插件
    enable                 # 启用插件
    disable                # 禁用插件
    doctor                 # 插件诊断
  memory                   # 记忆搜索
    status                 # 索引状态
    index                  # 重新索引
    search                 # 语义搜索
  message                  # 消息操作
  agent                    # 单次 Agent 运行
  agents                   # Agent 管理
    list                   # 列出 Agent
    add                    # 添加 Agent
    delete                 # 删除 Agent
  acp                      # ACP 桥接
  status                   # 状态查看
  health                   # 健康检查
  sessions                 # 会话管理
  gateway                  # Gateway 管理
    call                   # RPC 调用
    health                 # 健康检查
    status                 # 状态查看
    probe                  # 探针测试
    discover               # 发现服务
    install                # 安装服务
    uninstall              # 卸载服务
    start                  # 启动服务
    stop                   # 停止服务
    restart                # 重启服务
    run                    # 运行 Gateway
  logs                     # 日志查看
  system                   # 系统管理
    event                  # 系统事件
    heartbeat              # 心跳控制
    presence               # 在线状态
  models                   # 模型管理
    list                   # 列出模型
    status                 # 模型状态
    set                    # 设置默认模型
    set-image              # 设置图像模型
    aliases                # 模型别名
    fallbacks              # 回退模型
    image-fallbacks        # 图像回退
    scan                   # 扫描模型
    auth                   # 认证管理
  sandbox                  # 沙盒管理
    list                   # 列出沙盒
    recreate               # 重建沙盒
    explain                # 解释策略
  cron                     # 定时任务
    status                 # 查看状态
    list                   # 列出任务
    add                    # 添加任务
    edit                   # 编辑任务
    rm                     # 删除任务
    enable                 # 启用任务
    disable                # 禁用任务
    runs                   # 运行记录
    run                    # 立即运行
  nodes                    # 节点管理
  devices                  # 设备管理
  node                     # 节点主机
    run                    # 运行节点
    status                 # 查看状态
    install                # 安装服务
    uninstall              # 卸载服务
    start                  # 启动服务
    stop                   # 停止服务
    restart                # 重启服务
  approvals                # 审批管理
    get                    # 获取审批
    set                    # 设置审批
    allowlist              # 白名单管理
  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                    # 导出 PDF
  hooks                    # 钩子管理
    list                   # 列出钩子
    info                   # 钩子详情
    check                  # 检查可用性
    enable                 # 启用钩子
    disable                # 禁用钩子
    install                # 安装钩子
    update                 # 更新钩子
  webhooks                 # Webhook 管理
    gmail                  # Gmail 集成
  pairing                  # 配对管理
    list                   # 列出请求
    approve                # 批准配对
  docs                     # 文档搜索
  dns                      # DNS 配置
    setup                  # 设置 DNS
  tui                      # 终端 UI

注意:插件可以添加额外的顶级命令(例如 openclaw voicecall)。

安全

插件

管理扩展及其配置:

大多数插件更改需要重启 Gateway。详见 /plugin

记忆(Memory)

MEMORY.md + memory/*.md 进行向量搜索:

聊天斜杠命令

聊天消息支持 /... 命令(文本和原生)。详见 [/tools/slash-commands(../tools/slash-commands.html)。

亮点:

设置与引导

setup

初始化配置 + 工作空间。

选项:

当存在任何向导标志时(--non-interactive, --mode, --remote-url, --remote-token),向导会自动运行。

onboard

交互式向导,设置 Gateway、工作空间和技能。

选项:

configure

交互式配置向导(模型、频道、技能、Gateway)。

config

非交互式配置助手(get/set/unset)。不带子命令运行 openclaw config 会启动向导。

子命令:

doctor

健康检查 + 快速修复(配置 + Gateway + 旧版服务)。

选项:

频道助手

channels

管理聊天频道账户(WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost/Signal/iMessage/MS Teams)。

子命令:

常用选项:

channels login 选项:

channels logout 选项:

channels list 选项:

channels logs 选项:

更多详情:[/concepts/oauth(../concepts/oauth.html)

示例:

# 添加 Telegram 频道
openclaw channels add --channel telegram --account alerts --name "Alerts Bot" --token $TELEGRAM_BOT_TOKEN

# 添加 Discord 频道
openclaw channels add --channel discord --account work --name "Work Bot" --token $DISCORD_BOT_TOKEN

# 移除 Discord 频道
openclaw channels remove --channel discord --account work --delete

# 检查状态
openclaw channels status --probe
openclaw status --deep

skills

列出并检查可用技能及其就绪信息。

子命令:

选项:

提示:使用 npx clawdhub 搜索、安装和同步技能。

pairing

批准跨频道的 DM 配对请求。

子命令:

webhooks gmail

Gmail Pub/Sub 钩子设置 + 运行器。详见 [/automation/gmail-pubsub(../automation/gmail-pubsub.html)。

子命令:

dns setup

广域发现 DNS 助手(CoreDNS + Tailscale)。详见 [/gateway/discovery(../gateway/discovery.html)。

选项:

消息与 Agent

message

统一出站消息 + 频道操作。

详见:[/cli/message(../cli/message.html)

子命令:

示例:

# 发送消息
openclaw message send --target +15555550123 --message "Hi"

# 创建投票
openclaw message poll --channel discord --target channel:123 --poll-question "Snack?" --poll-option Pizza --poll-option Sushi

agent

通过 Gateway 运行单次 Agent 对话(或 --local 嵌入式)。

必需:

选项:

agents

管理隔离的 Agent(工作空间 + 认证 + 路由)。

agents list

列出已配置的 Agent。

选项:

agents add [name]

添加新的隔离 Agent。除非传递标志(或 --non-interactive),否则运行引导向导;非交互模式需要 --workspace

选项:

绑定规格使用 channel[:accountId]。对于 WhatsApp,省略 accountId 时使用默认账户 ID。

agents delete <id>

删除 Agent 并清理其工作空间 + 状态。

选项:

acp

运行连接 IDE 到 Gateway 的 ACP 桥接。

详见 [acp(../cli/acp.html) 获取完整选项和示例。

status

显示链接的会话健康和最近收件人。

选项:

注意:

使用跟踪

OpenClaw 可以在 OAuth/API 凭证可用时显示提供者使用/配额。

显示位置:

注意:

health

从运行的 Gateway 获取健康状态。

选项:

sessions

列出存储的对话会话。

选项:

重置 / 卸载

reset

重置本地配置/状态(保留 CLI 安装)。

选项:

注意:

uninstall

卸载 Gateway 服务 + 本地数据(保留 CLI)。

选项:

注意:

Gateway

gateway

运行 WebSocket Gateway。

选项:

gateway service

管理 Gateway 服务(launchd/systemd/schtasks)。

子命令:

注意:

logs

通过 RPC 跟踪 Gateway 文件日志。

注意:

示例:

openclaw logs --follow
openclaw logs --limit 200
openclaw logs --plain
openclaw logs --json
openclaw logs --no-color

gateway <subcommand>

Gateway CLI 助手(RPC 子命令使用 --url, --token, --password, --timeout, --expect-final)。

子命令:

常用 RPC:

提示:直接调用 config.set/config.apply/config.patch 时,如果配置已存在,传递 baseHash 来自 config.get

模型

详见 [/concepts/models(../concepts/models.html) 了解回退行为和扫描策略。

首选 Anthropic 认证(setup-token):

claude setup-token
openclaw models auth setup-token --provider anthropic
openclaw models status

models (根命令)

openclaw modelsmodels status 的别名。

根选项:

models list

选项:

models status

选项:

始终包含认证概览和 auth 存储中配置文件的 OAuth 过期状态。
--probe 运行实时请求(可能消耗令牌并触发速率限制)。

models set <model>

设置 agents.defaults.model.primary

models set-image <model>

设置 agents.defaults.imageModel.primary

models aliases list|add|remove

选项:

models fallbacks list|add|remove|clear

选项:

models image-fallbacks list|add|remove|clear

选项:

models scan

选项:

models auth add|setup-token|paste-token

选项:

models auth order get|set|clear

选项:

系统

system event

入队系统事件并可选触发心跳(Gateway RPC)。

必需:

选项:

system heartbeat last|enable|disable

心跳控制(Gateway RPC)。

选项:

system presence

列出系统在线状态条目(Gateway RPC)。

选项:

Cron 定时任务

管理计划任务(Gateway RPC)。详见 [/automation/cron-jobs(../automation/cron-jobs.html)。

子命令:

所有 cron 命令接受 --url, --token, --timeout, --expect-final

节点主机

node 运行无头节点主机或将其作为后台服务管理。详见 [openclaw node(../cli/node.html)。

子命令:

节点

nodes 与 Gateway 通信并定位配对节点。详见 /nodes

常用选项:

子命令:

相机:

画布 + 屏幕:

位置:

浏览器

浏览器控制 CLI(专用 Chrome/Brave/Edge/Chromium)。详见 [openclaw browser(../cli/browser.html) 和 [Browser 工具(../tools/browser.html)。

常用选项:

管理:

检查:

操作:

文档搜索

docs [query...]

搜索实时文档索引。

TUI

tui

打开连接到 Gateway 的终端 UI。

选项: