OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

CLI commands

設定

openclaw.json 的非互動式輔助工具：依路徑取得／設定／修補／取消設定值、列印結構描述、驗證，或列印使用中的檔案路徑。不加子命令執行 openclaw config，即可開啟與 openclaw configure 相同的引導式精靈。

根層級選項

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tc2VjdGlvbiA8c2VjdGlvbg " type="string"> 不加子命令執行 openclaw config 時，可重複指定的引導式設定區段篩選器。

引導式區段：workspace、model、web、gateway、daemon、channels、plugins、skills、health。

範例

bash
openclaw config fileopenclaw config --section modelopenclaw config --section gateway --section daemonopenclaw config schemaopenclaw config get browser.executablePathopenclaw config set browser.executablePath "/usr/bin/google-chrome"openclaw config set browser.profiles.work.executablePath "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"openclaw config set agents.defaults.heartbeat.every "2h"openclaw config set 'agents.entries.main.tools.exec.node' "node-id-or-name"openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeopenclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKENopenclaw config set secrets.providers.vaultfile --provider-source file --provider-path /etc/openclaw/secrets.json --provider-mode jsonopenclaw config patch --file ./openclaw.patch.json5 --dry-runopenclaw config unset plugins.entries.brave.config.webSearch.apiKeyopenclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN --dry-runopenclaw config validateopenclaw config validate --json

路徑

點號或方括號標記法。在 shell 範例中請為方括號路徑加上引號，以免 zsh 對 [0] 進行萬用字元展開：

bash
openclaw config get agents.defaults.workspaceopenclaw config get agents.entries.mainopenclaw config get agents.entriesopenclaw config set 'agents.entries.work.tools.exec.node' "node-id-or-name"

config get

從已遮蔽的設定快照讀取值（絕不列印祕密）。--json 會將原始值列印為 JSON；否則，字串／數字／布林值會直接列印，物件／陣列則列印為格式化的 JSON。

找不到路徑時，--json 會將 { "error": "Config path not found: <path>" } 寫入標準輸出，並以狀態 1 結束。若沒有 --json，診斷訊息仍會輸出至標準錯誤。

bash
openclaw config get browser.executablePathopenclaw config get agents.defaults.model --json

config file

列印使用中的設定檔路徑，此路徑由 OPENCLAW_CONFIG_PATH 或預設位置解析而得。該路徑指向一般檔案，而非符號連結；請參閱寫入安全性。

config schema

將為 openclaw.json 產生的 JSON 結構描述列印至標準輸出。

包含的內容
  • 目前的根層級設定結構描述，另加一個供編輯器工具使用的根層級 $schema 字串欄位。
  • Control UI 使用的欄位 title／description 文件中繼資料。
  • 若存在相符的欄位文件，巢狀物件、萬用字元（*）及陣列項目（[]）節點會繼承相同的 title／description 中繼資料。
  • anyOf／oneOf／allOf 分支也會繼承相同的文件中繼資料。
  • 可載入執行階段資訊清單時，盡可能提供即時的外掛與頻道結構描述中繼資料。
  • 即使目前設定無效，仍提供乾淨的備援結構描述。
相關的執行階段 RPC

config.schema.lookup 會傳回一個正規化設定路徑，其中包含淺層結構描述節點（title、description、type、enum、const、常用界限）、相符的 UI 提示中繼資料，以及直接子項摘要。可用於 Control UI 或自訂用戶端中的路徑範圍下鑽。

bash
openclaw config schemaopenclaw config schema > openclaw.schema.json

config validate

在不啟動閘道的情況下，依據使用中的結構描述驗證目前設定。

bash
openclaw config validateopenclaw config validate --json

值

值會盡可能解析為 JSON5；否則視為原始字串。使用 --strict-json 可要求使用標準 JSON，且不允許退回字串（此時會拒絕註解、結尾逗號或未加引號的鍵等僅限 JSON5 的語法）。--json 是 config set 上 --strict-json 的舊版別名。

bash
openclaw config set agents.defaults.heartbeat.every "0m"openclaw config set gateway.port 19001 --strict-jsonopenclaw config set channels.whatsapp.groups '["*"]' --strict-json

