CLI 参考

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

命令页面

全局参数

  • --dev:将状态隔离到 ~/.openclaw-dev,并移动默认端口。
  • --profile <name>:将状态隔离到 ~/.openclaw-<name>
  • --no-color:禁用 ANSI 颜色。
  • --update:等同于 openclaw 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(又名 “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)。

安全

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

密钥管理

  • openclaw secrets reload — 重新解析引用并原子性地替换运行时快照。
  • openclaw secrets audit — 扫描明文残留、未解析的引用和优先级漂移。
  • openclaw secrets configure — 交互式辅助工具,用于提供商设置 + SecretRef 映射 + 预检/应用。
  • openclaw secrets apply --from <plan.json> — 应用之前生成的计划(支持 --dry-run)。

插件

管理扩展及其配置:

  • openclaw plugins list — 发现插件(用 --json 获取机器可读输出)。
  • openclaw plugins info <id> — 显示插件详情。
  • openclaw plugins install <path|.tgz|npm-spec> — 安装插件(或将插件路径添加到 plugins.load.paths)。
  • openclaw plugins enable <id> / disable <id> — 切换 plugins.entries.<id>.enabled
  • openclaw plugins doctor — 报告插件加载错误。

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

记忆

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

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

聊天斜杠命令

聊天消息支持 /... 命令(文本和原生)。参见 /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、工作区和技能。

选项:

  • --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 存储为环境变量 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

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

config

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

子命令:

  • config get <path>:打印配置值(点号/方括号路径)。
  • config set <path> <value>:设置值(JSON5 或原始字符串)。
  • config unset <path>:移除值。
  • config file:打印当前活跃的配置文件路径。
  • 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/MS 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

更多细节:/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 list:列出技能(不带子命令时的默认行为)。
  • skills info <name>:显示某个技能的详情。
  • skills check:就绪 vs. 缺少依赖的汇总。

选项:

  • --eligible:只显示已就绪的技能。
  • --json:输出 JSON(无样式)。
  • -v--verbose:包含缺失依赖的详情。

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

pairing

跨频道批准私信配对请求。

子命令:

  • 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 设备配对条目和按角色划分的设备 token。

子命令:

  • 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 钩子设置 + 运行。参见 /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

广域发现 DNS 辅助工具(CoreDNS + Tailscale)。参见 /gateway/discovery

选项:

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

消息和 Agent

message

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

参见:/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 运行一次 Agent 轮次(或 --local 内嵌模式)。

必需参数:

  • --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

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

agents list

列出已配置的 Agent。

选项:

  • --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

运行 ACP 桥接器,将 IDE 连接到 Gateway。

参见 acp 获取完整选项和示例。

status

显示已关联会话的健康状况和最近的收件人。

选项:

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

注意事项:

  • 概览在可用时包含 Gateway + 节点主机的服务状态。

用量追踪

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

展示位置:

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

注意事项:

  • 数据直接来自提供商的用量端点(不是估算值)。
  • 提供商:Anthropic、GitHub Copilot、OpenAI Codex OAuth,以及启用了对应提供商插件时的 Gemini CLI/Antigravity。
  • 如果没有匹配的凭据,用量信息不会显示。
  • 详情:参见 Usage tracking

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
  • --claude-cli-logs
  • --ws-log <auto|full|compact>
  • --compact--ws-log compact 的别名)
  • --raw-stream
  • --raw-stream-path <path>

gateway service

管理 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--json 用于脚本。
  • gateway status 在能检测到旧版或额外的 Gateway 服务时也会显示(--deep 添加系统级扫描)。以配置文件名命名的 OpenClaw 服务被视为一等公民,不会被标记为”额外”。
  • gateway status 会打印 CLI 使用的配置路径与服务可能使用的配置(服务 env),以及解析的探测目标 URL。
  • 在 Linux systemd 安装中,status 的 token 漂移检查会读取单元中的 Environment=EnvironmentFile= 值(包括 %h、引号路径、多文件和可选的 - 文件)。
  • 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(每行一个日志事件)。

示例:

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

模型

参见 /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 的别名。

根选项:

  • --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

定时任务

管理调度任务(Gateway RPC)。参见 /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 认证(无 --token/--password 参数):OPENCLAW_GATEWAY_TOKEN / OPENCLAW_GATEWAY_PASSWORD,然后是 gateway.auth.*。本地模式下,节点主机故意忽略 gateway.remote.*;在 gateway.mode=remote 时,gateway.remote.* 按远程优先级规则参与。
  • 旧版 CLAWDBOT_GATEWAY_* 环境变量在节点主机认证解析中被故意忽略。

节点

nodes 与 Gateway 通信并操作已配对的节点。参见 /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 browserBrowser tool

通用选项:

  • --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 的终端 UI。

选项:

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