Skip to content

CLI 参考

本页描述 OpenClaw CLI 的当前行为。如有命令变更,请同步更新本文档。

命令页索引

全局标志

  • --dev:将状态隔离在 ~/.openclaw-dev 下并移动默认端口。
  • --profile <name>:将状态隔离在 ~/.openclaw-<name> 下。
  • --no-color:禁用 ANSI 颜色。
  • --updateopenclaw update 的简写(仅限源码安装)。
  • -V--version-v:打印版本并退出。

输出样式

  • ANSI 颜色和进度指示器只在 TTY 会话中渲染。
  • OSC-8 超链接在支持的终端中渲染为可点击链接;否则回退到纯文本 URL。
  • --json(以及支持的地方使用 --plain)禁用样式以获得干净输出。
  • --no-color 禁用 ANSI 样式;同时遵守 NO_COLOR=1
  • 长时间运行的命令显示进度指示器(支持时使用 OSC 9;4)。

颜色调色板

OpenClaw 使用龙虾调色板输出 CLI 内容。

  • accent(#FF5A2D):标题、标签、主要高亮。
  • accentBright(#FF7A3D):命令名称、强调。
  • accentDim(#D14A22):次要高亮文本。
  • info(#FF8A5B):信息性值。
  • success(#2FBF71):成功状态。
  • warn(#FFB020):警告、回退、注意。
  • error(#E23D2D):错误、失败。
  • muted(#8B7F77):弱化、元数据。

调色板真值来源:src/terminal/palette.ts("龙虾调色板")。

命令树

openclaw [--dev] [--profile <name>] <command>
  setup
  onboard
  configure
  config
    get
    set
    unset
    file
    validate
  completion
  doctor
  dashboard
  backup
    create
    verify
  security
    audit
  secrets
    reload
    audit
    configure
    apply
  reset
  uninstall
  update
  channels
    list
    status
    logs
    add
    remove
    login
    logout
  directory
  skills
    list
    info
    check
  plugins
    list
    inspect
    install
    uninstall
    update
    enable
    disable
    doctor
    marketplace list
  memory
    status
    index
    search
  message
    send
    broadcast
  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)。

安全

  • openclaw security audit — 检查配置和本地状态中的常见安全隐患。
  • openclaw security audit --deep — 尽力进行实时 Gateway 探测。
  • openclaw security audit --fix — 收紧安全默认值并修改状态/配置的文件权限。

Secrets

  • openclaw secrets reload — 重新解析引用并原子性地替换运行时快照。
  • openclaw secrets audit — 扫描明文残留、未解析的引用和优先级漂移(--allow-exec 在审计期间执行 exec 提供者)。
  • openclaw secrets configure — 提供者设置、SecretRef 映射和预检/应用的交互式向导(--allow-exec 在预检和包含 exec 的应用流程中执行 exec 提供者)。
  • openclaw secrets apply --from <plan.json> — 应用之前生成的计划(支持 --dry-run;使用 --allow-exec 允许在 dry-run 和包含 exec 的写入计划中使用 exec 提供者)。

插件

管理扩展及其配置:

  • openclaw plugins list — 发现插件(使用 --json 获取机器输出)。
  • openclaw plugins inspect <id> — 显示插件详情(info 是别名)。
  • openclaw plugins install <path|.tgz|npm-spec|plugin@marketplace> — 安装插件(或将插件路径添加到 plugins.load.paths)。
  • openclaw plugins marketplace list <marketplace> — 安装前列出市场条目。
  • openclaw plugins enable <id> / disable <id> — 切换 plugins.entries.<id>.enabled
  • openclaw plugins doctor — 报告插件加载错误。

大多数插件变更需要重启 gateway。参见 /openclaw/tools/plugin

Memory(记忆)

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

  • openclaw memory status — 显示索引统计。
  • openclaw memory index — 重新索引记忆文件。
  • openclaw memory search "<query>"(或 --query "<query>")— 对记忆进行语义搜索。

聊天斜杠命令

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

重点:

  • /status 用于快速诊断。
  • /config 用于持久化配置变更。
  • /debug 用于仅运行时的配置覆盖(内存中,不写磁盘;需要 commands.debug: true)。

设置 + 引导

setup

初始化配置和工作区。

选项:

  • --workspace <dir>:agent 工作区路径(默认 ~/.openclaw/workspace)。
  • --wizard:运行引导向导。
  • --non-interactive:无提示运行引导。
  • --mode <local|remote>:引导模式。
  • --remote-url <url>:远程 Gateway URL。
  • --remote-token <token>:远程 Gateway Token。

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

onboard

Gateway、工作区和 Skills 的交互式引导。

选项:

  • --workspace <dir>
  • --reset(引导前重置配置 + 凭据 + 会话)
  • --reset-scope <config|config+creds+sessions|full>(默认 config+creds+sessions;使用 full 同时移除工作区)
  • --non-interactive
  • --mode <local|remote>
  • --flow <quickstart|advanced|manual>(manual 是 advanced 的别名)
  • --auth-choice <setup-token|token|chutes|openai-codex|openai-api-key|openrouter-api-key|ollama|ai-gateway-api-key|moonshot-api-key|moonshot-api-key-cn|kimi-code-api-key|synthetic-api-key|venice-api-key|gemini-api-key|zai-api-key|mistral-api-key|apiKey|minimax-api|minimax-api-lightning|opencode-zen|opencode-go|custom-api-key|skip>
  • --token-provider <id>(非交互式;与 --auth-choice token 配合使用)
  • --token <token>(非交互式;与 --auth-choice token 配合使用)
  • --token-profile-id <id>(非交互式;默认:<provider>:manual
  • --token-expires-in <duration>(非交互式;例如 365d12h
  • --secret-input-mode <plaintext|ref>(默认 plaintext;使用 ref 存储提供者默认环境引用而非明文密钥)
  • --anthropic-api-key <key>
  • --openai-api-key <key>
  • --mistral-api-key <key>
  • --openrouter-api-key <key>
  • --ai-gateway-api-key <key>
  • --moonshot-api-key <key>
  • --kimi-code-api-key <key>
  • --gemini-api-key <key>
  • --zai-api-key <key>
  • --minimax-api-key <key>
  • --opencode-zen-api-key <key>
  • --opencode-go-api-key <key>
  • --custom-base-url <url>(非交互式;与 --auth-choice custom-api-key--auth-choice ollama 配合使用)
  • --custom-model-id <id>(非交互式;与 --auth-choice custom-api-key--auth-choice ollama 配合使用)
  • --custom-api-key <key>(非交互式;可选;与 --auth-choice custom-api-key 配合使用;省略时回退到 CUSTOM_API_KEY
  • --custom-provider-id <id>(非交互式;可选的自定义提供者 id)
  • --custom-compatibility <openai|anthropic>(非交互式;可选;默认 openai
  • --gateway-port <port>
  • --gateway-bind <loopback|lan|tailnet|auto|custom>
  • --gateway-auth <token|password>
  • --gateway-token <token>
  • --gateway-token-ref-env <name>(非交互式;将 gateway.auth.token 存储为 env SecretRef;需要设置该环境变量;不能与 --gateway-token 组合使用)
  • --gateway-password <password>
  • --remote-url <url>
  • --remote-token <token>
  • --tailscale <off|serve|funnel>
  • --tailscale-reset-on-exit
  • --install-daemon
  • --no-install-daemon(别名:--skip-daemon
  • --daemon-runtime <node|bun>
  • --skip-channels
  • --skip-skills
  • --skip-health
  • --skip-ui
  • --node-manager <npm|pnpm|bun>(推荐 pnpm;bun 不推荐用于 Gateway 运行时)
  • --json

configure

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

config

非交互式配置工具(get/set/unset/file/schema/validate)。不带子命令运行 openclaw config 会启动向导。

子命令:

  • config get <path>:打印配置值(点/括号路径)。
  • config set:支持四种赋值模式:
    • 值模式:config set <path> <value>(JSON5 或字符串解析)
    • SecretRef 构建模式:config set <path> --ref-provider <provider> --ref-source <source> --ref-id <id>
    • 提供者构建模式:config set secrets.providers.<alias> --provider-source <env|file|exec> ...
    • 批量模式:config set --batch-json '<json>'config set --batch-file <path>
  • config set --dry-run:验证赋值而不写入 openclaw.json(默认跳过 exec SecretRef 检查)。
  • config set --allow-exec --dry-run:启用 exec SecretRef dry-run 检查(可能执行提供者命令)。
  • config set --dry-run --json:输出机器可读的 dry-run 结果(检查 + 完整性信号、操作、已检查/跳过的引用、错误)。
  • config set --strict-json:要求对路径/值输入进行 JSON5 解析。--json 在 dry-run 输出模式之外保留为严格解析的遗留别名。
  • config unset <path>:删除一个值。
  • config file:打印活动配置文件路径。
  • config schema:打印 openclaw.json 的生成 JSON schema。
  • config validate:在不启动 gateway 的情况下根据 schema 验证当前配置。
  • config validate --json:输出机器可读的 JSON 结果。

doctor

健康检查 + 快速修复(配置 + gateway + 遗留服务)。

选项:

  • --no-workspace-suggestions:禁用工作区记忆提示。
  • --yes:不提示直接接受默认值(无头模式)。
  • --non-interactive:跳过提示;只应用安全迁移。
  • --deep:扫描系统服务以查找额外的 gateway 安装。

频道帮助工具

channels

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

子命令:

  • channels list:显示已配置的频道和认证配置文件。
  • channels status:检查 gateway 可达性和频道健康状态(--probe 运行额外检查;使用 openclaw healthopenclaw status --deep 进行 gateway 健康探测)。
  • 提示:当 channels status 能检测到常见配置错误时,会打印带有建议修复的警告(然后指向 openclaw doctor)。
  • channels logs:从 gateway 日志文件显示最近的频道日志。
  • channels add:不传标志时以向导方式设置;传标志则切换到非交互式模式。
    • 向仍使用单账户顶级配置的频道添加非默认账户时,OpenClaw 会在写入新账户之前将账户范围的值移到 channels.<channel>.accounts.default 中。
    • 非交互式 channels add 不自动创建/升级绑定;仅频道绑定继续匹配默认账户。
  • channels remove:默认禁用;传 --delete 无提示地删除配置条目。
  • channels login:交互式频道登录(仅限 WhatsApp Web)。
  • channels logout:从频道会话注销(如果支持)。

通用选项:

  • --channel <name>whatsapp|telegram|discord|googlechat|slack|mattermost|signal|imessage|msteams
  • --account <id>:频道账户 id(默认 default
  • --name <label>:账户的显示名称

channels login 选项:

  • --channel <channel>(默认 whatsapp;支持 whatsapp/web
  • --account <id>
  • --verbose

channels logout 选项:

  • --channel <channel>(默认 whatsapp
  • --account <id>

channels list 选项:

  • --no-usage:跳过模型提供者使用量/配额快照(仅限 OAuth/API 支持的)。
  • --json:输出 JSON(包含使用量,除非设置了 --no-usage)。

channels logs 选项:

  • --channel <name|all>(默认 all
  • --lines <n>(默认 200
  • --json

更多详情:/openclaw/concepts/oauth

示例:

bash
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 及其就绪状态。

子命令:

  • skills search [query...]:搜索 ClawHub Skills。
  • skills install <slug>:从 ClawHub 将 Skill 安装到活动工作区。
  • skills update <slug|--all>:更新跟踪的 ClawHub Skills。
  • skills list:列出 Skills(无子命令时的默认行为)。
  • skills info <name>:显示单个 Skill 的详情。
  • skills check:就绪 vs 缺少要求的摘要。

选项:

  • --eligible:只显示就绪的 Skills。
  • --json:输出 JSON(无样式)。
  • -v--verbose:包含缺少要求的详情。

提示:使用 openclaw skills searchopenclaw skills installopenclaw skills update 管理 ClawHub 支持的 Skills。

pairing

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

子命令:

  • pairing list [channel] [--channel <channel>] [--account <id>] [--json]
  • pairing approve <channel> <code> [--account <id>] [--notify]
  • pairing approve --channel <channel> [--account <id>] <code> [--notify]

devices

管理 gateway 设备配对条目和每个角色的设备令牌。

子命令:

  • devices list [--json]
  • devices approve [requestId] [--latest]
  • devices reject <requestId>
  • devices remove <deviceId>
  • devices clear --yes [--pending]
  • devices rotate --device <id> --role <role> [--scope <scope...>]
  • devices revoke --device <id> --role <role>

webhooks gmail

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

子命令:

  • webhooks gmail setup(需要 --account <email>;支持 --project--topic--subscription--label--hook-url--hook-token--push-token--bind--port--path--include-body--max-bytes--renew-minutes--tailscale--tailscale-path--tailscale-target--push-endpoint--json
  • webhooks gmail run(相同标志的运行时覆盖)

dns setup

Wide-area 发现 DNS 帮助工具(CoreDNS + Tailscale)。参见 /openclaw/gateway/discovery

选项:

  • --apply:安装/更新 CoreDNS 配置(需要 sudo;仅限 macOS)。

消息 + Agent

message

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

参见:/openclaw/cli/message

子命令:

  • message send|poll|react|reactions|read|edit|delete|pin|unpin|pins|permissions|search|timeout|kick|ban
  • message thread <create|list|reply>
  • message emoji <list|upload>
  • message sticker <send|upload>
  • message role <info|add|remove>
  • message channel <info|list>
  • message member info
  • message voice status
  • message event <list|create>

示例:

  • 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(或 --local 嵌入式)运行单次 agent 轮次。

必填:

  • --message <text>

选项:

  • --to <dest>(用于会话键和可选的投递)
  • --session-id <id>
  • --thinking <off|minimal|low|medium|high|xhigh>(仅限 GPT-5.2 + Codex 模型)
  • --verbose <on|full|off>
  • --channel <whatsapp|telegram|discord|slack|mattermost|signal|imessage|msteams>
  • --local
  • --deliver
  • --json
  • --timeout <seconds>

agents

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

agents list

列出已配置的 agents。

选项:

  • --json
  • --bindings

agents add [name]

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

选项:

  • --workspace <dir>
  • --model <id>
  • --agent-dir <dir>
  • --bind <channel[:accountId]>(可重复)
  • --non-interactive
  • --json

绑定规范使用 channel[:accountId]。省略 accountId 时,OpenClaw 可能通过频道默认值/插件钩子解析账户范围;否则这是一个没有显式账户范围的频道绑定。

agents bindings

列出路由绑定。

选项:

  • --agent <id>
  • --json

agents bind

为 agent 添加路由绑定。

选项:

  • --agent <id>
  • --bind <channel[:accountId]>(可重复)
  • --json

agents unbind

删除 agent 的路由绑定。

选项:

  • --agent <id>
  • --bind <channel[:accountId]>(可重复)
  • --all
  • --json

agents delete <id>

删除 agent 并清理其工作区和状态。

选项:

  • --force
  • --json

acp

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

完整选项和示例参见 acp

status

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

选项:

  • --json
  • --all(完整诊断;只读,可粘贴)
  • --deep(探测频道)
  • --usage(显示模型提供者使用量/配额)
  • --timeout <ms>
  • --verbose
  • --debug--verbose 的别名)

注意:

  • 概览包含 Gateway + 节点主机服务状态(如果可用)。

使用量追踪

当 OAuth/API 凭据可用时,OpenClaw 可以显示提供者使用量/配额。

显示位置:

  • /status(在可用时添加简短的提供者使用量行)
  • openclaw status --usage(打印完整的提供者明细)
  • macOS 菜单栏(上下文下的使用量部分)

注意:

  • 数据直接来自提供者使用量端点(非估算)。
  • 提供者:Anthropic、GitHub Copilot、OpenAI Codex OAuth,以及通过内置 google 插件的 Gemini CLI 和已配置的 Antigravity。
  • 如果不存在匹配的凭据,使用量会被隐藏。
  • 详情:参见使用量追踪

health

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

选项:

  • --json
  • --timeout <ms>
  • --verbose

sessions

列出存储的对话会话。

选项:

  • --json
  • --verbose
  • --store <path>
  • --active <minutes>

重置 / 卸载

reset

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

选项:

  • --scope <config|config+creds+sessions|full>
  • --yes
  • --non-interactive
  • --dry-run

注意:

  • --non-interactive 需要 --scope--yes

uninstall

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

选项:

  • --service
  • --state
  • --workspace
  • --app
  • --all
  • --yes
  • --non-interactive
  • --dry-run

注意:

  • --non-interactive 需要 --yes 和显式范围(或 --all)。

Gateway

gateway

运行 WebSocket Gateway(养龙虾第一步)。

选项:

  • --port <port>
  • --bind <loopback|tailnet|lan|auto|custom>
  • --token <token>
  • --auth <token|password>
  • --password <password>
  • --password-file <path>
  • --tailscale <off|serve|funnel>
  • --tailscale-reset-on-exit
  • --allow-unconfigured
  • --dev
  • --reset(重置开发配置 + 凭据 + 会话 + 工作区)
  • --force(杀死端口上的现有监听者)
  • --verbose
  • --cli-backend-logs
  • --claude-cli-logs(废弃别名)
  • --ws-log <auto|full|compact>
  • --compact--ws-log compact 的别名)
  • --raw-stream
  • --raw-stream-path <path>

gateway 服务

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

子命令:

  • gateway status(默认探测 Gateway RPC)
  • gateway install(服务安装)
  • gateway uninstall
  • gateway start
  • gateway stop
  • gateway restart

注意:

  • gateway status 默认使用服务解析的端口/配置探测 Gateway RPC(用 --url/--token/--password 覆盖)。
  • gateway status 支持 --no-probe--deep--require-rpc--json 用于脚本化。
  • gateway status 在能检测到时也会显示遗留或额外的 gateway 服务(--deep 添加系统级扫描)。Profile 命名的 OpenClaw 服务被视为一等公民,不会被标记为"额外"。
  • gateway status 打印 CLI 使用的配置路径 vs 服务可能使用的配置(服务 env),以及解析的探测目标 URL。
  • 如果 gateway auth SecretRef 在当前命令路径中未解析,gateway status --json 仅在探测连接/认证失败时报告 rpc.authWarning(探测成功时警告会被抑制)。
  • 在 Linux systemd 安装中,状态 token 漂移检查同时包含 Environment=EnvironmentFile= unit 来源。
  • gateway install|uninstall|start|stop|restart 支持 --json 用于脚本化(默认输出保持人类友好)。
  • gateway install 默认使用 Node 运行时;bun 不推荐(WhatsApp/Telegram 存在 bug)。
  • gateway install 选项:--port--runtime--token--force--json

logs

通过 RPC 追踪 Gateway 文件日志。

注意:

  • TTY 会话渲染彩色结构化视图;非 TTY 回退到纯文本。
  • --json 输出行分隔的 JSON(每行一个日志事件)。

示例:

bash
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,缺少显式凭据会报错。

子命令:

  • gateway call <method> [--params <json>]
  • gateway health
  • gateway status
  • gateway probe
  • gateway discover
  • gateway install|uninstall|start|stop|restart
  • gateway run

常用 RPC:

  • config.apply(验证 + 写入配置 + 重启 + 唤醒)
  • config.patch(合并部分更新 + 重启 + 唤醒)
  • update.run(运行更新 + 重启 + 唤醒)

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

模型

参见 /openclaw/concepts/models 了解回退行为和扫描策略。

Anthropic setup-token(支持):

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

政策说明:这是技术兼容性功能。Anthropic 过去曾在 Claude Code 之外阻止某些订阅使用;在生产中依赖 setup-token 之前,请验证当前 Anthropic 条款。

Anthropic Claude CLI 迁移:

bash
openclaw models auth login --provider anthropic --method cli --set-default
openclaw onboard --auth-choice anthropic-cli

models(根)

openclaw modelsmodels status 的别名。

根选项:

  • --status-jsonmodels status --json 的别名)
  • --status-plainmodels status --plain 的别名)

models list

选项:

  • --all
  • --local
  • --provider <name>
  • --json
  • --plain

models status

选项:

  • --json
  • --plain
  • --check(退出 1=过期/缺失,2=即将过期)
  • --probe(对已配置的认证配置文件进行实时探测)
  • --probe-provider <name>
  • --probe-profile <id>(重复或逗号分隔)
  • --probe-timeout <ms>
  • --probe-concurrency <n>
  • --probe-max-tokens <n>

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

models set <model>

设置 agents.defaults.model.primary

models set-image <model>

设置 agents.defaults.imageModel.primary

models aliases list|add|remove

选项:

  • list--json--plain
  • add <alias> <model>
  • remove <alias>

models fallbacks list|add|remove|clear

选项:

  • list--json--plain
  • add <model>
  • remove <model>
  • clear

models image-fallbacks list|add|remove|clear

选项:

  • list--json--plain
  • add <model>
  • remove <model>
  • clear

models scan

选项:

  • --min-params <b>
  • --max-age-days <days>
  • --provider <name>
  • --max-candidates <n>
  • --timeout <ms>
  • --concurrency <n>
  • --no-probe
  • --yes
  • --no-input
  • --set-default
  • --set-image
  • --json

models auth add|setup-token|paste-token

选项:

  • add:交互式认证帮助工具
  • setup-token--provider <name>(默认 anthropic)、--yes
  • paste-token--provider <name>--profile-id <id>--expires-in <duration>

models auth order get|set|clear

选项:

  • get--provider <name>--agent <id>--json
  • set--provider <name>--agent <id><profileIds...>
  • clear--provider <name>--agent <id>

系统

system event

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

必填:

  • --text <text>

选项:

  • --mode <now|next-heartbeat>
  • --json
  • --url--token--timeout--expect-final

system heartbeat last|enable|disable

心跳控制(Gateway RPC)。

选项:

  • --json
  • --url--token--timeout--expect-final

system presence

列出系统在场条目(Gateway RPC)。

选项:

  • --json
  • --url--token--timeout--expect-final

Cron

管理定时任务(Gateway RPC)。参见 /openclaw/automation/cron-jobs

子命令:

  • cron status [--json]
  • cron list [--all] [--json](默认表格输出;使用 --json 获取原始数据)
  • cron add(别名:create;需要 --name--at | --every | --cron 之一,以及 --system-event | --message 之一作为有效载荷)
  • cron edit <id>(修改字段)
  • cron rm <id>(别名:removedelete
  • cron enable <id>
  • cron disable <id>
  • cron runs --id <id> [--limit <n>]
  • cron run <id> [--force]

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

节点主机

node 运行一个无头节点主机或将其作为后台服务管理。参见 openclaw node

子命令:

  • node run --host <gateway-host> --port 18789
  • node status
  • node install [--host <gateway-host>] [--port <port>] [--tls] [--tls-fingerprint <sha256>] [--node-id <id>] [--display-name <name>] [--runtime <node|bun>] [--force]
  • node uninstall
  • node stop
  • node restart

认证说明:

  • node 从 env/配置解析 gateway 认证(node 命令没有 --token/--password 标志):先检查 OPENCLAW_GATEWAY_TOKEN / OPENCLAW_GATEWAY_PASSWORD,再检查 gateway.auth.*。在本地模式下,节点主机有意忽略 gateway.remote.*;在 gateway.mode=remote 下,gateway.remote.* 按远程优先规则参与。
  • 节点主机认证解析只遵守 OPENCLAW_GATEWAY_* 环境变量。

节点(Nodes)

nodes 与 Gateway 通信并针对配对的节点。参见 /openclaw/nodes

通用选项:

  • --url--token--timeout--json

子命令:

  • nodes status [--connected] [--last-connected <duration>]
  • nodes describe --node <id|name|ip>
  • nodes list [--connected] [--last-connected <duration>]
  • nodes pending
  • nodes approve <requestId>
  • nodes reject <requestId>
  • nodes rename --node <id|name|ip> --name <displayName>
  • nodes invoke --node <id|name|ip> --command <command> [--params <json>] [--invoke-timeout <ms>] [--idempotency-key <key>]
  • nodes run --node <id|name|ip> [--cwd <path>] [--env KEY=VAL] [--command-timeout <ms>] [--needs-screen-recording] [--invoke-timeout <ms>] <command...>(mac 节点或无头节点主机)
  • nodes notify --node <id|name|ip> [--title <text>] [--body <text>] [--sound <name>] [--priority <passive|active|timeSensitive>] [--delivery <system|overlay|auto>] [--invoke-timeout <ms>](仅限 mac)

摄像头:

  • nodes camera list --node <id|name|ip>
  • nodes camera snap --node <id|name|ip> [--facing front|back|both] [--device-id <id>] [--max-width <px>] [--quality <0-1>] [--delay-ms <ms>] [--invoke-timeout <ms>]
  • nodes camera clip --node <id|name|ip> [--facing front|back] [--device-id <id>] [--duration <ms|10s|1m>] [--no-audio] [--invoke-timeout <ms>]

画布 + 屏幕:

  • nodes canvas snapshot --node <id|name|ip> [--format png|jpg|jpeg] [--max-width <px>] [--quality <0-1>] [--invoke-timeout <ms>]
  • nodes canvas present --node <id|name|ip> [--target <urlOrPath>] [--x <px>] [--y <px>] [--width <px>] [--height <px>] [--invoke-timeout <ms>]
  • nodes canvas hide --node <id|name|ip> [--invoke-timeout <ms>]
  • nodes canvas navigate <url> --node <id|name|ip> [--invoke-timeout <ms>]
  • nodes canvas eval [<js>] --node <id|name|ip> [--js <code>] [--invoke-timeout <ms>]
  • nodes canvas a2ui push --node <id|name|ip> (--jsonl <path> | --text <text>) [--invoke-timeout <ms>]
  • nodes canvas a2ui reset --node <id|name|ip> [--invoke-timeout <ms>]
  • nodes screen record --node <id|name|ip> [--screen <index>] [--duration <ms|10s>] [--fps <n>] [--no-audio] [--out <path>] [--invoke-timeout <ms>]

位置:

  • nodes location get --node <id|name|ip> [--max-age <ms>] [--accuracy <coarse|balanced|precise>] [--location-timeout <ms>] [--invoke-timeout <ms>]

浏览器

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

通用选项:

  • --url--token--timeout--json
  • --browser-profile <name>

管理:

  • browser status
  • browser start
  • browser stop
  • browser reset-profile
  • browser tabs
  • browser open <url>
  • browser focus <targetId>
  • browser close [targetId]
  • browser profiles
  • browser create-profile --name <name> [--color <hex>] [--cdp-url <url>]
  • browser delete-profile --name <name>

检查:

  • browser screenshot [targetId] [--full-page] [--ref <ref>] [--element <selector>] [--type png|jpeg]
  • browser snapshot [--format aria|ai] [--target-id <id>] [--limit <n>] [--interactive] [--compact] [--depth <n>] [--selector <sel>] [--out <path>]

操作:

  • browser navigate <url> [--target-id <id>]
  • browser resize <width> <height> [--target-id <id>]
  • browser click <ref> [--double] [--button <left|right|middle>] [--modifiers <csv>] [--target-id <id>]
  • browser type <ref> <text> [--submit] [--slowly] [--target-id <id>]
  • browser press <key> [--target-id <id>]
  • browser hover <ref> [--target-id <id>]
  • browser drag <startRef> <endRef> [--target-id <id>]
  • browser select <ref> <values...> [--target-id <id>]
  • browser upload <paths...> [--ref <ref>] [--input-ref <ref>] [--element <selector>] [--target-id <id>] [--timeout-ms <ms>]
  • browser fill [--fields <json>] [--fields-file <path>] [--target-id <id>]
  • browser dialog --accept|--dismiss [--prompt <text>] [--target-id <id>] [--timeout-ms <ms>]
  • browser wait [--time <ms>] [--text <value>] [--text-gone <value>] [--target-id <id>]
  • browser evaluate --fn <code> [--ref <ref>] [--target-id <id>]
  • browser console [--level <error|warn|info>] [--target-id <id>]
  • browser pdf [--target-id <id>]

文档搜索

docs [query...]

搜索实时文档索引。

TUI

tui

打开连接到 Gateway 的终端用户界面。

选项:

  • --url <url>
  • --token <token>
  • --password <password>
  • --session <key>
  • --deliver
  • --thinking <level>
  • --message <text>
  • --timeout-ms <ms>(默认为 agents.defaults.timeoutSeconds
  • --history-limit <n>