CLI 參考

本頁描述目前的 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(別名「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 — 收緊安全預設值並 chmod 狀態/設定。

密碼管理

  • 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、工作區和 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 儲存供應商預設 env 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/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 及就緒資訊。

子指令:

  • skills list:列出 skills(無子指令時的預設)。
  • skills info <name>:顯示特定 skill 的詳細資訊。
  • skills check:就緒與缺少需求條件的摘要。

選項:

  • --eligible:只顯示就緒的 skills。
  • --json:輸出 JSON(無樣式)。
  • -v--verbose:包含缺少的需求條件細節。

提示:使用 npx clawhub 搜尋、安裝和同步 skills。

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 hook 設定與執行器。參閱 /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(或 --local 內嵌)執行一次 agent 回合。

必要:

  • --message <text>

選項:

  • --to <dest>(用於 session key 和選用的傳遞)
  • --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 可能透過頻道預設值/外掛程式 hooks 解析帳號範圍;否則為不含明確帳號範圍的頻道綁定。

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 + 節點主機服務狀態。

使用量追蹤

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 加入系統層級掃描)。Profile 命名的 OpenClaw 服務被視為正式服務,不會被標記為「額外」。
  • gateway status 會列印 CLI 使用的設定路徑與服務可能使用的設定(服務 env),以及已解析的探測目標 URL。
  • 在 Linux systemd 安裝中,服務驗證飄移檢查會讀取 unit 中的 Environment=EnvironmentFile= 值(包含 %h、引號路徑、多個檔案和選用的 - 檔案)。
  • gateway install|uninstall|start|stop|restart 支援 --json 以便腳本使用(預設輸出維持人類友善)。
  • gateway install 預設使用 Node 執行環境;不建議使用 bun(WhatsApp/Telegram 會有問題)。
  • 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.getbaseHash

模型

參閱 /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>

一律包含驗證概觀和 auth store 中設定檔的 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

排入系統事件並選擇性觸發 heartbeat(Gateway RPC)。

必要:

  • --text <text>

選項:

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

system heartbeat last|enable|disable

Heartbeat 控制(Gateway RPC)。

選項:

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

system presence

列出系統 presence 項目(Gateway RPC)。

選項:

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

Cron

管理排程任務(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/config 解析 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 node 或無頭節點主機)
  • 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>]

Canvas 與螢幕:

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