config get <path> --json 會將原始值列印為 JSON，而非終端機格式化文字。

當寫入變更 agents.defaults.model 或個別代理程式的 agents.entries.*.model 時，OpenClaw 會先透過已設定的提供者目錄解析每個已變更的主要或備援項目，再進行寫入。未知的模型參照會遭拒絕，且不會變更使用中的設定；請執行 openclaw models list 查看可用模型。

將項目新增至這些對應表時，請使用 --merge：

bash
openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeopenclaw config set models.providers.ollama.models '[{"id":"llama3.2","name":"Llama 3.2"}]' --strict-json --merge

只有在提供的值應刻意成為完整目標值時，才使用 --replace。

config set 模式

值模式

bash
openclaw config set <path> <value>

SecretRef 建構器模式

bash
openclaw config set channels.discord.token \  --ref-provider default \  --ref-source env \  --ref-id DISCORD_BOT_TOKEN

提供者建構器模式

僅以 secrets.providers.<alias> 路徑為目標：

bash
openclaw config set secrets.providers.vault \  --provider-source exec \  --provider-command /usr/local/bin/openclaw-vault \  --provider-arg read \  --provider-arg openai/api-key \  --provider-timeout-ms 5000

批次模式

bash
openclaw config set --batch-json '[  {    "path": "secrets.providers.default",    "provider": { "source": "env" }  },  {    "path": "channels.discord.token",    "ref": { "source": "env", "provider": "default", "id": "DISCORD_BOT_TOKEN" }  }]'
bash
openclaw config set --batch-file ./config-set.batch.json --dry-run

批次檔案上限為 8 MiB。

批次剖析一律以批次承載資料（--batch-json／--batch-file）為唯一依據；--strict-json／--json 不會變更批次剖析行為。

JSON 路徑／值模式也可直接用於 SecretRef 和提供者：

bash
openclaw config set channels.discord.token \  '{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}' \  --strict-json openclaw config set secrets.providers.vaultfile \  '{"source":"file","path":"/etc/openclaw/secrets.json","mode":"json"}' \  --strict-json

提供者建構器旗標

提供者建構器目標必須使用 secrets.providers.<alias> 作為路徑。

共用旗標
  • --provider-source <env|file|exec>
  • --provider-timeout-ms <ms>（file、exec）
環境變數提供者（--provider-source env）
  • --provider-allowlist &lt;ENV_VAR&gt;（可重複）
檔案提供者（--provider-source file）
  • --provider-path <path>（必填）
  • --provider-mode <singleValue|json>
  • --provider-max-bytes <bytes>
  • --provider-allow-insecure-path
可執行檔提供者（--provider-source exec）
  • --provider-command <path>（必填）
  • --provider-arg <arg>（可重複）
  • --provider-no-output-timeout-ms <ms>
  • --provider-max-output-bytes <bytes>
  • --provider-json-only
  • --provider-env &lt;KEY=VALUE&gt;（可重複）
  • --provider-pass-env &lt;ENV_VAR&gt;（可重複）
  • --provider-trusted-dir <path>（可重複）
  • --provider-allow-insecure-path
  • --provider-allow-symlink-command

強化的可執行檔提供者範例：

bash
openclaw config set secrets.providers.vault \  --provider-source exec \  --provider-command /usr/local/bin/openclaw-vault \  --provider-arg read \  --provider-arg openai/api-key \  --provider-json-only \  --provider-pass-env VAULT_TOKEN \  --provider-trusted-dir /usr/local/bin \  --provider-timeout-ms 5000

config patch

貼上或以管線傳入設定形狀的 JSON5 修補，而不必執行多個依路徑操作的 config set 命令。物件會遞迴合併；陣列和純量值會取代目標；null 會刪除目標路徑。

bash
openclaw config patch --file ./openclaw.patch.json5 --dry-runopenclaw config patch --file ./openclaw.patch.json5

修補檔案上限為 8 MiB。透過管線輸入的 --stdin 修補上限為 1 MiB。

對於遠端設定指令碼，可透過標準輸入以管線傳入修補：

