配置参考

• openclaw config schema 会输出用于验证和 Control UI 的实时 JSON Schema，并在可用时合并内置/插件/渠道元数据
• config.schema.lookup 会返回一个按路径范围限定的 schema 节点，供逐层深入工具使用
• pnpm config:docs:check / pnpm config:docs:gen 会根据当前 schema 表面验证配置文档基线哈希

• Memory configuration reference 用于 agents.defaults.memorySearch.*、memory.qmd.*、memory.citations，以及位于 plugins.entries.memory-core.config.dreaming 下的 dreaming 配置
• Slash commands 用于当前内置 + 打包提供的命令目录
• 对于渠道专有的命令面，请参见对应渠道/插件所属页面

​

渠道

​

智能体默认值、多智能体、会话和消息

• agents.defaults.*（工作区、模型、思考、心跳、内存、媒体、Skills、沙箱）
• multiAgent.*（多智能体路由与绑定）
• session.*（会话生命周期、压缩、裁剪）
• messages.*（消息投递、TTS、Markdown 渲染）
• talk.*（Talk 模式）
  • talk.speechLocale：可选的 BCP 47 locale id，用于 iOS/macOS 上 Talk 语音识别
  • talk.silenceTimeoutMs：未设置时，Talk 会保留平台默认的暂停窗口后再发送转录文本（macOS 和 Android 为 700 ms，iOS 为 900 ms）

​

工具和自定义提供商

​

MCP

{
  mcp: {
    // Optional. Default: 600000 ms (10 minutes). Set 0 to disable idle eviction.
    sessionIdleTtlMs: 600000,
    servers: {
      docs: {
        command: "npx",
        args: ["-y", "@modelcontextprotocol/server-fetch"],
      },
      remote: {
        url: "https://example.com/mcp",
        transport: "streamable-http", // streamable-http | sse
        headers: {
          Authorization: "Bearer ${MCP_REMOTE_TOKEN}",
        },
      },
    },
  },
}

• mcp.servers：供运行时使用的具名 stdio 或远程 MCP 服务器定义，这些运行时会暴露已配置的 MCP 工具。
• mcp.sessionIdleTtlMs：面向会话范围内置 MCP 运行时的空闲 TTL。 一次性内嵌运行会请求在运行结束时清理；此 TTL 是为长生命周期会话和未来调用方提供的兜底机制。
• mcp.* 下的变更会通过释放缓存的会话 MCP 运行时来热应用。 下一次工具发现/使用时，会基于新配置重新创建它们，因此被移除的 mcp.servers 条目会立即回收，而不是等到空闲 TTL 到期。

​

Skills

{
  skills: {
    allowBundled: ["gemini", "peekaboo"],
    load: {
      extraDirs: ["~/Projects/agent-scripts/skills"],
    },
    install: {
      preferBrew: true,
      nodeManager: "npm", // npm | pnpm | yarn | bun
    },
    entries: {
      "image-lab": {
        apiKey: { source: "env", provider: "default", id: "GEMINI_API_KEY" }, // or plaintext string
        env: { GEMINI_API_KEY: "GEMINI_KEY_HERE" },
      },
      peekaboo: { enabled: true },
      sag: { enabled: false },
    },
  },
}

• allowBundled：仅针对内置 Skills 的可选允许列表（托管/workspace Skills 不受影响）。
• load.extraDirs：额外的共享 Skills 根目录（优先级最低）。
• install.preferBrew：为 true 时，如果 brew 可用，则优先使用 Homebrew 安装器，然后才回退到其他安装器类型。
• install.nodeManager：metadata.openclaw.install 规范所使用的 Node 安装器偏好（npm | pnpm | yarn | bun）。
• entries.<skillKey>.enabled: false：即使某个 Skill 已内置/已安装，也会将其禁用。
• entries.<skillKey>.apiKey：为声明主要环境变量的 Skills 提供的便捷字段（明文字符串或 SecretRef 对象）。

​

插件

{
  plugins: {
    enabled: true,
    allow: ["voice-call"],
    deny: [],
    load: {
      paths: ["~/Projects/oss/voice-call-plugin"],
    },
    entries: {
      "voice-call": {
        enabled: true,
        hooks: {
          allowPromptInjection: false,
        },
        config: { provider: "twilio" },
      },
    },
  },
}

• 从 ~/.openclaw/extensions、<workspace>/.openclaw/extensions 以及 plugins.load.paths 加载。
• 设备发现支持原生 OpenClaw 插件，以及兼容的 Codex bundles 和 Claude bundles，包括无 manifest 的 Claude 默认布局 bundle。
• 配置变更需要重启 Gateway 网关。
• allow：可选允许列表（只有列出的插件会被加载）。deny 优先生效。
• plugins.entries.<id>.apiKey：插件级 API key 便捷字段（插件支持时可用）。
• plugins.entries.<id>.env：插件作用域环境变量映射。
• plugins.entries.<id>.hooks.allowPromptInjection：当为 false 时，核心会阻止 before_prompt_build，并忽略旧版 before_agent_start 中会修改提示词的字段，同时保留旧版 modelOverride 和 providerOverride。适用于原生插件钩子以及受支持 bundle 提供的钩子目录。
• plugins.entries.<id>.hooks.allowConversationAccess：当为 true 时，受信任的非内置插件可以从 llm_input、llm_output、before_agent_finalize 和 agent_end 等类型化钩子中读取原始会话内容。
• plugins.entries.<id>.subagent.allowModelOverride：显式信任该插件可为后台子智能体运行请求按次运行的 provider 和 model 覆盖。
• plugins.entries.<id>.subagent.allowedModels：受信任子智能体覆盖可使用的规范 provider/model 目标可选允许列表。只有在你明确希望允许任意模型时，才使用 "*"。
• plugins.entries.<id>.config：插件自定义配置对象（在可用时由原生 OpenClaw 插件 schema 验证）。
• 渠道插件的账号/运行时设置位于 channels.<id> 下，应由所属插件 manifest 中的 channelConfigs 元数据描述，而不是由集中式 OpenClaw 选项注册表描述。
• plugins.entries.firecrawl.config.webFetch：Firecrawl 网页抓取提供商设置。
  • apiKey：Firecrawl API key（接受 SecretRef）。回退顺序为 plugins.entries.firecrawl.config.webSearch.apiKey、旧版 tools.web.fetch.firecrawl.apiKey，或 FIRECRAWL_API_KEY 环境变量。
  • baseUrl：Firecrawl API 基础 URL（默认：https://api.firecrawl.dev）。
  • onlyMainContent：仅提取页面主体内容（默认：true）。
  • maxAgeMs：缓存最大存活时间（毫秒）（默认：172800000 / 2 天）。
  • timeoutSeconds：抓取请求超时时间（秒）（默认：60）。
• plugins.entries.xai.config.xSearch：xAI X Search（Grok web search）设置。
  • enabled：启用 X Search 提供商。
  • model：搜索使用的 Grok 模型（例如 "grok-4-1-fast"）。
• plugins.entries.memory-core.config.dreaming：memory dreaming 设置。阶段和阈值请参见 Dreaming。
  • enabled：dreaming 总开关（默认 false）。
  • frequency：每次完整 dreaming 扫描的 cron 频率（默认值为 "0 3 * * *"）。
  • 阶段策略和阈值属于实现细节（不是面向用户的配置键）。
• 完整的 memory 配置位于 Memory configuration reference：
  • agents.defaults.memorySearch.*
  • memory.backend
  • memory.citations
  • memory.qmd.*
  • plugins.entries.memory-core.config.dreaming
• 已启用的 Claude bundle 插件也可以通过 settings.json 提供内嵌 Pi 默认值；OpenClaw 会将其作为已净化的智能体设置来应用，而不是作为原始 OpenClaw 配置补丁。
• plugins.slots.memory：选择活动 memory 插件 id，或使用 "none" 禁用 memory 插件。
• plugins.slots.contextEngine：选择活动上下文引擎插件 id；默认值为 "legacy"，除非你安装并选择了其他引擎。

​

浏览器

{
  browser: {
    enabled: true,
    evaluateEnabled: true,
    defaultProfile: "user",
    ssrfPolicy: {
      // dangerouslyAllowPrivateNetwork: true, // opt in only for trusted private-network access
      // allowPrivateNetwork: true, // legacy alias
      // hostnameAllowlist: ["*.example.com", "example.com"],
      // allowedHostnames: ["localhost"],
    },
    tabCleanup: {
      enabled: true,
      idleMinutes: 120,
      maxTabsPerSession: 8,
      sweepMinutes: 5,
    },
    profiles: {
      openclaw: { cdpPort: 18800, color: "#FF4500" },
      work: {
        cdpPort: 18801,
        color: "#0066CC",
        executablePath: "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
      },
      user: { driver: "existing-session", attachOnly: true, color: "#00AA00" },
      brave: {
        driver: "existing-session",
        attachOnly: true,
        userDataDir: "~/Library/Application Support/BraveSoftware/Brave-Browser",
        color: "#FB542B",
      },
      remote: { cdpUrl: "http://10.0.0.42:9222", color: "#00AA00" },
    },
    color: "#FF4500",
    // headless: false,
    // noSandbox: false,
    // extraArgs: [],
    // executablePath: "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser",
    // attachOnly: false,
  },
}

