跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

OpenClaw 会从 ~/.openclaw/openclaw.json 读取可选的 配置。 活动配置路径必须是常规文件。符号链接的 openclaw.json 布局不支持 OpenClaw 所有的写入；原子写入可能会替换 该路径，而不是保留符号链接。如果你将配置放在默认状态目录之外， 请将 OPENCLAW_CONFIG_PATH 直接指向真实文件。 如果文件缺失，OpenClaw 会使用安全默认值。添加配置的常见原因：
  • 连接渠道并控制谁可以向机器人发消息
  • 设置模型、工具、沙箱隔离或自动化（cron、钩子）
  • 调整会话、媒体、网络或 UI
查看完整参考，了解每个可用字段。 智能体和自动化在编辑配置前，应使用 config.schema.lookup 获取精确的字段级 文档。将此页面用于面向任务的指导，并将 配置参考 用于更全面的 字段映射和默认值。
刚开始使用配置？ 从 openclaw onboard 开始进行交互式设置，或查看 配置示例指南，获取完整的可复制粘贴配置。

​
最小配置

// ~/.openclaw/openclaw.json
{
  agents: { defaults: { workspace: "~/.openclaw/workspace" } },
  channels: { whatsapp: { allowFrom: ["+15555550123"] } },
}

​
编辑配置

openclaw onboard       # full onboarding flow
openclaw configure     # config wizard

​
严格验证

OpenClaw 只接受完全匹配架构的配置。未知键、格式错误的类型或无效值会导致 Gateway 网关拒绝启动。唯一的根级例外是 $schema（字符串），这样编辑器可以附加 JSON Schema 元数据。
openclaw config schema 会打印控制 UI 和验证使用的规范 JSON Schema。config.schema.lookup 会获取单个按路径限定的节点以及 子项摘要，供下钻工具使用。字段 title/description 文档元数据 会贯穿嵌套对象、通配符（*）、数组项（[]）以及 anyOf/ oneOf/allOf 分支。加载清单注册表后，运行时插件和渠道架构会合并进来。 验证失败时：
  • Gateway 网关不会启动
  • 只有诊断命令可用（openclaw doctor、openclaw logs、openclaw health、openclaw status）
  • 运行 openclaw doctor 查看确切问题
  • 运行 openclaw doctor --fix（或 --yes）应用修复
Gateway 网关会在每次成功启动后保留一个可信的最后已知良好副本， 但启动和热重载不会自动恢复它。如果 openclaw.json 验证失败（包括插件本地验证），Gateway 网关启动会失败，或 重载会被跳过，而当前运行时会保留最后接受的配置。 运行 openclaw doctor --fix（或 --yes）来修复带前缀/被覆盖的配置，或 恢复最后已知良好副本。当候选配置包含已脱敏的密钥占位符（例如 ***）时， 会跳过提升为最后已知良好副本。

​
常见任务

每个渠道在 channels.<provider> 下都有自己的配置部分。请查看对应渠道页面了解设置步骤：所有渠道都共享相同的私信策略模式：
{
  channels: {
    telegram: {
      enabled: true,
      botToken: "123:abc",
      dmPolicy: "pairing",   // pairing | allowlist | open | disabled
      allowFrom: ["tg:123"], // only for allowlist/open
    },
  },
}
设置主模型和可选后备模型：
{
  agents: {
    defaults: {
      model: {
        primary: "anthropic/claude-sonnet-4-6",
        fallbacks: ["openai/gpt-5.4"],
      },
      models: {
        "anthropic/claude-sonnet-4-6": { alias: "Sonnet" },
        "openai/gpt-5.4": { alias: "GPT" },
      },
    },
  },
}
  • agents.defaults.models 定义模型目录，并充当 /model 的允许列表；provider/* 条目会将 /model、/models 和模型选择器过滤为选定的提供商，同时仍使用动态模型发现。
  • 使用 openclaw config set agents.defaults.models '<json>' --strict-json --merge 添加允许列表条目，而不会移除现有模型。除非传入 --replace，否则会移除条目的普通替换会被拒绝。
  • 模型引用使用 provider/model 格式（例如 anthropic/claude-opus-4-6）。
  • agents.defaults.imageMaxDimensionPx 控制记录/工具图像缩小（默认 1200）；较低值通常会减少大量截图运行中的视觉 token 使用量。
  • 请查看 Models CLI，了解如何在聊天中切换模型；查看模型故障转移，了解凭证轮换和后备行为。
  • 对于自定义/自托管提供商，请查看参考中的自定义提供商。
私信访问通过每个渠道的 dmPolicy 控制：
  • "pairing"（默认）：未知发送者会收到一次性配对码以供批准
  • "allowlist"：仅允许 allowFrom（或已配对允许存储）中的发送者
  • "open"：允许所有入站私信（需要 allowFrom: ["*"]）
  • "disabled"：忽略所有私信
对于群组，请使用 groupPolicy + groupAllowFrom 或渠道专用允许列表。查看完整参考，了解每个渠道的详细信息。
群组消息默认要求提及。按智能体配置触发模式，并将可见房间回复保持在默认消息工具路径上，除非你有意使用旧版自动最终回复：
{
  messages: {
    visibleReplies: "automatic", // set "message_tool" to require message-tool sends everywhere
    groupChat: {
      visibleReplies: "message_tool", // default; use "automatic" for legacy room replies
    },
  },
  agents: {
    list: [
      {
        id: "main",
        groupChat: {
          mentionPatterns: ["@openclaw", "openclaw"],
        },
      },
    ],
  },
  channels: {
    whatsapp: {
      groups: { "*": { requireMention: true } },
    },
  },
}
  • 元数据提及：原生 @ 提及（WhatsApp 点按提及、Telegram @bot 等）
  • 文本模式：mentionPatterns 中的安全正则模式
  • 可见回复：messages.visibleReplies 可以全局要求通过消息工具发送；messages.groupChat.visibleReplies 会为群组/渠道覆盖该设置。
  • 查看完整参考，了解可见回复模式、每渠道覆盖项和自聊模式。
使用 agents.defaults.skills 作为共享基线，然后用 agents.list[].skills 覆盖特定智能体：
{
  agents: {
    defaults: {
      skills: ["github", "weather"],
    },
    list: [
      { id: "writer" }, // inherits github, weather
      { id: "docs", skills: ["docs-search"] }, // replaces defaults
      { id: "locked-down", skills: [] }, // no skills
    ],
  },
}
  • 省略 agents.defaults.skills，默认不限制 Skills。
  • 省略 agents.list[].skills 以继承默认值。
  • 设置 agents.list[].skills: [] 表示没有 Skills。
  • 查看 Skills、Skills 配置，以及 配置参考。
控制 Gateway 网关重启看起来陈旧的渠道时的激进程度：
{
  gateway: {
    channelHealthCheckMinutes: 5,
    channelStaleEventThresholdMinutes: 30,
    channelMaxRestartsPerHour: 10,
  },
  channels: {
    telegram: {
      healthMonitor: { enabled: false },
      accounts: {
        alerts: {
          healthMonitor: { enabled: true },
        },
      },
    },
  },
}
  • 设置 gateway.channelHealthCheckMinutes: 0 可全局禁用健康监控重启。
  • channelStaleEventThresholdMinutes 应大于或等于检查间隔。
  • 使用 channels.<provider>.healthMonitor.enabled 或 channels.<provider>.accounts.<id>.healthMonitor.enabled 为单个渠道或账号禁用自动重启，而不禁用全局监控。
  • 查看健康检查了解运维调试，并查看完整参考了解所有字段。
在负载较高或低功耗主机上，给本地客户端更多时间完成认证前 WebSocket 握手：
{
  gateway: {
    handshakeTimeoutMs: 30000,
  },
}
  • 默认值为 15000 毫秒。
  • OPENCLAW_HANDSHAKE_TIMEOUT_MS 对一次性服务或 shell 覆盖仍然优先生效。
  • 优先修复启动/事件循环停顿；此旋钮适用于健康但预热期间较慢的主机。
会话控制对话连续性和隔离：
{
  session: {
    dmScope: "per-channel-peer",  // recommended for multi-user
    threadBindings: {
      enabled: true,
      idleHours: 24,
      maxAgeHours: 0,
    },
    reset: {
      mode: "daily",
      atHour: 4,
      idleMinutes: 120,
    },
  },
}
  • dmScope: main（共享）| per-peer | per-channel-peer | per-account-channel-peer
  • threadBindings：线程绑定会话路由的全局默认值（Discord 支持 /focus、/unfocus、/agents、/session idle 和 /session max-age）。
  • 请参阅会话管理，了解作用域、身份链接和发送策略。
  • 请参阅完整参考，了解所有字段。
在隔离的沙箱运行时中运行智能体会话：
{
  agents: {
    defaults: {
      sandbox: {
        mode: "non-main",  // off | non-main | all
        scope: "agent",    // session | agent | shared
      },
    },
  },
}
先构建镜像 - 如果使用源码检出，请运行 scripts/sandbox-setup.sh；如果使用 npm 安装，请参阅沙箱隔离 § 镜像和设置中的内联 docker build 命令。请参阅沙箱隔离获取完整指南，并参阅完整参考了解所有选项。
基于中继的推送在 openclaw.json 中配置。在 Gateway 网关配置中设置：
{
  gateway: {
    push: {
      apns: {
        relay: {
          baseUrl: "https://relay.example.com",
          // Optional. Default: 10000
          timeoutMs: 10000,
        },
      },
    },
  },
}
等效 CLI：
openclaw config set gateway.push.apns.relay.baseUrl https://relay.example.com
这会执行以下操作：
  • 让 Gateway 网关通过外部中继发送 push.test、唤醒轻推和重连唤醒。
  • 使用已配对 iOS 应用转发的、限定到注册范围的发送授权。Gateway 网关不需要部署范围的中继令牌。
  • 将每个基于中继的注册绑定到 iOS 应用配对的 Gateway 网关身份，因此另一个 Gateway 网关无法复用已存储的注册。
  • 让本地/手动 iOS 构建继续使用直接 APNs。基于中继的发送仅适用于通过中继注册的官方分发构建。
  • 必须匹配烘焙到官方/TestFlight iOS 构建中的中继基础 URL，确保注册和发送流量到达同一中继部署。
端到端流程：
  1. 安装使用相同中继基础 URL 编译的官方/TestFlight iOS 构建。
  2. 在 Gateway 网关上配置 gateway.push.apns.relay.baseUrl。
  3. 将 iOS 应用与 Gateway 网关配对，并让节点会话和操作者会话都连接。
  4. iOS 应用获取 Gateway 网关身份，使用 App Attest 加应用收据向中继注册，然后将基于中继的 push.apns.register 载荷发布到已配对的 Gateway 网关。
  5. Gateway 网关存储中继句柄和发送授权，然后将它们用于 push.test、唤醒轻推和重连唤醒。
运维说明：
  • 如果你将 iOS 应用切换到不同的 Gateway 网关，请重新连接应用，使其能够发布绑定到该 Gateway 网关的新中继注册。
  • 如果你发布指向不同中继部署的新 iOS 构建，应用会刷新其缓存的中继注册，而不是复用旧的中继来源。
兼容性说明：
  • OPENCLAW_APNS_RELAY_BASE_URL 和 OPENCLAW_APNS_RELAY_TIMEOUT_MS 仍可作为临时环境变量覆盖使用。
  • OPENCLAW_APNS_RELAY_ALLOW_HTTP=true 仍是仅限 loopback 的开发逃生口；不要在配置中持久保存 HTTP 中继 URL。
请参阅 iOS 应用了解端到端流程，并参阅认证和信任流程了解中继安全模型。
{
  agents: {
    defaults: {
      heartbeat: {
        every: "30m",
        target: "last",
      },
    },
  },
}
  • every：时长字符串（30m、2h）。设置为 0m 可禁用。
  • target: last | none | <channel-id>（例如 discord、matrix、telegram 或 whatsapp）
  • directPolicy：用于私信风格 Heartbeat 目标的 allow（默认）或 block
  • 请参阅 Heartbeat获取完整指南。
{
  cron: {
    enabled: true,
    maxConcurrentRuns: 2, // cron dispatch + isolated cron agent-turn execution
    sessionRetention: "24h",
    runLog: {
      maxBytes: "2mb",
      keepLines: 2000,
    },
  },
}
  • sessionRetention：从 sessions.json 中剪除已完成的隔离运行会话（默认 24h；设置为 false 可禁用）。
  • runLog：按大小和保留行数剪除 cron/runs/<jobId>.jsonl。
  • 请参阅 Cron 作业获取功能概览和 CLI 示例。
在 Gateway 网关上启用 HTTP webhook 端点：
{
  hooks: {
    enabled: true,
    token: "shared-secret",
    path: "/hooks",
    defaultSessionKey: "hook:ingress",
    allowRequestSessionKey: false,
    allowedSessionKeyPrefixes: ["hook:"],
    mappings: [
      {
        match: { path: "gmail" },
        action: "agent",
        agentId: "main",
        deliver: true,
      },
    ],
  },
}
安全说明：
  • 将所有 hook/webhook 载荷内容视为不可信输入。
  • 使用专用的 hooks.token；不要复用共享 Gateway 网关令牌。
  • Hook 认证仅支持标头（Authorization: Bearer ... 或 x-openclaw-token）；查询字符串令牌会被拒绝。
  • hooks.path 不能是 /；请将 webhook 入口保持在专用子路径上，例如 /hooks。
  • 除非进行严格限定范围的调试，否则保持禁用不安全内容绕过标志（hooks.gmail.allowUnsafeExternalContent、hooks.mappings[].allowUnsafeExternalContent）。
  • 如果启用 hooks.allowRequestSessionKey，还应设置 hooks.allowedSessionKeyPrefixes 以约束调用方选择的会话键。
  • 对于由 hook 驱动的智能体，优先使用强大的现代模型档位和严格的工具策略（例如仅限消息发送，并在可行时加上沙箱隔离）。
请参阅完整参考，了解所有映射选项和 Gmail 集成。
使用独立工作区和会话运行多个隔离智能体：
{
  agents: {
    list: [
      { id: "home", default: true, workspace: "~/.openclaw/workspace-home" },
      { id: "work", workspace: "~/.openclaw/workspace-work" },
    ],
  },
  bindings: [
    { agentId: "home", match: { channel: "whatsapp", accountId: "personal" } },
    { agentId: "work", match: { channel: "whatsapp", accountId: "biz" } },
  ],
}
请参阅多智能体和完整参考，了解绑定规则和每智能体访问配置文件。
使用 $include 来组织大型配置：
// ~/.openclaw/openclaw.json
{
  gateway: { port: 18789 },
  agents: { $include: "./agents.json5" },
  broadcast: {
    $include: ["./clients/a.json5", "./clients/b.json5"],
  },
}
  • 单个文件：替换包含它的对象
  • 文件数组：按顺序深度合并（后者优先）
  • 同级键：在 include 之后合并（覆盖已 include 的值）
  • 嵌套 include：最多支持 10 层深度
  • 相对路径：相对于执行 include 的文件解析
  • OpenClaw 拥有的写入：当一次写入只改变一个由单文件 include 支持的顶级分区时，例如 plugins: { $include: "./plugins.json5" }，OpenClaw 会更新该被 include 的文件，并保持 openclaw.json 不变
  • 不支持的写透：根 include、include 数组以及带有同级覆盖的 include 会对 OpenClaw 拥有的写入失败关闭，而不是展平配置
  • 限制范围：$include 路径必须解析到保存 openclaw.json 的目录下。若要在机器或用户之间共享目录树，请将 OPENCLAW_INCLUDE_ROOTS 设置为额外目录的路径列表（POSIX 上为 :，Windows 上为 ;），include 可以引用这些目录。符号链接会被解析并重新检查，因此即使某路径在词法上位于配置目录中，但真实目标逃离了每个允许的根，也仍会被拒绝。
  • 错误处理：对缺失文件、解析错误和循环 include 给出清晰错误

​
配置热重载

Gateway 网关会监视 ~/.openclaw/openclaw.json 并自动应用更改 - 大多数设置无需手动重启。 直接文件编辑在通过验证前会被视为不可信。监视器会等待编辑器临时写入/重命名抖动稳定，读取最终文件，并拒绝无效的外部编辑且不重写 openclaw.json。OpenClaw 拥有的配置写入在写入前使用同一个 schema 门禁；破坏性覆盖（例如丢弃 gateway.mode 或将文件缩小超过一半）会被拒绝，并另存为 .rejected.* 以供检查。 如果看到 config reload skipped (invalid config)，或启动报告 Invalid config，请检查配置，运行 openclaw config validate，然后运行 openclaw doctor --fix 进行修复。请参阅 Gateway 网关故障排除查看清单。

​
重载模式

模式行为
hybrid（默认）立即热应用安全更改。对关键更改自动重启。
hot仅热应用安全更改。当需要重启时记录警告 - 由你处理。
restart任何配置更改都会重启 Gateway 网关，无论是否安全。
off禁用文件监视。更改会在下次手动重启时生效。
{
  gateway: {
    reload: { mode: "hybrid", debounceMs: 300 },
  },
}

​
哪些会热应用，哪些需要重启

大多数字段都可以无停机热应用。在 hybrid 模式下，需要重启的更改会自动处理。
类别字段需要重启？
渠道channels.*、web（WhatsApp）- 所有内置和插件渠道否
智能体和模型agent、agents、models、routing否
自动化hooks、cron、agent.heartbeat否
会话和消息session、messages否
工具和媒体tools、browser、skills、mcp、audio、talk否
UI 和其他ui、logging、identity、bindings否
Gateway 网关服务器gateway.*（端口、绑定、认证、tailscale、TLS、HTTP）是
基础设施discovery、plugins是
gateway.reload 和 gateway.remote 是例外 - 更改它们不会触发重启。

​
重载规划

当你编辑通过 $include 引用的源文件时，OpenClaw 会根据源文件编写的布局来规划重载，而不是根据扁平化的内存视图。 这样可以让热重载决策（热应用或重启）保持可预测，即使单个顶级小节位于它自己的被包含文件中，例如 plugins: { $include: "./plugins.json5" }。如果源布局存在歧义，重载规划会以失败关闭的方式处理。

​
配置 RPC（程序化更新）

对于通过 Gateway 网关 API 写入配置的工具，优先使用此流程：
  • config.schema.lookup 用于检查一个子树（浅层 schema 节点 + 子项摘要）
  • config.get 用于获取当前快照以及 hash
  • config.patch 用于部分更新（JSON merge patch：对象合并，null 删除，数组替换）
  • 只有在你打算替换整个配置时才使用 config.apply
  • update.run 用于显式自更新并重启；当重启后的会话需要运行一个后续轮次时，请包含 continuationMessage
  • update.status 用于检查最新的更新重启哨兵，并在重启后验证正在运行的版本
Agents 应将 config.schema.lookup 作为获取精确字段级文档和约束的第一站。当它们需要更完整的配置映射、默认值或指向专用子系统参考的链接时，请使用 配置参考。
控制平面写入（config.apply、config.patch、update.run）按每个 deviceId+clientIp 每 60 秒 3 个请求进行限速。重启请求会合并，然后在重启周期之间强制执行 30 秒冷却时间。 update.status 是只读的，但限定为管理员范围，因为重启哨兵可能包含更新步骤摘要和命令输出尾部。
部分补丁示例： 
openclaw gateway call config.get --params '{}'  # capture payload.hash
openclaw gateway call config.patch --params '{
  "raw": "{ channels: { telegram: { groups: { \"*\": { requireMention: false } } } } }",
  "baseHash": "<hash>"
}'
config.apply 和 config.patch 都接受 raw、baseHash、sessionKey、note 和 restartDelayMs。当配置已存在时，这两个方法都需要 baseHash。

​
环境变量

OpenClaw 会从父进程以及以下来源读取环境变量：
  • 当前工作目录中的 .env（如果存在）
  • ~/.openclaw/.env（全局后备）
这两个文件都不会覆盖现有环境变量。你也可以在配置中设置内联环境变量： 
{
  env: {
    OPENROUTER_API_KEY: "sk-or-...",
    vars: { GROQ_API_KEY: "gsk-..." },
  },
}
如果启用且预期键名未设置，OpenClaw 会运行你的登录 shell，并只导入缺失的键名：
{
  env: {
    shellEnv: { enabled: true, timeoutMs: 15000 },
  },
}
等效环境变量：OPENCLAW_LOAD_SHELL_ENV=1
在任意配置字符串值中使用 ${VAR_NAME} 引用环境变量：
{
  gateway: { auth: { token: "${OPENCLAW_GATEWAY_TOKEN}" } },
  models: { providers: { custom: { apiKey: "${CUSTOM_API_KEY}" } } },
}
规则：
  • 只匹配大写名称：[A-Z_][A-Z0-9_]*
  • 缺失或为空的变量会在加载时抛出错误
  • 使用 $${VAR} 转义以输出字面值
  • 可在 $include 文件中使用
  • 内联替换："${BASE}/v1" → "https://api.example.com/v1"
对于支持 SecretRef 对象的字段，你可以使用：
{
  models: {
    providers: {
      openai: { apiKey: { source: "env", provider: "default", id: "OPENAI_API_KEY" } },
    },
  },
  skills: {
    entries: {
      "image-lab": {
        apiKey: {
          source: "file",
          provider: "filemain",
          id: "/skills/entries/image-lab/apiKey",
        },
      },
    },
  },
  channels: {
    googlechat: {
      serviceAccountRef: {
        source: "exec",
        provider: "vault",
        id: "channels/googlechat/serviceAccount",
      },
    },
  },
}
SecretRef 详细信息（包括用于 env/file/exec 的 secrets.providers）位于 密钥管理。 支持的凭证路径列在 SecretRef 凭证范围 中。
完整优先级和来源请参阅 环境。

​
完整参考

有关完整的逐字段参考，请参阅 配置参考。
相关：配置示例 · 配置参考 · Doctor

​
相关