bash
ssh user@gateway-host 'openclaw config patch --stdin --dry-run' < ./openclaw.patch.json5ssh user@gateway-host 'openclaw config patch --stdin' < ./openclaw.patch.json5

修補範例：

json5
{  channels: {    slack: {      enabled: true,      mode: "socket",      botToken: { source: "env", provider: "default", id: "SLACK_BOT_TOKEN" },      appToken: { source: "env", provider: "default", id: "SLACK_APP_TOKEN" },      groupPolicy: "open",      requireMention: false,    },    discord: {      enabled: true,      token: { source: "env", provider: "default", id: "DISCORD_BOT_TOKEN" },      dmPolicy: "disabled",      dm: { enabled: false },      groupPolicy: "allowlist",    },  },  agents: {    defaults: {      model: { primary: "openai/gpt-5.6-sol" },      models: {        "openai/gpt-5.6-sol": { params: { fastMode: true } },      },    },  },}

當某個物件或陣列必須完全成為所提供的值，而非進行遞迴修補時，請使用 --replace-path <path>：

bash
openclaw config patch --file ./discord.patch.json5 --replace-path 'channels.discord.guilds["123"].channels'

--dry-run 會執行結構描述與 SecretRef 可解析性檢查，但不會寫入。試執行期間預設會略過由 exec 支援的 SecretRef；若你有意讓試執行執行提供者命令，請加入 --allow-exec。

試執行

--dry-run 會驗證變更，但不會寫入 openclaw.json。可用於 config set、config patch 和 config unset。

bash
openclaw config set channels.discord.token \  --ref-provider default \  --ref-source env \  --ref-id DISCORD_BOT_TOKEN \  --dry-run \  --json openclaw config set channels.discord.token \  --ref-provider vault \  --ref-source exec \  --ref-id discord/token \  --dry-run \  --allow-exec
試執行行為
  • 建構器模式：針對已變更的參照／提供者執行 SecretRef 可解析性檢查。
  • JSON 模式（--strict-json、--json 或批次模式）：執行結構描述驗證與 SecretRef 可解析性檢查。
  • 政策驗證會針對變更後的完整設定執行，因此寫入父物件（例如將 hooks 設定為物件）無法規避不支援介面的驗證。
  • 預設會略過 exec SecretRef 檢查，以避免命令產生副作用；傳入 --allow-exec 即可選擇啟用（這可能會執行提供者命令）。--allow-exec 僅適用於試執行，若沒有 --dry-run 則會發生錯誤。
--dry-run --json 欄位
  • ok：試執行是否通過
  • operations：已評估的指派數量
  • checks：是否已執行結構描述／可解析性檢查
  • checks.resolvabilityComplete：可解析性檢查是否執行至完成（略過 exec 參照時為 false）
  • refsChecked：試執行期間實際解析的參照數量
  • skippedExecRefs：因未設定 --allow-exec 而略過的 exec 參照數量
  • errors：ok=false 時，結構化的路徑缺失、結構描述或可解析性失敗資訊

JSON 輸出結構