• evaluateEnabled: false 会禁用 act:evaluate 和 wait --fn。
• tabCleanup 会在空闲超时后，或当某个 会话超过其上限时，回收已跟踪的主智能体标签页。将 idleMinutes: 0 或 maxTabsPerSession: 0 设为 0，可分别禁用这些单独的清理模式。
• ssrfPolicy.dangerouslyAllowPrivateNetwork 在未设置时为禁用状态，因此浏览器导航默认保持严格模式。
• 仅当你明确信任私有网络浏览器导航时，才设置 ssrfPolicy.dangerouslyAllowPrivateNetwork: true。
• 在严格模式下，远程 CDP 配置文件端点（profiles.*.cdpUrl）在可达性/发现检查期间同样会受到私有网络拦截限制。
• ssrfPolicy.allowPrivateNetwork 仍作为旧版别名受支持。
• 在严格模式下，使用 ssrfPolicy.hostnameAllowlist 和 ssrfPolicy.allowedHostnames 来配置显式例外。
• 远程配置文件仅支持附加模式（禁用 start/stop/reset）。
• profiles.*.cdpUrl 接受 http://、https://、ws:// 和 wss://。 当你希望 OpenClaw 发现 /json/version 时，使用 HTTP(S)；使用 WS(S) 则适用于你的提供商直接给出 DevTools WebSocket URL 的情况。
• remoteCdpTimeoutMs 和 remoteCdpHandshakeTimeoutMs 适用于远程和 attachOnly CDP 的可达性检查，以及标签页打开请求。受管的 local loopback 配置文件则继续使用本地 CDP 默认值。
• 如果某个外部管理的 CDP 服务可通过 loopback 访问，请将该 配置文件的 attachOnly: true 打开；否则 OpenClaw 会将该 loopback 端口视为 本地受管浏览器配置文件，并可能报告本地端口所有权错误。
• existing-session 配置文件使用 Chrome MCP 而不是 CDP，并且可以附加到 所选主机上，或通过已连接的浏览器节点附加。
• existing-session 配置文件可以设置 userDataDir，以指向特定的 基于 Chromium 的浏览器配置文件，例如 Brave 或 Edge。
• existing-session 配置文件保留当前 Chrome MCP 路由限制： 使用 snapshot/ref 驱动的操作，而不是 CSS 选择器定位；单文件上传 钩子；不支持对话框超时覆盖；不支持 wait --load networkidle；也不支持 responsebody、PDF 导出、下载拦截或批量操作。
• 本地受管的 openclaw 配置文件会自动分配 cdpPort 和 cdpUrl；仅在远程 CDP 场景下 才需要显式设置 cdpUrl。
• 本地受管配置文件可以设置 executablePath 来覆盖该配置文件的全局 browser.executablePath。可用它让一个配置文件运行在 Chrome 中，另一个运行在 Brave 中。
• 本地受管配置文件在进程启动后使用 browser.localLaunchTimeoutMs 进行 Chrome CDP HTTP 发现，并使用 browser.localCdpReadyTimeoutMs 检查 启动后 CDP websocket 是否就绪。对于 Chrome 虽能成功启动但就绪检查与启动过程发生竞争的较慢主机，请调高这两个值。两个值都必须是 不超过 120000 ms 的正整数；无效配置值会被拒绝。
• 自动检测顺序：默认浏览器（如果基于 Chromium）→ Chrome → Brave → Edge → Chromium → Chrome Canary。
• browser.executablePath 和 browser.profiles.<name>.executablePath 都 支持在 Chromium 启动前将 ~ 和 ~/... 解析为你的操作系统主目录。 existing-session 配置文件中的每个配置文件 userDataDir 也支持波浪线展开。
• Control 服务：仅 loopback（端口派生自 gateway.port，默认 18791）。
• extraArgs 会将额外启动标志追加到本地 Chromium 启动命令中（例如 --disable-gpu、窗口大小设置或调试标志）。

​

UI

{
  ui: {
    seamColor: "#FF4500",
    assistant: {
      name: "OpenClaw",
      avatar: "CB", // emoji, short text, image URL, or data URI
    },
  },
}

• seamColor：原生应用 UI 外观的强调色（Talk 模式气泡着色等）。
• assistant：Control UI 身份覆盖。未设置时回退到当前活动智能体身份。

​

Gateway 网关

{
  gateway: {
    mode: "local", // local | remote
    port: 18789,
    bind: "loopback",
    auth: {
      mode: "token", // none | token | password | trusted-proxy
      token: "your-token",
      // password: "your-password", // or OPENCLAW_GATEWAY_PASSWORD
      // trustedProxy: { userHeader: "x-forwarded-user" }, // for mode=trusted-proxy; see /gateway/trusted-proxy-auth
      allowTailscale: true,
      rateLimit: {
        maxAttempts: 10,
        windowMs: 60000,
        lockoutMs: 300000,
        exemptLoopback: true,
      },
    },
    tailscale: {
      mode: "off", // off | serve | funnel
      resetOnExit: false,
    },
    controlUi: {
      enabled: true,
      basePath: "/openclaw",
      // root: "dist/control-ui",
      // embedSandbox: "scripts", // strict | scripts | trusted
      // allowExternalEmbedUrls: false, // dangerous: allow absolute external http(s) embed URLs
      // allowedOrigins: ["https://control.example.com"], // required for non-loopback Control UI
      // dangerouslyAllowHostHeaderOriginFallback: false, // dangerous Host-header origin fallback mode
      // allowInsecureAuth: false,
      // dangerouslyDisableDeviceAuth: false,
    },
    remote: {
      url: "ws://gateway.tailnet:18789",
      transport: "ssh", // ssh | direct
      token: "your-token",
      // password: "your-password",
    },
    trustedProxies: ["10.0.0.1"],
    // Optional. Default false.
    allowRealIpFallback: false,
    nodes: {
      pairing: {
        // Optional. Default unset/disabled.
        autoApproveCidrs: ["192.168.1.0/24", "fd00:1234:5678::/64"],
      },
      allowCommands: ["canvas.navigate"],
      denyCommands: ["system.run"],
    },
    tools: {
      // Additional /tools/invoke HTTP denies
      deny: ["browser"],
      // Remove tools from the default HTTP deny list
      allow: ["gateway"],
    },
    push: {
      apns: {
        relay: {
          baseUrl: "https://relay.example.com",
          timeoutMs: 10000,
        },
      },
    },
  },
}

​

OpenAI 兼容端点

• Chat Completions：默认禁用。通过 gateway.http.endpoints.chatCompletions.enabled: true 启用。
• Responses API：gateway.http.endpoints.responses.enabled。
• Responses URL 输入加固：
  • gateway.http.endpoints.responses.maxUrlParts
  • gateway.http.endpoints.responses.files.urlAllowlist
  • gateway.http.endpoints.responses.images.urlAllowlist 空允许列表会被视为未设置；请使用 gateway.http.endpoints.responses.files.allowUrl=false 和/或 gateway.http.endpoints.responses.images.allowUrl=false 来禁用 URL 抓取。
• 可选响应加固头：
  • gateway.http.securityHeaders.strictTransportSecurity（仅对你控制的 HTTPS 源设置；参见 Trusted Proxy Auth）

​

多实例隔离

OPENCLAW_CONFIG_PATH=~/.openclaw/a.json \
OPENCLAW_STATE_DIR=~/.openclaw-a \
openclaw gateway --port 19001

​

gateway.tls

{
  gateway: {
    tls: {
      enabled: false,
      autoGenerate: false,
      certPath: "/etc/openclaw/tls/server.crt",
      keyPath: "/etc/openclaw/tls/server.key",
      caPath: "/etc/openclaw/tls/ca-bundle.crt",
    },
  },
}

• enabled：在 Gateway 网关监听器处启用 TLS 终止（HTTPS/WSS）（默认：false）。
• autoGenerate：当未配置显式文件时，自动生成本地自签名证书/密钥对；仅适用于本地/开发环境。
• certPath：TLS 证书文件的文件系统路径。
• keyPath：TLS 私钥文件的文件系统路径；应限制权限。
• caPath：可选的 CA bundle 路径，用于客户端验证或自定义信任链。

​

gateway.reload

{
  gateway: {
    reload: {
      mode: "hybrid", // off | restart | hot | hybrid
      debounceMs: 500,
      deferralTimeoutMs: 0,
    },
  },
}

• mode：控制在运行时如何应用配置编辑。
  • "off"：忽略实时编辑；更改需要显式重启。
  • "restart"：配置变更时始终重启 Gateway 网关进程。
  • "hot"：在不重启的情况下于进程内应用更改。
  • "hybrid"（默认）：先尝试热重载；如有需要则回退为重启。
• debounceMs：应用配置变更前的防抖窗口，单位为毫秒（非负整数）。
• deferralTimeoutMs：可选的最大等待时间，单位为毫秒，用于等待正在进行的操作完成后再强制重启。省略此项或设为 0 表示无限等待，并定期记录仍在等待中的警告。

​

Hooks

{
  hooks: {
    enabled: true,
    token: "shared-secret",
    path: "/hooks",
    maxBodyBytes: 262144,
    defaultSessionKey: "hook:ingress",
    allowRequestSessionKey: true,
    allowedSessionKeyPrefixes: ["hook:", "hook:gmail:"],
    allowedAgentIds: ["hooks", "main"],
    presets: ["gmail"],
    transformsDir: "~/.openclaw/hooks/transforms",
    mappings: [
      {
        match: { path: "gmail" },
        action: "agent",
        agentId: "hooks",
        wakeMode: "now",
        name: "Gmail",
        sessionKey: "hook:gmail:{{messages[0].id}}",
        messageTemplate: "From: {{messages[0].from}}\nSubject: {{messages[0].subject}}\n{{messages[0].snippet}}",
        deliver: true,
        channel: "last",
        model: "openai/gpt-5.4-mini",
      },
    ],
  },
}

• hooks.enabled=true 要求提供非空的 hooks.token。
• hooks.token 必须与 gateway.auth.token 不同；重复使用 Gateway 网关 token 会被拒绝。
• hooks.path 不能为 /；请使用专用子路径，例如 /hooks。
• 如果 hooks.allowRequestSessionKey=true，请限制 hooks.allowedSessionKeyPrefixes（例如 ["hook:"]）。
• 如果某个 mapping 或 preset 使用模板化的 sessionKey，请设置 hooks.allowedSessionKeyPrefixes 和 hooks.allowRequestSessionKey=true。静态 mapping 键不需要这个显式启用。

• POST /hooks/wake → { text, mode?: "now"|"next-heartbeat" }
• POST /hooks/agent → { message, name?, agentId?, sessionKey?, wakeMode?, deliver?, channel?, to?, model?, thinking?, timeoutSeconds? }
  • 仅当 hooks.allowRequestSessionKey=true 时，才接受请求负载中的 sessionKey（默认：false）。
• POST /hooks/<name> → 通过 hooks.mappings 解析
  • 模板渲染后的映射 sessionKey 值会被视为外部提供，因此也要求 hooks.allowRequestSessionKey=true。

​

Gmail 集成

• 内置 Gmail preset 使用 sessionKey: "hook:gmail:{{messages[0].id}}"。
• 如果你保留这种按消息路由的方式，请设置 hooks.allowRequestSessionKey: true，并限制 hooks.allowedSessionKeyPrefixes 以匹配 Gmail 命名空间，例如 ["hook:", "hook:gmail:"]。
• 如果你需要 hooks.allowRequestSessionKey: false，请用静态 sessionKey 覆盖该 preset，而不是使用模板化默认值。

{
  hooks: {
    gmail: {
      account: "openclaw@gmail.com",
      topic: "projects/<project-id>/topics/gog-gmail-watch",
      subscription: "gog-gmail-watch-push",
      pushToken: "shared-push-token",
      hookUrl: "http://127.0.0.1:18789/hooks/gmail",
      includeBody: true,
      maxBytes: 20000,
      renewEveryMinutes: 720,
      serve: { bind: "127.0.0.1", port: 8788, path: "/" },
      tailscale: { mode: "funnel", path: "/gmail-pubsub" },
      model: "openrouter/meta-llama/llama-3.3-70b-instruct:free",
      thinking: "off",
    },
  },
}

• 配置后，Gateway 网关会在启动时自动启动 gog gmail watch serve。设置 OPENCLAW_SKIP_GMAIL_WATCHER=1 可禁用。
• 不要在 Gateway 网关旁边额外运行单独的 gog gmail watch serve。

​

Canvas 主机

{
  canvasHost: {
    root: "~/.openclaw/workspace/canvas",
    liveReload: true,
    // enabled: false, // or OPENCLAW_SKIP_CANVAS_HOST=1
  },
}

• 在 Gateway 网关端口下通过 HTTP 提供可由智能体编辑的 HTML/CSS/JS 和 A2UI：
  • http://<gateway-host>:<gateway.port>/__openclaw__/canvas/
  • http://<gateway-host>:<gateway.port>/__openclaw__/a2ui/
• 仅限本地：保持 gateway.bind: "loopback"（默认）。
• 非 loopback bind：canvas 路由与其他 Gateway 网关 HTTP 面一样，要求 Gateway 网关认证（token/password/trusted-proxy）。
• 节点 WebView 通常不会发送认证头；在节点完成配对并连接后，Gateway 网关会为 canvas/A2UI 访问广播节点作用域能力 URL。
• 能力 URL 会绑定到当前活动的节点 WS 会话，并且会很快过期。不使用基于 IP 的回退。
• 会向提供的 HTML 注入实时重载客户端。
• 为空时会自动创建起始 index.html。
• 也会在 /__openclaw__/a2ui/ 提供 A2UI。
• 更改需要重启 Gateway 网关。
• 对于大型目录或出现 EMFILE 错误时，请禁用实时重载。

​

设备发现

​

mDNS（Bonjour）

{
  discovery: {
    mdns: {
      mode: "minimal", // minimal | full | off
    },
  },
}

• minimal（默认）：从 TXT 记录中省略 cliPath + sshPort。
• full：包含 cliPath + sshPort。
• 主机名默认为 openclaw。可通过 OPENCLAW_MDNS_HOSTNAME 覆盖。

​

广域（DNS-SD）

{
  discovery: {
    wideArea: { enabled: true },
  },
}

​

环境

​

env（内联环境变量）

{
  env: {
    OPENROUTER_API_KEY: "sk-or-...",
    vars: {
      GROQ_API_KEY: "gsk-...",
    },
    shellEnv: {
      enabled: true,
      timeoutMs: 15000,
    },
  },
}

• 只有在进程环境中缺少该键时，才会应用内联环境变量。
• .env 文件：当前工作目录 .env + ~/.openclaw/.env（二者都不会覆盖已有变量）。
• shellEnv：从你的登录 shell 配置文件中导入缺失的预期键名。
• 完整优先级请参见 Environment。

​

环境变量替换

{
  gateway: {
    auth: { token: "${OPENCLAW_GATEWAY_TOKEN}" },
  },
}

• 仅匹配大写名称：[A-Z_][A-Z0-9_]*。
• 缺失/为空的变量会在配置加载时抛出错误。
• 使用 $${VAR} 转义，以表示字面量 ${VAR}。
• 对 $include 同样有效。

​

Secrets

​

SecretRef

{ source: "env" | "file" | "exec", provider: "default", id: "..." }

• provider 模式：^[a-z][a-z0-9_-]{0,63}$
• source: "env" 的 id 模式：^[A-Z][A-Z0-9_]{0,127}$
• source: "file" 的 id：绝对 JSON pointer（例如 "/providers/openai/apiKey"）
• source: "exec" 的 id 模式：^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$
• source: "exec" 的 id 不能包含 . 或 .. 这样的斜杠分隔路径段（例如 a/../b 会被拒绝）

​

支持的凭据范围

• 规范矩阵：SecretRef Credential Surface
• secrets apply 会作用于受支持的 openclaw.json 凭据路径。
• auth-profiles.json 中的 refs 也纳入运行时解析和审计覆盖范围。

​

Secret 提供商配置

{
  secrets: {
    providers: {
      default: { source: "env" }, // optional explicit env provider
      filemain: {
        source: "file",
        path: "~/.openclaw/secrets.json",
        mode: "json",
        timeoutMs: 5000,
      },
      vault: {
        source: "exec",
        command: "/usr/local/bin/openclaw-vault-resolver",
        passEnv: ["PATH", "VAULT_ADDR"],
      },
    },
    defaults: {
      env: "default",
      file: "filemain",
      exec: "vault",
    },
  },
}

• file 提供商支持 mode: "json" 和 mode: "singleValue"（在 singleValue 模式下，id 必须是 "value"）。
• 当 Windows ACL 验证不可用时，文件和 exec 提供商路径会以关闭方式失败。仅对无法验证但受信任的路径设置 allowInsecurePath: true。
• exec 提供商要求 command 使用绝对路径，并通过 stdin/stdout 上传协议负载。
• 默认情况下，符号链接命令路径会被拒绝。设置 allowSymlinkCommand: true 可允许符号链接路径，同时仍验证解析后的目标路径。
• 如果配置了 trustedDirs，则受信任目录检查会应用于解析后的目标路径。
• 默认情况下，exec 子进程环境极简；请通过 passEnv 显式传入所需变量。
• Secret refs 会在激活时解析为内存中的快照，之后请求路径只读取该快照。
• 激活期间会应用活动表面过滤：已启用表面上的未解析 refs 会导致启动/重载失败，而非活动表面会被跳过并记录诊断信息。

​

认证存储

{
  auth: {
    profiles: {
      "anthropic:default": { provider: "anthropic", mode: "api_key" },
      "anthropic:work": { provider: "anthropic", mode: "api_key" },
      "openai-codex:personal": { provider: "openai-codex", mode: "oauth" },
    },
    order: {
      anthropic: ["anthropic:default", "anthropic:work"],
      "openai-codex": ["openai-codex:personal"],
    },
  },
}

• 每个智能体的 profile 存储在 <agentDir>/auth-profiles.json。
• auth-profiles.json 支持值级 refs（api_key 使用 keyRef，token 使用 tokenRef）以支持静态凭据模式。
• OAuth 模式 profile（auth.profiles.<id>.mode = "oauth"）不支持由 SecretRef 支持的 auth-profile 凭据。
• 静态运行时凭据来自内存中已解析的快照；发现旧版静态 auth.json 条目时会清理。
• 旧版 OAuth 会从 ~/.openclaw/credentials/oauth.json 导入。
• 请参见 OAuth。
• Secrets 运行时行为及 audit/configure/apply 工具：请参见 Secrets Management。

​

auth.cooldowns

{
  auth: {
    cooldowns: {
      billingBackoffHours: 5,
      billingBackoffHoursByProvider: { anthropic: 3, openai: 8 },
      billingMaxHours: 24,
      authPermanentBackoffMinutes: 10,
      authPermanentMaxMinutes: 60,
      failureWindowHours: 24,
      overloadedProfileRotations: 1,
      overloadedBackoffMs: 0,
      rateLimitedProfileRotations: 1,
    },
  },
}

• billingBackoffHours：当某个 profile 因真实 计费/余额不足错误失败时，使用的基础退避时间（小时）（默认：5）。即使在 401/403 响应上， 明确的计费文本仍可能落入这里，但特定提供商的文本 匹配器仍只作用于拥有它们的提供商（例如 OpenRouter Key limit exceeded）。可重试的 HTTP 402 使用窗口或 organization/workspace 支出限制消息则仍归入 rate_limit 路径。
• billingBackoffHoursByProvider：按提供商覆盖计费退避小时数的可选配置。
• billingMaxHours：计费退避指数增长的上限小时数（默认：24）。
• authPermanentBackoffMinutes：高置信度 auth_permanent 失败的基础退避时间（分钟）（默认：10）。
• authPermanentMaxMinutes：auth_permanent 退避增长的上限分钟数（默认：60）。
• failureWindowHours：用于退避计数器的滚动时间窗口（小时）（默认：24）。
• overloadedProfileRotations：对过载错误，在切换到模型回退之前，同一提供商 auth-profile 允许的最大轮换次数（默认：1）。像 ModelNotReadyException 这样的提供商繁忙形态也归入这里。
• overloadedBackoffMs：在重试过载的提供商/profile 轮换前的固定延迟（默认：0）。
• rateLimitedProfileRotations：对速率限制错误，在切换到模型回退之前，同一提供商 auth-profile 允许的最大轮换次数（默认：1）。该速率限制桶包括诸如 Too many concurrent requests、ThrottlingException、concurrency limit reached、workers_ai ... quota limit exceeded 和 resource exhausted 之类带有提供商特征的文本。

​

日志

{
  logging: {
    level: "info",
    file: "/tmp/openclaw/openclaw.log",
    consoleLevel: "info",
    consoleStyle: "pretty", // pretty | compact | json
    redactSensitive: "tools", // off | tools
    redactPatterns: ["\\bTOKEN\\b\\s*[=:]\\s*([\"']?)([^\\s\"']+)\\1"],
  },
}

• 默认日志文件：/tmp/openclaw/openclaw-YYYY-MM-DD.log。
• 设置 logging.file 可使用固定路径。
• 使用 --verbose 时，consoleLevel 会提升为 debug。
• maxFileBytes：轮转前活动日志文件的最大大小（字节）（正整数；默认：104857600 = 100 MB）。OpenClaw 会在活动文件旁边保留最多五个带编号的归档文件。
• redactSensitive / redactPatterns：对控制台输出、文件日志、OTLP 日志记录以及持久化会话转录文本进行尽力脱敏。

​

诊断

{
  diagnostics: {
    enabled: true,
    flags: ["telegram.*"],
    stuckSessionWarnMs: 30000,

    otel: {
      enabled: false,
      endpoint: "https://otel-collector.example.com:4318",
      tracesEndpoint: "https://traces.example.com/v1/traces",
      metricsEndpoint: "https://metrics.example.com/v1/metrics",
      logsEndpoint: "https://logs.example.com/v1/logs",
      protocol: "http/protobuf", // http/protobuf | grpc
      headers: { "x-tenant-id": "my-org" },
      serviceName: "openclaw-gateway",
      traces: true,
      metrics: true,
      logs: false,
      sampleRate: 1.0,
      flushIntervalMs: 5000,
      captureContent: {
        enabled: false,
        inputMessages: false,
        outputMessages: false,
        toolInputs: false,
        toolOutputs: false,
        systemPrompt: false,
      },
    },

    cacheTrace: {
      enabled: false,
      filePath: "~/.openclaw/logs/cache-trace.jsonl",
      includeMessages: true,
      includePrompt: true,
      includeSystem: true,
    },
  },
}

• enabled：仪表数据输出总开关（默认：true）。
• flags：用于启用定向日志输出的标志字符串数组（支持如 "telegram.*" 或 "*" 这样的通配符）。
• stuckSessionWarnMs：当会话仍处于处理中状态时，用于发出卡住会话警告的年龄阈值（毫秒）。
• otel.enabled：启用 OpenTelemetry 导出管线（默认：false）。完整配置、信号目录和隐私模型请参见 OpenTelemetry export。
• otel.endpoint：用于 OTel 导出的收集器 URL。
• otel.tracesEndpoint / otel.metricsEndpoint / otel.logsEndpoint：可选的按信号划分的 OTLP 端点。设置后，它们只会对对应信号覆盖 otel.endpoint。
• otel.protocol："http/protobuf"（默认）或 "grpc"。
• otel.headers：随 OTel 导出请求发送的额外 HTTP/gRPC 元数据头。
• otel.serviceName：资源属性中的服务名称。
• otel.traces / otel.metrics / otel.logs：启用 trace、metrics 或 log 导出。
• otel.sampleRate：trace 采样率 0–1。
• otel.flushIntervalMs：周期性遥测刷新间隔（毫秒）。
• otel.captureContent：选择启用用于 OTEL span 属性的原始内容捕获。默认关闭。布尔值 true 会捕获非系统消息/工具内容；对象形式则可让你显式启用 inputMessages、outputMessages、toolInputs、toolOutputs 和 systemPrompt。
• OTEL_SEMCONV_STABILITY_OPT_IN=gen_ai_latest_experimental：用于启用最新实验性 GenAI span 提供商属性的环境变量开关。默认情况下，span 会保留旧版 gen_ai.system 属性以保持兼容；GenAI metrics 使用有界语义属性。
• OPENCLAW_OTEL_PRELOADED=1：适用于已注册全局 OpenTelemetry SDK 的主机的环境变量开关。此时 OpenClaw 会跳过由插件负责的 SDK 启动/关闭，同时保持诊断监听器处于活动状态。
• OTEL_EXPORTER_OTLP_TRACES_ENDPOINT、OTEL_EXPORTER_OTLP_METRICS_ENDPOINT 和 OTEL_EXPORTER_OTLP_LOGS_ENDPOINT：当对应配置键未设置时使用的按信号划分端点环境变量。
• cacheTrace.enabled：记录内嵌运行的缓存跟踪快照（默认：false）。
• cacheTrace.filePath：缓存跟踪 JSONL 的输出路径（默认：$OPENCLAW_STATE_DIR/logs/cache-trace.jsonl）。
• cacheTrace.includeMessages / includePrompt / includeSystem：控制缓存跟踪输出中包含的内容（默认全部为 true）。

​

更新

{
  update: {
    channel: "stable", // stable | beta | dev
    checkOnStart: true,

    auto: {
      enabled: false,
      stableDelayHours: 6,
      stableJitterHours: 12,
      betaCheckIntervalHours: 1,
    },
  },
}

• channel：用于 npm/git 安装的发布渠道 —— "stable"、"beta" 或 "dev"。
• checkOnStart：Gateway 网关启动时检查 npm 更新（默认：true）。
• auto.enabled：为包安装启用后台自动更新（默认：false）。
• auto.stableDelayHours：稳定渠道自动应用前的最小时延（小时）（默认：6；最大：168）。
• auto.stableJitterHours：稳定渠道发布扩散窗口的额外小时数（默认：12；最大：168）。
• auto.betaCheckIntervalHours：beta 渠道检查运行频率（小时）（默认：1；最大：24）。

​

ACP

{
  acp: {
    enabled: true,
    dispatch: { enabled: true },
    backend: "acpx",
    defaultAgent: "main",
    allowedAgents: ["main", "ops"],
    maxConcurrentSessions: 10,

    stream: {
      coalesceIdleMs: 50,
      maxChunkChars: 1000,
      repeatSuppression: true,
      deliveryMode: "live", // live | final_only
      hiddenBoundarySeparator: "paragraph", // none | space | newline | paragraph
      maxOutputChars: 50000,
      maxSessionUpdateChars: 500,
    },

    runtime: {
      ttlMinutes: 30,
    },
  },
}

• enabled：全局 ACP 功能门控（默认：true；设为 false 会隐藏 ACP 分发和 spawn 入口）。
• dispatch.enabled：ACP 会话轮次分发的独立门控（默认：true）。设为 false 可保留 ACP 命令可用，同时阻止执行。
• backend：默认 ACP 运行时后端 id（必须匹配已注册的 ACP 运行时插件）。 如果设置了 plugins.allow，请包含后端插件 id（例如 acpx），否则内置默认插件将不会加载。
• defaultAgent：当 spawn 未指定显式目标时使用的 ACP 回退目标智能体 id。
• allowedAgents：允许用于 ACP 运行时会话的智能体 id 允许列表；为空表示没有额外限制。
• maxConcurrentSessions：同时处于活动状态的 ACP 会话最大数量。
• stream.coalesceIdleMs：流式文本的空闲合并刷新窗口（毫秒）。
• stream.maxChunkChars：在拆分流式分块投影前的最大块大小。
• stream.repeatSuppression：每轮抑制重复的状态/工具行（默认：true）。
• stream.deliveryMode："live" 表示增量流式传输；"final_only" 表示缓冲到轮次终止事件后再输出。
• stream.hiddenBoundarySeparator：隐藏工具事件后、可见文本前的分隔符（默认："paragraph"）。
• stream.maxOutputChars：每个 ACP 轮次投影的智能体输出最大字符数。
• stream.maxSessionUpdateChars：投影 ACP 状态/更新行的最大字符数。
• stream.tagVisibility：tag 名称到布尔可见性覆盖的记录，用于流式事件。
• runtime.ttlMinutes：ACP 会话工作进程在可被清理前的空闲 TTL（分钟）。
• runtime.installCommand：可选安装命令，用于引导 ACP 运行时环境。

​

CLI

{
  cli: {
    banner: {
      taglineMode: "off", // random | default | off
    },
  },
}

• cli.banner.taglineMode 控制横幅标语样式：
  • "random"（默认）：轮换的有趣/季节性标语。
  • "default"：固定中性标语（All your chats, one OpenClaw.）。
  • "off"：不显示标语文本（仍显示横幅标题/版本）。
• 若要隐藏整个横幅（而不仅是标语），请设置环境变量 OPENCLAW_HIDE_BANNER=1。

​

向导

{
  wizard: {
    lastRunAt: "2026-01-01T00:00:00.000Z",
    lastRunVersion: "2026.1.4",
    lastRunCommit: "abc1234",
    lastRunCommand: "configure",
    lastRunMode: "local",
  },
}

​

身份

​

Bridge protocol（旧版节点，历史参考）（旧版，已移除）

{
  "bridge": {
    "enabled": true,
    "port": 18790,
    "bind": "tailnet",
    "tls": {
      "enabled": true,
      "autoGenerate": true
    }
  }
}

​

Cron

{
  cron: {
    enabled: true,
    maxConcurrentRuns: 2, // cron dispatch + isolated cron agent-turn execution
    webhook: "https://example.invalid/legacy", // deprecated fallback for stored notify:true jobs
    webhookToken: "replace-with-dedicated-token", // optional bearer token for outbound webhook auth
    sessionRetention: "24h", // duration string or false
    runLog: {
      maxBytes: "2mb", // default 2_000_000 bytes
      keepLines: 2000, // default 2000
    },
  },
}

• sessionRetention：在从 sessions.json 中裁剪前，已完成隔离 cron 运行会话的保留时长。也控制已归档的已删除 cron 转录的清理。默认：24h；设为 false 可禁用。
• runLog.maxBytes：每个运行日志文件（cron/runs/<jobId>.jsonl）在裁剪前的最大大小。默认：2_000_000 字节。
• runLog.keepLines：触发运行日志裁剪时保留的最新行数。默认：2000。
• webhookToken：用于 cron webhook POST 投递（delivery.mode = "webhook"）的 bearer token；如果省略则不会发送认证头。
• webhook：已弃用的旧版回退 webhook URL（http/https），仅用于仍带有 notify: true 的已存储作业。

​

cron.retry

{
  cron: {
    retry: {
      maxAttempts: 3,
      backoffMs: [30000, 60000, 300000],
      retryOn: ["rate_limit", "overloaded", "network", "timeout", "server_error"],
    },
  },
}

• maxAttempts：一次性作业在瞬时错误下的最大重试次数（默认：3；范围：0–10）。
• backoffMs：每次重试尝试使用的退避延迟数组（毫秒）（默认：[30000, 60000, 300000]；1–10 个条目）。
• retryOn：触发重试的错误类型 —— "rate_limit"、"overloaded"、"network"、"timeout"、"server_error"。省略则会对所有瞬时类型进行重试。

​

cron.failureAlert

{
  cron: {
    failureAlert: {
      enabled: false,
      after: 3,
      cooldownMs: 3600000,
      includeSkipped: false,
      mode: "announce",
      accountId: "main",
    },
  },
}

• enabled：为 cron 作业启用失败告警（默认：false）。
• after：触发告警前允许的连续失败次数（正整数，最小值：1）。
• cooldownMs：同一作业重复告警之间的最小间隔（毫秒）（非负整数）。
• includeSkipped：是否将连续跳过的运行计入告警阈值（默认：false）。跳过的运行会单独跟踪，不影响执行错误退避。
• mode：投递模式 —— "announce" 通过渠道消息发送；"webhook" 发送到已配置的 webhook。
• accountId：可选的账号或渠道 id，用于限定告警投递范围。

​

cron.failureDestination

{
  cron: {
    failureDestination: {
      mode: "announce",
      channel: "last",
      to: "channel:C1234567890",
      accountId: "main",
    },
  },
}

• 所有作业共用的默认 cron 失败通知目标。
• mode："announce" 或 "webhook"；当存在足够的目标数据时，默认值为 "announce"。
• channel：announce 投递的渠道覆盖值。"last" 会复用最后一次已知投递渠道。
• to：显式 announce 目标或 webhook URL。webhook 模式下为必填。
• accountId：可选的投递账号覆盖值。
• 每个作业的 delivery.failureDestination 会覆盖这个全局默认值。
• 当全局和每个作业的失败目标都未设置时，那些已经通过 announce 投递的作业会在失败时回退到其主 announce 目标。
• delivery.failureDestination 仅支持 sessionTarget="isolated" 的作业，除非该作业的主 delivery.mode 为 "webhook"。

​

媒体模型模板变量

​

配置 include（$include）

// ~/.openclaw/openclaw.json
{
  gateway: { port: 18789 },
  agents: { $include: "./agents.json5" },
  broadcast: {
    $include: ["./clients/mueller.json5", "./clients/schmidt.json5"],
  },
}

• 单个文件：替换其所在的容器对象。
• 文件数组：按顺序深度合并（后者覆盖前者）。
• 同级键：在 includes 之后合并（覆盖 include 的值）。
• 嵌套 includes：最多支持 10 层深度。
• 路径：相对于发起 include 的文件解析，但必须保持在顶层配置目录（openclaw.json 的 dirname）内。只有在最终仍解析到该边界内时，才允许使用绝对路径或 ../ 形式。
• 只变更某一个由单文件 include 支撑的顶层分区时，由 OpenClaw 负责的写入会直接写回该 include 文件。例如，plugins install 会把 plugins: { $include: "./plugins.json5" } 的更新写入 plugins.json5，并保持 openclaw.json 不变。
• 根级 include、include 数组以及带同级覆盖的 include 对于由 OpenClaw 负责的写入都是只读的；这些写入会以关闭方式失败，而不会将配置拍平。
• 错误：对缺失文件、解析错误和循环 include 提供清晰的报错信息。

​

相关

• Configuration
• Configuration examples