CLI 参考

本页描述当前的 CLI 行为。如果命令发生变化,请更新此文档。

命令页面

全局标志

输出样式

调色板

OpenClaw 在 CLI 输出中使用龙虾色调调色板。

调色板唯一来源:src/terminal/palette.ts(也称为 “lobster seam”)。

命令树

openclaw [--dev] [--profile <name>] <command>
  setup
  onboard
  configure
  config
    get
    set
    unset
  completion
  doctor
  dashboard
  backup
    create
    verify
  security
    audit
  secrets
    reload
    migrate
  reset
  uninstall
  update
  channels
    list
    status
    logs
    add
    remove
    login
    logout
  directory
  skills
    list
    info
    check
  plugins
    list
    info
    install
    enable
    disable
    doctor
  memory
    status
    index
    search
  message
  agent
  agents
    list
    add
    delete
  acp
  status
  health
  sessions
  gateway
    call
    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
    auth add|setup-token|paste-token
    auth order get|set|clear
  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 add|remove
  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
  pairing
    list
    approve
  qr
  clawbot
    qr
  docs
  dns
    setup
  tui

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

安全

密钥

插件

管理扩展及其配置:

大多数插件更改都需要重启 gateway。参见 /plugin

内存

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

聊天斜杠命令

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

重点:

设置 + 新手引导

setup

初始化配置 + 工作区。

选项:

只要存在任意新手引导标志(--non-interactive, --mode, --remote-url, --remote-token),就会自动运行新手引导。

onboard

用于设置 gateway、工作区和 Skills 的交互式新手引导。

选项:

configure

交互式配置向导(模型、渠道、Skills、gateway)。

config

非交互式配置助手(get/set/unset/file/validate)。直接运行 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

示例:

openclaw channels add --channel telegram --account alerts --name "Alerts Bot" --token $TELEGRAM_BOT_TOKEN
openclaw channels add --channel discord --account work --name "Work Bot" --token $DISCORD_BOT_TOKEN
openclaw channels remove --channel discord --account work --delete
openclaw channels status --probe
openclaw status --deep

skills

列出并检查可用 Skills,以及就绪信息。

子命令:

选项:

提示:使用 npx clawhub 搜索、安装和同步 Skills。

pairing

批准跨渠道的私信配对请求。

子命令:

devices

管理 gateway 设备配对条目和按角色划分的设备 token。

子命令:

webhooks gmail

Gmail Pub/Sub hook 设置 + 运行器。参见 /automation/gmail-pubsub

子命令:

dns setup

广域设备发现 DNS 助手(CoreDNS + Tailscale)。参见 /gateway/discovery

选项:

消息 + 智能体

message

统一的出站消息发送 + 渠道操作。

参见:/cli/message

子命令:

示例:

agent

通过 Gateway 网关(或 --local 嵌入模式)运行一次智能体轮次。

必需项:

选项:

agents

管理隔离的智能体(工作区 + 认证 + 路由)。

agents list

列出已配置的智能体。

选项:

agents add [name]

添加一个新的隔离智能体。除非传入标志(或 --non-interactive),否则会运行引导式向导;在非交互模式下必须提供 --workspace

选项:

绑定规范使用 channel[:accountId]。省略 accountId 时,OpenClaw 可能通过渠道默认值 / 插件 hook 解析账户作用域;否则这就是不带显式账户作用域的渠道绑定。

agents bindings

列出路由绑定。

选项:

agents bind

为智能体添加路由绑定。

选项:

agents unbind

移除智能体的路由绑定。

选项:

agents delete <id>

删除一个智能体并清理其工作区 + 状态。

选项:

acp

运行将 IDE 连接到 Gateway 网关的 ACP 桥接器。

完整选项和示例请参见 acp

status

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

选项:

说明:

用量跟踪

在 OAuth / API 凭据可用时,OpenClaw 可以显示提供商用量 / 配额。

展示位置:

说明:

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)。 当你传入 --url 时,CLI 不会自动应用配置或环境凭据。 请显式包含 --token--password。缺少显式凭据会报错。

子命令:

常见 RPC:

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

模型

关于回退行为和扫描策略,请参见 /concepts/models

Anthropic setup-token(已支持):

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

策略说明:这是技术兼容性。Anthropic 过去曾阻止某些 Claude Code 之外的订阅使用;在生产环境依赖 setup-token 之前,请确认当前的 Anthropic 条款。

models(根命令)

openclaw modelsmodels status 的别名。

根选项:

models list

选项:

models status

选项:

始终包含认证总览以及认证存储中配置文件的 OAuth 过期状态。 --probe 会发起实时请求(可能消耗 token 并触发速率限制)。

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

将一个系统事件加入队列,并可选择触发一次 heartbeat(Gateway 网关 RPC)。

必需项:

选项:

system heartbeat last|enable|disable

heartbeat 控制(Gateway 网关 RPC)。

选项:

system presence

列出系统 presence 条目(Gateway 网关 RPC)。

选项:

Cron

管理计划任务(Gateway 网关 RPC)。参见 /automation/cron-jobs

子命令:

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

Node 主机

node 运行一个无头 node host,或将其作为后台服务进行管理。参见 openclaw node

子命令:

认证说明:

Nodes

nodes 与 Gateway 网关通信,并以已配对节点为目标。参见 /nodes

通用选项:

子命令:

相机:

Canvas + 屏幕:

位置:

浏览器

浏览器控制 CLI(专用 Chrome/Brave/Edge/Chromium)。参见 openclaw browserBrowser 工具

通用选项:

管理:

检查:

操作:

文档搜索

docs [query...]

搜索实时文档索引。

TUI

tui

打开连接到 Gateway 网关的终端 UI。

选项: