跳转到主要内容
openclaw.json 的非交互式辅助命令:按路径获取/设置/补丁/取消设置值、打印 schema、验证,或打印活动文件路径。不带子命令运行 openclaw config 时,会打开与 openclaw configure 相同的引导式向导。
OPENCLAW_NIX_MODE=1 时,OpenClaw 会将 openclaw.json 视为不可变。只读命令(config getconfig fileconfig schemaconfig validate)仍然可用;配置写入命令会拒绝执行。请改为编辑安装的 Nix 源;对于第一方 nix-openclaw 发行版,请使用 nix-openclaw 快速开始,并在 programs.openclaw.configinstances.<name>.config 下设置值。

根选项

--section <section>
string
在不带子命令运行 openclaw config 时,可重复使用的引导式设置分区过滤器。
引导式分区:workspacemodelwebgatewaydaemonchannelspluginsskillshealth

示例

openclaw config file
openclaw config --section model
openclaw config --section gateway --section daemon
openclaw config schema
openclaw config get browser.executablePath
openclaw 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.list[0].tools.exec.node' "node-id-or-name"
openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --merge
openclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN
openclaw config set secrets.providers.vaultfile --provider-source file --provider-path /etc/openclaw/secrets.json --provider-mode json
openclaw config patch --file ./openclaw.patch.json5 --dry-run
openclaw config unset plugins.entries.brave.config.webSearch.apiKey
openclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN --dry-run
openclaw config validate
openclaw config validate --json

路径

点号或方括号表示法。在 shell 示例中引用方括号路径,避免 zsh 对 [0] 执行 glob 展开:
openclaw config get agents.defaults.workspace
openclaw config get 'agents.list[0].id'
openclaw config get agents.list
openclaw config set 'agents.list[1].tools.exec.node' "node-id-or-name"

config get

从已脱敏的配置快照读取值(绝不会打印密钥)。--json 会将原始值打印为 JSON;否则字符串/数字/布尔值会直接打印,对象/数组会打印为格式化 JSON。
openclaw config get browser.executablePath
openclaw config get agents.defaults.model --json

config file

打印活动配置文件路径,该路径从 OPENCLAW_CONFIG_PATH 或默认位置解析而来。该路径指向常规文件,而不是符号链接;请参阅写入安全

config schema

将为 openclaw.json 生成的 JSON schema 打印到 stdout。
  • 当前根配置 schema,以及供编辑器工具使用的根 $schema 字符串字段。
  • Control UI 使用的字段 title / description 文档元数据。
  • 当存在匹配的字段文档时,嵌套对象、通配符(*)和数组项([])节点会继承相同的 title / description 元数据。
  • anyOf / oneOf / allOf 分支也会继承相同的文档元数据。
  • 当可以加载运行时清单时,会尽力包含实时插件 + 渠道 schema 元数据。
  • 即使当前配置无效,也会提供干净的回退 schema。
config.schema.lookup 会返回一个规范化配置路径,包含浅层 schema 节点(titledescriptiontypeenumconst、常见边界)、匹配的 UI 提示元数据,以及直接子项摘要。可将它用于 Control UI 或自定义客户端中的路径级下钻。
openclaw config schema
openclaw config schema > openclaw.schema.json

config validate

在不启动 Gateway 网关的情况下,根据活动 schema 验证当前配置。
openclaw config validate
openclaw config validate --json
如果验证已经失败,请从 openclaw configureopenclaw doctor --fix 开始。openclaw chat 不会绕过无效配置保护。

值会尽可能按 JSON5 解析;否则会被视为原始字符串。使用 --strict-json 要求标准 JSON,且不回退到字符串(这样会拒绝仅 JSON5 支持的语法,例如注释、尾随逗号或未加引号的键)。--jsonconfig set--strict-json 的旧版别名。
openclaw config set agents.defaults.heartbeat.every "0m"
openclaw config set gateway.port 19001 --strict-json
openclaw config set channels.whatsapp.groups '["*"]' --strict-json
config get <path> --json 会将原始值打印为 JSON,而不是终端格式化文本。
默认情况下,对象赋值会替换目标路径。对于通常保存用户添加条目的受保护路径,如果替换会移除现有条目,则会被拒绝,除非你传入 --replaceagents.defaults.modelsagents.listmodels.providersmodels.providers.<id>models.providers.<id>.modelsplugins.entriesauth.profiles
向这些映射添加条目时使用 --merge
openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --merge
openclaw config set models.providers.ollama.models '[{"id":"llama3.2","name":"Llama 3.2"}]' --strict-json --merge
仅当提供的值应有意成为完整目标值时,才使用 --replace

config set 模式

openclaw config set <path> <value>
不支持运行时可变的表面会拒绝 SecretRef 赋值(例如 hooks.tokencommands.ownerDisplaySecret、Discord 线程绑定 webhook 令牌,以及 WhatsApp 凭据 JSON)。请参阅 SecretRef 凭据表面
批处理解析始终以批处理载荷(--batch-json/--batch-file)作为事实来源;--strict-json / --json 不会改变批处理解析行为。 JSON 路径/值模式也可以直接用于 SecretRefs 和提供商:
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>fileexec
  • --provider-allowlist <ENV_VAR>(可重复)
  • --provider-path <path>(必需)
  • --provider-mode <singleValue|json>
  • --provider-max-bytes <bytes>
  • --provider-allow-insecure-path
  • --provider-command <path>(必需)
  • --provider-arg <arg>(可重复)
  • --provider-no-output-timeout-ms <ms>
  • --provider-max-output-bytes <bytes>
  • --provider-json-only
  • --provider-env <KEY=VALUE>(可重复)
  • --provider-pass-env <ENV_VAR>(可重复)
  • --provider-trusted-dir <path>(可重复)
  • --provider-allow-insecure-path
  • --provider-allow-symlink-command
加固的 exec 提供商示例:
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 会删除目标路径。
openclaw config patch --file ./openclaw.patch.json5 --dry-run
openclaw config patch --file ./openclaw.patch.json5
通过 stdin 管道传入补丁,用于远程设置脚本:
ssh user@gateway-host 'openclaw config patch --stdin --dry-run' < ./openclaw.patch.json5
ssh user@gateway-host 'openclaw config patch --stdin' < ./openclaw.patch.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.5" },
      models: {
        "openai/gpt-5.5": { params: { fastMode: true } },
      },
    },
  },
}
当某个对象或数组必须精确变为提供的值,而不是被递归补丁时,使用 --replace-path <path>
openclaw config patch --file ./discord.patch.json5 --replace-path 'channels.discord.guilds["123"].channels'
--dry-run 会在不写入的情况下运行 schema 和 SecretRef 可解析性检查。试运行期间默认会跳过由 exec 支持的 SecretRefs;当你有意让试运行执行提供商命令时,添加 --allow-exec

试运行

--dry-run 会在不写入 openclaw.json 的情况下验证更改。可用于 config setconfig patchconfig unset
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
  • 构建器模式:对已更改的 ref/提供商运行 SecretRef 可解析性检查。
  • JSON 模式(--strict-json--json 或批处理模式):运行架构验证以及 SecretRef 可解析性检查。
  • 策略验证会针对完整的变更后配置运行,因此父对象写入(例如将 hooks 设置为对象)无法绕过不受支持表面的验证。
  • 默认会跳过 Exec SecretRef 检查,以避免命令副作用;传入 --allow-exec 可选择启用(这可能会执行提供商命令)。--allow-exec 仅适用于试运行,并且没有 --dry-run 时会报错。
  • ok:试运行是否通过
  • operations:已评估的赋值数量
  • checks:是否运行了架构/可解析性检查
  • checks.resolvabilityComplete:可解析性检查是否运行到完成(跳过 exec refs 时为 false)
  • refsChecked:试运行期间实际解析的 refs 数量
  • skippedExecRefs:由于未设置 --allow-exec 而跳过的 exec refs 数量
  • errors:当 ok=false 时的结构化缺失路径、架构或可解析性失败

JSON 输出形状

{
  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",
      message: string,
      ref?: string, // present for resolvability errors
    },
  ],
}
{
  "ok": true,
  "operations": 1,
  "configPath": "~/.openclaw/openclaw.json",
  "inputModes": ["builder"],
  "checks": {
    "schema": false,
    "resolvability": true,
    "resolvabilityComplete": true
  },
  "refsChecked": 1,
  "skippedExecRefs": 0
}
  • config schema validation failed:你的变更后配置形状无效;修复路径/值或提供商/ref 对象形状。
  • Config policy validation failed: unsupported SecretRef usage:将该凭证移回明文/字符串输入;仅在受支持的表面上保留 SecretRefs。
  • SecretRef assignment(s) could not be resolved:引用的提供商/ref 当前无法解析(缺少环境变量、文件指针无效、exec 提供商失败,或提供商/来源不匹配)。
  • Dry run note: skipped <n> exec SecretRef resolvability check(s):如果你需要 exec 可解析性验证,请使用 --allow-exec 重新运行。
  • 对于批处理模式,请修复失败条目,并在写入前重新运行 --dry-run

应用更改

每次 config set / config patch / config unset 成功后,CLI 都会打印三种提示之一,让你知道 Gateway 网关是否需要重启:
提示含义
Restart the gateway to apply.已更改的路径需要完整重启。
Change will apply without restarting the gateway.热重载会自动拾取它。
No gateway restart needed.没有运行时相关内容发生更改。
写入 plugins.entries(或任何子路径)始终需要重启,因为 CLI 无法证明每个插件的重载元数据都已加载。

写入安全

openclaw config set 和其他 OpenClaw 拥有的配置写入器会在将配置提交到磁盘前验证完整的变更后配置。如果新的载荷未通过架构验证,或看起来像破坏性覆盖,活动配置会保持不变,被拒绝的载荷会保存到旁边,命名为 openclaw.json.rejected.*
活动配置路径必须是普通文件。不支持对符号链接的 openclaw.json 布局执行写入;请改用 OPENCLAW_CONFIG_PATH 直接指向真实文件。
小型编辑优先使用 CLI 写入:
openclaw config set gateway.reload.mode hybrid --dry-run
openclaw config set gateway.reload.mode hybrid
openclaw config validate
如果写入被拒绝,请检查保存的载荷并修复完整配置形状:
CONFIG="$(openclaw config file)"
ls -lt "$CONFIG".rejected.* 2>/dev/null | head
openclaw config validate
仍然允许直接用编辑器写入,但运行中的 Gateway 网关会在它们通过验证前将其视为不可信。无效的直接编辑会导致启动失败,或被热重载跳过;Gateway 网关不会重写 openclaw.json。运行 openclaw doctor --fix 来修复带前缀/被覆盖的配置,或恢复最后一个已知良好的副本。参见 Gateway 网关故障排查 整文件恢复仅保留给 Doctor 修复。插件架构更改或 minHostVersion 偏差会保持显式报错,而不是回滚模型、提供商、身份验证配置档、渠道、Gateway 网关暴露、工具、记忆、浏览器或 cron 配置等无关用户设置。

修复循环

openclaw config validate 通过后,使用本地 TUI,让嵌入式智能体将活动配置与文档进行比较,同时你在同一个终端中验证每项更改:
openclaw chat
在 TUI 内,前导 ! 会运行字面量本地 shell 命令(在每个会话首次确认提示后):
!openclaw config file
!openclaw docs gateway auth token secretref
!openclaw config validate
!openclaw doctor
1

与文档比较

让智能体将你的当前配置与相关文档页面进行比较,并建议最小修复。
2

应用定向编辑

使用 openclaw config setopenclaw configure 应用定向编辑。
3

重新验证

每次更改后重新运行 openclaw config validate
4

使用 Doctor 处理运行时问题

如果验证通过但运行时仍不健康,请运行 openclaw doctoropenclaw doctor --fix 来获取迁移和修复帮助。

相关