json5
{  ok: boolean,  operations: number,  configPath: string,  inputModes: ["value" | "json" | "builder" | "unset", ...],  checks: {    schema: boolean,    resolvability: boolean,    resolvabilityComplete: boolean,  },  refsChecked: number,  skippedExecRefs: number,  errors?: [    {      kind: "missing-path" | "schema" | "resolvability" | "model",      message: string,      ref?: string, // 可解析性錯誤時存在    },  ],}

成功範例

json
{  "ok": true,  "operations": 1,  "configPath": "~/.openclaw/openclaw.json",  "inputModes": ["builder"],  "checks": {    "schema": false,    "resolvability": true,    "resolvabilityComplete": true  },  "refsChecked": 1,  "skippedExecRefs": 0}

失敗範例

json
{  "ok": false,  "operations": 1,  "configPath": "~/.openclaw/openclaw.json",  "inputModes": ["builder"],  "checks": {    "schema": false,    "resolvability": true,    "resolvabilityComplete": true  },  "refsChecked": 1,  "skippedExecRefs": 0,  "errors": [    {      "kind": "resolvability",      "message": "錯誤：未設定環境變數 \"MISSING_TEST_SECRET\"。",      "ref": "env:default:MISSING_TEST_SECRET"    }  ]}
如果試執行失敗
  • config schema validation failed：變更後的設定結構無效；請修正路徑／值或提供者／參照物件結構。
  • Config policy validation failed: unsupported SecretRef usage：將該認證資訊改回純文字／字串輸入；僅在支援的介面上使用 SecretRef。
  • SecretRef assignment(s) could not be resolved：目前無法解析所參照的提供者／參照（缺少環境變數、檔案指標無效、exec 提供者失敗，或提供者／來源不相符）。
  • model reference validation failed：已變更的文字模型主要項目或備援項目未知；請執行 openclaw models list 並選擇可用的模型。
  • Dry run note: skipped <n> exec SecretRef resolvability check(s)：如果需要驗證 exec 可解析性，請使用 --allow-exec 重新執行。
  • 若為批次模式，請修正失敗項目，並在寫入前重新執行 --dry-run。

套用變更

每次成功執行 config set／config patch／config unset 後，命令列介面都會列印下列三種提示之一，讓你知道閘道是否需要重新啟動：

提示 意義
Restart the gateway to apply. 已變更的路徑需要完整重新啟動。
Change will apply without restarting the gateway. 熱重新載入會自動套用變更。
No gateway restart needed. 沒有任何與執行階段相關的變更。

寫入 plugins.entries（或其任何子路徑）一律需要重新啟動，因為命令列介面無法證明已載入每個外掛的重新載入中繼資料。

寫入安全性

openclaw config set 和其他由 OpenClaw 擁有的設定寫入程式，會先驗證變更後的完整設定，再將其提交至磁碟。如果新的承載資料未通過結構描述驗證，或看起來會造成破壞性覆寫，現行設定將保持不變，遭拒的承載資料則會以 openclaw.json.rejected.* 儲存在旁。

由 OpenClaw 擁有的寫入作業會將 JSON5 重新序列化為標準 JSON。當來源包含註解時，寫入程式會在移除註解前立即發出警告；若保留註解很重要，請使用文字編輯器直接編輯。

進行小幅編輯時，建議使用命令列介面寫入：

bash
openclaw config set gateway.reload.mode hybrid --dry-runopenclaw config set gateway.reload.mode hybridopenclaw config validate

如果寫入遭拒，請檢查儲存的承載資料，並修正完整設定結構：

bash
CONFIG="$(openclaw config file)"ls -lt "$CONFIG".rejected.* 2>/dev/null | headopenclaw config validate

仍可使用文字編輯器直接寫入，但執行中的閘道會將其視為不受信任，直到通過驗證為止。無效的直接編輯會導致啟動失敗，或被熱重新載入略過；閘道不會重寫 openclaw.json。請執行 openclaw doctor --fix，以修復帶有前置內容／遭覆寫的設定，或還原最近一次已知良好的副本。請參閱閘道疑難排解。

完整檔案復原僅保留供 doctor 修復使用。外掛結構描述變更或 minHostVersion 偏差會明確報錯，而不會回復模型、提供者、驗證設定檔、頻道、閘道暴露範圍、工具、記憶體、瀏覽器或排程設定等不相關的使用者設定。

修復迴圈

openclaw config validate 通過後，請使用本機終端介面，讓內嵌代理程式將現行設定與文件比較，同時在同一個終端機中驗證每項變更：

bash
openclaw chat

在終端介面中，開頭的 ! 會執行實際的本機 shell 命令（每個工作階段首次執行前會顯示一次確認提示）：

text
!openclaw config file!openclaw docs gateway auth token secretref!openclaw config validate!openclaw doctor

  • 與文件比較

    要求代理程式將你目前的設定與相關文件頁面比較，並建議最小幅度的修正。

  • 套用針對性編輯

    使用 openclaw config set 或 openclaw configure 套用針對性編輯。

  • 重新驗證

    每次變更後重新執行 openclaw config validate。

  • 使用 Doctor 處理執行階段問題

    如果驗證通過，但執行階段仍不正常，請執行 openclaw doctor 或 openclaw doctor --fix，以取得移轉與修復協助。

    • 相關內容

    Was this useful?
    On this page

    On this page