From 5f98dfdf6a8dfc5fc2e766664b963528d0acdf33 Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Sat, 11 Apr 2026 12:42:19 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/gateway/configuration-reference.md | 1389 +++++++++-------- docs/zh-CN/reference/rich-output-protocol.md | 60 + 2 files changed, 761 insertions(+), 688 deletions(-) create mode 100644 docs/zh-CN/reference/rich-output-protocol.md diff --git a/docs/zh-CN/gateway/configuration-reference.md b/docs/zh-CN/gateway/configuration-reference.md index 4dcdd8649..4837bfa63 100644 --- a/docs/zh-CN/gateway/configuration-reference.md +++ b/docs/zh-CN/gateway/configuration-reference.md @@ -1,70 +1,70 @@ --- read_when: - 你需要精确到字段级别的配置语义或默认值 - - 你正在验证渠道、模型、Gateway 网关或工具配置块】【。 -summary: Gateway 网关配置参考，涵盖 OpenClaw 核心键名、默认值以及指向各专用子系统参考文档的链接 + - 你正在验证渠道、模型、Gateway 网关或工具配置块 +summary: Gateway 网关 配置参考，涵盖核心 OpenClaw 键名、默认值，以及指向各专用子系统参考文档的链接 title: 配置参考 x-i18n: - generated_at: "2026-04-10T23:44:38Z" + generated_at: "2026-04-11T12:34:22Z" model: gpt-5.4 provider: openai - source_hash: 32acb82e756e4740d13ef12277842081f4c90df7b67850c34f8a76701fcd37d0 + source_hash: 351a245bed59d852ea8582e4e9fec5017a5c623cd6f0034766cdea1b5330be3c source_path: gateway/configuration-reference.md workflow: 15 --- # 配置参考 -`~/.openclaw/openclaw.json` 的核心配置参考。若需按任务组织的概览，请参见 [Configuration](/zh-CN/gateway/configuration)。 +`~/.openclaw/openclaw.json` 的核心配置参考。若需按任务组织的概览，请参阅 [Configuration](/zh-CN/gateway/configuration)。 -本页涵盖 OpenClaw 的主要配置面，并在某个子系统拥有更深入的独立参考时提供外链。它**不会**尝试在同一页内嵌每个渠道/插件自有的命令目录，也不会内嵌所有深层 memory/QMD 调节项。 +本页介绍 OpenClaw 的主要配置层面，并在某个子系统拥有独立的更深入参考时提供对应链接。它**不会**尝试在单个页面中内联展示每个渠道/插件自有的命令目录，或所有深层 memory/QMD 调节项。 -代码事实来源： +代码事实依据： -- `openclaw config schema` 会输出用于验证和 Control UI 的实时 JSON Schema，并在可用时合并内置/插件/渠道元数据 -- `config.schema.lookup` 会返回一个按路径限定范围的 schema 节点，供下钻工具使用 -- `pnpm config:docs:check` / `pnpm config:docs:gen` 会根据当前 schema 表面对配置文档基线哈希进行校验 +- `openclaw config schema` 会打印用于验证和 Control UI 的实时 JSON Schema，并在可用时合并内置/插件/渠道元数据 +- `config.schema.lookup` 返回单一路径范围的 schema 节点，供深入查看工具使用 +- `pnpm config:docs:check` / `pnpm config:docs:gen` 会根据当前 schema 表面校验配置文档基线哈希 -专用深度参考： +专门的深入参考： -- [Memory configuration reference](/zh-CN/reference/memory-config)，适用于 `agents.defaults.memorySearch.*`、`memory.qmd.*`、`memory.citations`，以及位于 `plugins.entries.memory-core.config.dreaming` 下的 dreaming 配置 -- [Slash Commands](/zh-CN/tools/slash-commands)，查看当前内置 + 内置插件命令目录 -- 各自所属的渠道/插件页面，用于查看特定渠道的命令面 +- [Memory configuration reference](/zh-CN/reference/memory-config) 用于 `agents.defaults.memorySearch.*`、`memory.qmd.*`、`memory.citations`，以及 `plugins.entries.memory-core.config.dreaming` 下的 dreaming 配置 +- [Slash Commands](/zh-CN/tools/slash-commands) 用于当前内置 + 内置插件命令目录 +- 对应渠道/插件页面，用于渠道特定的命令层面 -配置格式为 **JSON5**（允许注释和尾随逗号）。所有字段都是可选的——省略时，OpenClaw 会使用安全默认值。 +配置格式为 **JSON5**（允许注释和尾随逗号）。所有字段都是可选的 —— OpenClaw 在省略时会使用安全默认值。 --- ## 渠道 -每个渠道在其配置段存在时都会自动启动（除非设置了 `enabled: false`）。 +只要某个渠道的配置段存在，它就会自动启动（除非设置了 `enabled: false`）。 ### 私信和群组访问 所有渠道都支持私信策略和群组策略： -| 私信策略 | 行为 | -| ------------------- | -------------------------------------------- | -| `pairing`（默认） | 未知发送者会收到一次性配对码；所有者必须批准 | -| `allowlist` | 仅允许 `allowFrom` 中的发送者（或已配对允许存储中的发送者） | -| `open` | 允许所有入站私信（需要 `allowFrom: ["*"]`） | -| `disabled` | 忽略所有入站私信 | +| 私信策略 | 行为 | +| ------------------- | ------------------------------------------------ | +| `pairing`（默认） | 未知发送者会收到一次性配对码；需要 owner 批准 | +| `allowlist` | 仅允许 `allowFrom` 中的发送者（或已配对允许存储） | +| `open` | 允许所有入站私信（需要 `allowFrom: ["*"]`） | +| `disabled` | 忽略所有入站私信 | | 群组策略 | 行为 | | --------------------- | ---------------------------------------------- | -| `allowlist`（默认） | 仅允许与已配置允许列表匹配的群组 | -| `open` | 绕过群组允许列表（但仍会应用提及门控） | +| `allowlist`（默认） | 仅允许匹配已配置允许列表的群组 | +| `open` | 绕过群组允许列表（仍会应用提及门控） | | `disabled` | 阻止所有群组/房间消息 | -`channels.defaults.groupPolicy` 会在某个提供商的 `groupPolicy` 未设置时作为默认值。 +`channels.defaults.groupPolicy` 在提供商的 `groupPolicy` 未设置时作为默认值。 配对码会在 1 小时后过期。待处理的私信配对请求每个渠道最多 **3 个**。 -如果某个提供商配置块完全缺失（即不存在 `channels.`），运行时群组策略会回退为 `allowlist`（默认拒绝，失败关闭），并在启动时发出警告。 +如果某个提供商配置块完全缺失（`channels.` 不存在），运行时群组策略会回退到 `allowlist`（默认拒绝），并在启动时发出警告。 ### 渠道模型覆盖 -使用 `channels.modelByChannel` 可将特定渠道 ID 固定到某个模型。值可接受 `provider/model` 或已配置的模型别名。当某个会话尚未拥有模型覆盖时（例如通过 `/model` 设置），会应用该渠道映射。 +使用 `channels.modelByChannel` 可将特定渠道 ID 固定到某个模型。值可接受 `provider/model` 或已配置的模型别名。当某个会话尚未有模型覆盖时（例如通过 `/model` 设置），会应用该渠道映射。 ```json5 { @@ -87,7 +87,7 @@ x-i18n: ### 渠道默认值和心跳 -使用 `channels.defaults` 为各提供商设置共享的群组策略和心跳行为： +使用 `channels.defaults` 为各提供商共享群组策略和心跳行为： ```json5 { @@ -105,15 +105,15 @@ x-i18n: } ``` -- `channels.defaults.groupPolicy`：当提供商级别的 `groupPolicy` 未设置时使用的回退群组策略。 -- `channels.defaults.contextVisibility`：所有渠道的默认补充上下文可见性模式。可选值：`all`（默认，包含所有引用/线程/历史上下文）、`allowlist`（仅包含来自允许列表发送者的上下文）、`allowlist_quote`（与 allowlist 相同，但保留显式引用/回复上下文）。按渠道覆盖：`channels..contextVisibility`。 +- `channels.defaults.groupPolicy`：当提供商级别的 `groupPolicy` 未设置时的后备群组策略。 +- `channels.defaults.contextVisibility`：所有渠道的默认补充上下文可见性模式。取值：`all`（默认，包含所有引用/线程/历史上下文）、`allowlist`（仅包含来自允许列表发送者的上下文）、`allowlist_quote`（与 allowlist 相同，但保留显式引用/回复上下文）。每渠道覆盖：`channels..contextVisibility`。 - `channels.defaults.heartbeat.showOk`：在心跳输出中包含健康的渠道状态。 - `channels.defaults.heartbeat.showAlerts`：在心跳输出中包含降级/错误状态。 - `channels.defaults.heartbeat.useIndicator`：以紧凑的指示器样式渲染心跳输出。 ### WhatsApp -WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在已链接会话时，它会自动启动。 +WhatsApp 通过 Gateway 网关 的 web 渠道（Baileys Web）运行。存在已链接的会话时会自动启动。 ```json5 { @@ -124,7 +124,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 textChunkLimit: 4000, chunkMode: "length", // length | newline mediaMaxMb: 50, - sendReadReceipts: true, // 蓝色对勾（在 self-chat 模式下为 false） + sendReadReceipts: true, // 蓝色对勾（self-chat 模式下为 false） groups: { "*": { requireMention: true }, }, @@ -164,10 +164,10 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 } ``` -- 出站命令默认使用 `default` 账号（如果存在）；否则使用第一个已配置的账号 id（按排序顺序）。 -- 可选的 `channels.whatsapp.defaultAccount` 会在其匹配某个已配置账号 id 时，覆盖上述默认账号选择回退逻辑。 -- 旧版单账号 Baileys 认证目录会由 `openclaw doctor` 迁移到 `whatsapp/default`。 -- 按账号覆盖：`channels.whatsapp.accounts..sendReadReceipts`、`channels.whatsapp.accounts..dmPolicy`、`channels.whatsapp.accounts..allowFrom`。 +- 出站命令默认使用账号 `default`（如果存在）；否则使用第一个已配置的账号 id（排序后）。 +- 可选的 `channels.whatsapp.defaultAccount` 可在其匹配某个已配置账号 id 时，覆盖该后备默认账号选择。 +- 旧版单账号 Baileys 凭证目录会由 `openclaw doctor` 迁移到 `whatsapp/default`。 +- 每账号覆盖：`channels.whatsapp.accounts..sendReadReceipts`、`channels.whatsapp.accounts..dmPolicy`、`channels.whatsapp.accounts..allowFrom`。 @@ -202,7 +202,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 historyLimit: 50, replyToMode: "first", // off | first | all | batched linkPreview: true, - streaming: "partial", // off | partial | block | progress（默认：off；建议显式启用，以避免预览编辑速率限制） + streaming: "partial", // off | partial | block | progress（默认：off；需显式启用以避免预览编辑速率限制） actions: { reactions: true, sendMessage: true }, reactionNotifications: "own", // off | own | all mediaMaxMb: 100, @@ -225,12 +225,12 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 } ``` -- Bot token：`channels.telegram.botToken` 或 `channels.telegram.tokenFile`（仅允许普通文件；拒绝符号链接），默认账号还可回退为 `TELEGRAM_BOT_TOKEN`。 -- 可选的 `channels.telegram.defaultAccount` 会在其匹配某个已配置账号 id 时覆盖默认账号选择。 -- 在多账号配置（2 个及以上账号 id）中，请设置显式默认值（`channels.telegram.defaultAccount` 或 `channels.telegram.accounts.default`）以避免回退路由；如果缺失或无效，`openclaw doctor` 会发出警告。 +- Bot token：`channels.telegram.botToken` 或 `channels.telegram.tokenFile`（仅允许常规文件；拒绝符号链接），默认账号还可回退到 `TELEGRAM_BOT_TOKEN`。 +- 可选的 `channels.telegram.defaultAccount` 可在其匹配某个已配置账号 id 时覆盖默认账号选择。 +- 在多账号配置（2 个及以上账号 id）中，请设置显式默认值（`channels.telegram.defaultAccount` 或 `channels.telegram.accounts.default`）以避免回退路由；缺失或无效时，`openclaw doctor` 会发出警告。 - `configWrites: false` 会阻止由 Telegram 发起的配置写入（supergroup ID 迁移、`/config set|unset`）。 -- 顶层 `bindings[]` 中 `type: "acp"` 的条目用于为 forum topics 配置持久化 ACP 绑定（在 `match.peer.id` 中使用规范形式 `chatId:topic:topicId`）。字段语义与 [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings) 中一致。 -- Telegram 流式预览使用 `sendMessage` + `editMessageText`（在私聊和群聊中均可用）。 +- 顶层 `bindings[]` 中 `type: "acp"` 的条目用于为论坛话题配置持久 ACP 绑定（在 `match.peer.id` 中使用规范的 `chatId:topic:topicId`）。字段语义共享于 [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings)。 +- Telegram 流式预览使用 `sendMessage` + `editMessageText`（适用于私聊和群聊）。 - 重试策略：参见 [Retry policy](/zh-CN/concepts/retry)。 ### Discord @@ -286,7 +286,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 historyLimit: 20, textChunkLimit: 2000, chunkMode: "length", // length | newline - streaming: "off", // off | partial | block | progress（在 Discord 上，progress 会映射为 partial） + streaming: "off", // off | partial | block | progress（在 Discord 上 progress 会映射为 partial） maxLinesPerMessage: 17, ui: { components: { @@ -297,7 +297,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 enabled: true, idleHours: 24, maxAgeHours: 0, - spawnSubagentSessions: false, // 对 `sessions_spawn({ thread: true })` 的显式启用 + spawnSubagentSessions: false, // 为 sessions_spawn({ thread: true }) 显式启用 }, voice: { enabled: true, @@ -333,36 +333,36 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 } ``` -- Token：`channels.discord.token`，默认账号还可回退为 `DISCORD_BOT_TOKEN`。 -- 对于直接出站调用，如果显式提供了 Discord `token`，该次调用会使用该 token；但账号重试/策略设置仍来自活动运行时快照中所选账号。 -- 可选的 `channels.discord.defaultAccount` 会在其匹配某个已配置账号 id 时覆盖默认账号选择。 -- 投递目标请使用 `user:`（私信）或 `channel:`（guild 渠道）；裸数字 ID 会被拒绝。 -- Guild slug 使用小写，并将空格替换为 `-`；渠道键使用 slug 化后的名称（不带 `#`）。优先使用 guild ID。 -- 默认会忽略由 bot 自己创作的消息。`allowBots: true` 会启用它们；使用 `allowBots: "mentions"` 则只接受提及该 bot 的 bot 消息（自身消息仍会被过滤）。 -- `channels.discord.guilds..ignoreOtherMentions`（以及渠道级覆盖）会丢弃那些提及了其他用户或角色、但未提及该 bot 的消息（不包括 @everyone/@here）。 -- `maxLinesPerMessage`（默认 17）会拆分过高的消息，即使其长度未超过 2000 个字符。 +- Token：`channels.discord.token`，默认账号还可回退到 `DISCORD_BOT_TOKEN`。 +- 直接出站调用若显式提供 Discord `token`，该次调用会使用该 token；但账号重试/策略设置仍来自活动运行时快照中选定的账号。 +- 可选的 `channels.discord.defaultAccount` 可在其匹配某个已配置账号 id 时覆盖默认账号选择。 +- 交付目标请使用 `user:`（私信）或 `channel:`（guild 渠道）；裸数字 ID 会被拒绝。 +- Guild slug 会转换为小写，并将空格替换为 `-`；渠道键使用 slug 化后的名称（不含 `#`）。优先使用 guild ID。 +- 默认会忽略由 bot 自己编写的消息。`allowBots: true` 会启用它们；使用 `allowBots: "mentions"` 则只接受提及该 bot 的 bot 消息（自身消息仍会被过滤）。 +- `channels.discord.guilds..ignoreOtherMentions`（以及渠道级覆盖）会丢弃提及了其他用户或角色、但未提及该 bot 的消息（不包括 @everyone/@here）。 +- `maxLinesPerMessage`（默认 17）会在消息行数过多时进行拆分，即使总长度未超过 2000 个字符。 - `channels.discord.threadBindings` 控制 Discord 线程绑定路由： - - `enabled`：Discord 对线程绑定会话功能的覆盖（`/focus`、`/unfocus`、`/agents`、`/session idle`、`/session max-age` 以及绑定投递/路由） - - `idleHours`：Discord 对按小时计算的无活动自动取消聚焦的覆盖（`0` 表示禁用） - - `maxAgeHours`：Discord 对按小时计算的硬性最大时长的覆盖（`0` 表示禁用） + - `enabled`：用于线程绑定会话功能的 Discord 覆盖设置（`/focus`、`/unfocus`、`/agents`、`/session idle`、`/session max-age`，以及绑定交付/路由） + - `idleHours`：以小时计的非活动自动取消聚焦 Discord 覆盖值（`0` 表示禁用） + - `maxAgeHours`：以小时计的硬性最大存活时间 Discord 覆盖值（`0` 表示禁用） - `spawnSubagentSessions`：为 `sessions_spawn({ thread: true })` 自动创建/绑定线程的显式启用开关 -- 顶层 `bindings[]` 中 `type: "acp"` 的条目用于为渠道和线程配置持久化 ACP 绑定（在 `match.peer.id` 中使用渠道/线程 id）。字段语义与 [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings) 中一致。 +- 顶层 `bindings[]` 中 `type: "acp"` 的条目用于为渠道和线程配置持久 ACP 绑定（在 `match.peer.id` 中使用渠道/线程 id）。字段语义共享于 [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings)。 - `channels.discord.ui.components.accentColor` 用于设置 Discord components v2 容器的强调色。 - `channels.discord.voice` 启用 Discord 语音频道对话，以及可选的自动加入 + TTS 覆盖。 - `channels.discord.voice.daveEncryption` 和 `channels.discord.voice.decryptionFailureTolerance` 会透传给 `@discordjs/voice` 的 DAVE 选项（默认分别为 `true` 和 `24`）。 - OpenClaw 还会在重复解密失败后，通过离开并重新加入语音会话来尝试恢复语音接收。 -- `channels.discord.streaming` 是规范的流模式键。旧版 `streamMode` 和布尔型 `streaming` 值会被自动迁移。 +- `channels.discord.streaming` 是规范的流式模式键。旧版 `streamMode` 和布尔型 `streaming` 值会被自动迁移。 - `channels.discord.autoPresence` 会将运行时可用性映射到 bot 在线状态（healthy => online，degraded => idle，exhausted => dnd），并允许可选的状态文本覆盖。 -- `channels.discord.dangerouslyAllowNameMatching` 会重新启用可变名称/tag 匹配（破窗兼容模式）。 -- `channels.discord.execApprovals`：Discord 原生的 exec 审批投递和审批人授权。 - - `enabled`：`true`、`false` 或 `"auto"`（默认）。在自动模式下，当可以从 `approvers` 或 `commands.ownerAllowFrom` 解析出审批人时，exec 审批会激活。 - - `approvers`：允许审批 exec 请求的 Discord 用户 ID。省略时回退为 `commands.ownerAllowFrom`。 - - `agentFilter`：可选的智能体 ID 允许列表。省略时会转发所有智能体的审批。 - - `sessionFilter`：可选的会话键模式（子字符串或正则表达式）。 - - `target`：发送审批提示的位置。`"dm"`（默认）发送到审批人私信，`"channel"` 发送到发起渠道，`"both"` 两处都发。若 target 包含 `"channel"`，按钮仅对已解析出的审批人可用。 - - `cleanupAfterResolve`：设为 `true` 时，在批准、拒绝或超时后删除审批私信。 +- `channels.discord.dangerouslyAllowNameMatching` 会重新启用可变名称/tag 匹配（紧急兼容模式）。 +- `channels.discord.execApprovals`：Discord 原生 exec 审批交付和审批人授权。 + - `enabled`：`true`、`false` 或 `"auto"`（默认）。在自动模式下，当可从 `approvers` 或 `commands.ownerAllowFrom` 解析出审批人时，exec 审批会激活。 + - `approvers`：允许批准 exec 请求的 Discord 用户 ID。省略时回退到 `commands.ownerAllowFrom`。 + - `agentFilter`：可选的智能体 ID 允许列表。省略时会为所有智能体转发审批。 + - `sessionFilter`：可选的会话键模式（子串或正则）。 + - `target`：审批提示发送位置。`"dm"`（默认）发送到审批人的私信，`"channel"` 发送到来源渠道，`"both"` 同时发送到两者。当目标包含 `"channel"` 时，按钮仅对已解析的审批人可用。 + - `cleanupAfterResolve`：为 `true` 时，在审批通过、拒绝或超时后删除审批私信。 -**Reaction notification 模式：** `off`（无）、`own`（bot 自己的消息，默认）、`all`（所有消息）、`allowlist`（来自 `guilds..users`，应用于所有消息）。 +**Reaction notification 模式：** `off`（无）、`own`（bot 自己的消息，默认）、`all`（所有消息）、`allowlist`（`guilds..users` 中所有消息的允许列表）。 ### Google Chat @@ -393,11 +393,11 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 } ``` -- 服务账号 JSON：支持内联（`serviceAccount`）或基于文件（`serviceAccountFile`）。 -- 也支持服务账号 SecretRef（`serviceAccountRef`）。 +- Service account JSON：支持内联（`serviceAccount`）或基于文件（`serviceAccountFile`）。 +- 也支持 Service account SecretRef（`serviceAccountRef`）。 - 环境变量回退：`GOOGLE_CHAT_SERVICE_ACCOUNT` 或 `GOOGLE_CHAT_SERVICE_ACCOUNT_FILE`。 -- 投递目标请使用 `spaces/` 或 `users/`。 -- `channels.googlechat.dangerouslyAllowNameMatching` 会重新启用可变 email principal 匹配（破窗兼容模式）。 +- 交付目标请使用 `spaces/` 或 `users/`。 +- `channels.googlechat.dangerouslyAllowNameMatching` 会重新启用可变 email principal 匹配（紧急兼容模式）。 ### Slack @@ -449,7 +449,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 chunkMode: "length", streaming: { mode: "partial", // off | partial | block | progress - nativeTransport: true, // 当 mode=partial 时使用 Slack 原生流式 API + nativeTransport: true, // mode=partial 时使用 Slack 原生流式 API }, mediaMaxMb: 20, execApprovals: { @@ -464,34 +464,38 @@ WhatsApp 通过 Gateway 网关的 web 渠道（Baileys Web）运行。当存在 } ``` -- **Socket mode** 需要同时提供 `botToken` 和 `appToken`（默认账号的环境变量回退为 `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN`）。 -- **HTTP mode** 需要 `botToken` 加 `signingSecret`（可位于根级或按账号设置）。 -- `botToken`、`appToken`、`signingSecret` 和 `userToken` 接受明文字符串或 SecretRef 对象。 -- Slack 账号快照会暴露按凭据划分的来源/状态字段，例如 `botTokenSource`、`botTokenStatus`、`appTokenStatus`，以及在 HTTP 模式下的 `signingSecretStatus`。`configured_unavailable` 表示该账号通过 SecretRef 配置，但当前命令/运行时路径无法解析该 secret 值。 +- **Socket 模式** 需要同时提供 `botToken` 和 `appToken`（默认账号环境变量回退为 `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN`）。 +- **HTTP 模式** 需要 `botToken` 加 `signingSecret`（可位于根级或按账号配置）。 +- `botToken`、`appToken`、`signingSecret` 和 `userToken` 接受明文 + 字符串或 SecretRef 对象。 +- Slack 账号快照会公开按凭证区分的来源/状态字段，例如 + `botTokenSource`、`botTokenStatus`、`appTokenStatus`，以及在 HTTP 模式下的 + `signingSecretStatus`。`configured_unavailable` 表示该账号通过 SecretRef + 配置，但当前命令/运行时路径无法解析出 secret 值。 - `configWrites: false` 会阻止由 Slack 发起的配置写入。 -- 可选的 `channels.slack.defaultAccount` 会在其匹配某个已配置账号 id 时覆盖默认账号选择。 -- `channels.slack.streaming.mode` 是规范的 Slack 流模式键。`channels.slack.streaming.nativeTransport` 控制 Slack 的原生流式传输。旧版 `streamMode`、布尔型 `streaming` 和 `nativeStreaming` 值会被自动迁移。 -- 投递目标请使用 `user:`（私信）或 `channel:`。 +- 可选的 `channels.slack.defaultAccount` 可在其匹配某个已配置账号 id 时覆盖默认账号选择。 +- `channels.slack.streaming.mode` 是规范的 Slack 流式模式键。`channels.slack.streaming.nativeTransport` 控制 Slack 的原生流式传输。旧版 `streamMode`、布尔型 `streaming` 和 `nativeStreaming` 值会被自动迁移。 +- 交付目标请使用 `user:`（私信）或 `channel:`。 **Reaction notification 模式：** `off`、`own`（默认）、`all`、`allowlist`（来自 `reactionAllowlist`）。 -**线程会话隔离：** `thread.historyScope` 为按线程隔离（默认）或在整个渠道中共享。`thread.inheritParent` 会将父渠道的转录复制到新线程。 +**线程会话隔离：** `thread.historyScope` 可设为每线程（默认）或与整个渠道共享。`thread.inheritParent` 会将父渠道转录复制到新线程。 -- Slack 原生流式传输加上 Slack 助手风格的 “is typing...” 线程状态，需要一个回复线程目标。顶层私信默认保持非线程模式，因此会使用 `typingReaction` 或普通投递，而不是线程式预览。 -- `typingReaction` 会在回复运行期间向入站 Slack 消息添加一个临时 reaction，并在完成后移除。请使用 Slack emoji 简码，例如 `"hourglass_flowing_sand"`。 -- `channels.slack.execApprovals`：Slack 原生的 exec 审批投递和审批人授权。与 Discord 使用相同 schema：`enabled`（`true`/`false`/`"auto"`）、`approvers`（Slack 用户 ID）、`agentFilter`、`sessionFilter` 和 `target`（`"dm"`、`"channel"` 或 `"both"`）。 +- Slack 原生流式传输以及 Slack assistant 风格的“正在输入...”线程状态都需要回复线程目标。顶层私信默认保持非线程模式，因此会使用 `typingReaction` 或普通交付，而不是线程样式预览。 +- `typingReaction` 会在回复运行期间向入站 Slack 消息添加一个临时 reaction，并在完成后移除。请使用 Slack emoji shortcode，例如 `"hourglass_flowing_sand"`。 +- `channels.slack.execApprovals`：Slack 原生 exec 审批交付和审批人授权。schema 与 Discord 相同：`enabled`（`true`/`false`/`"auto"`）、`approvers`（Slack 用户 ID）、`agentFilter`、`sessionFilter` 和 `target`（`"dm"`、`"channel"` 或 `"both"`）。 -| 操作组 | 默认值 | 说明 | -| ------------ | -------- | -------------------- | -| reactions | 已启用 | 添加 reaction + 列出 reactions | -| messages | 已启用 | 读取/发送/编辑/删除 | -| pins | 已启用 | 固定/取消固定/列出 | -| memberInfo | 已启用 | 成员信息 | -| emojiList | 已启用 | 自定义 emoji 列表 | +| 操作组 | 默认值 | 说明 | +| ----------- | ------ | -------------------- | +| reactions | 启用 | 添加 reaction + 列出 reactions | +| messages | 启用 | 读取/发送/编辑/删除 | +| pins | 启用 | 固定/取消固定/列出 | +| memberInfo | 启用 | 成员信息 | +| emojiList | 启用 | 自定义 emoji 列表 | ### Mattermost -Mattermost 以插件形式提供：`openclaw plugins install @openclaw/mattermost`。 +Mattermost 作为插件提供：`openclaw plugins install @openclaw/mattermost`。 ```json5 { @@ -511,7 +515,7 @@ Mattermost 以插件形式提供：`openclaw plugins install @openclaw/mattermos native: true, // 显式启用 nativeSkills: true, callbackPath: "/api/channels/mattermost/command", - // 面向反向代理/公网部署的可选显式 URL + // 反向代理/公网部署时可选的显式 URL callbackUrl: "https://gateway.example.com/api/channels/mattermost/command", }, textChunkLimit: 4000, @@ -521,18 +525,22 @@ Mattermost 以插件形式提供：`openclaw plugins install @openclaw/mattermos } ``` -聊天模式：`oncall`（在 @ 提及时回复，默认）、`onmessage`（每条消息都回复）、`onchar`（以触发前缀开头的消息）。 +聊天模式：`oncall`（在 @ 提及时响应，默认）、`onmessage`（每条消息都响应）、`onchar`（以触发前缀开头的消息）。 启用 Mattermost 原生命令时： - `commands.callbackPath` 必须是路径（例如 `/api/channels/mattermost/command`），不能是完整 URL。 -- `commands.callbackUrl` 必须解析到 OpenClaw Gateway 网关端点，并且 Mattermost 服务器能够访问。 -- 原生 slash 回调使用 Mattermost 在注册 slash 命令期间返回的逐命令 token 进行认证。如果注册失败或没有激活任何命令，OpenClaw 会以 `Unauthorized: invalid command token.` 拒绝回调。 -- 对于私有/tailnet/内部回调主机，Mattermost 可能要求 `ServiceSettings.AllowedUntrustedInternalConnections` 包含该回调主机/域名。请使用主机/域名值，而不是完整 URL。 +- `commands.callbackUrl` 必须解析到 OpenClaw Gateway 网关 端点，并且 Mattermost 服务器必须可访问。 +- 原生 slash 回调通过 Mattermost 在 slash 命令注册期间返回的每命令 token 进行身份验证。如果注册失败或没有 + 命令被激活，OpenClaw 会拒绝回调，并返回 + `Unauthorized: invalid command token.`。 +- 对于私有/tailnet/内部回调主机，Mattermost 可能要求 + `ServiceSettings.AllowedUntrustedInternalConnections` 包含该回调主机/域名。 + 请使用主机/域名值，而不是完整 URL。 - `channels.mattermost.configWrites`：允许或拒绝由 Mattermost 发起的配置写入。 -- `channels.mattermost.requireMention`：在渠道中回复前要求 `@mention`。 -- `channels.mattermost.groups..requireMention`：按渠道覆盖提及门控（`"*"` 表示默认值）。 -- 可选的 `channels.mattermost.defaultAccount` 会在其匹配某个已配置账号 id 时覆盖默认账号选择。 +- `channels.mattermost.requireMention`：要求在渠道中先 `@mention` 才会回复。 +- `channels.mattermost.groups..requireMention`：按渠道设置的提及门控覆盖（`"*"` 表示默认值）。 +- 可选的 `channels.mattermost.defaultAccount` 可在其匹配某个已配置账号 id 时覆盖默认账号选择。 ### Signal @@ -557,11 +565,11 @@ Mattermost 以插件形式提供：`openclaw plugins install @openclaw/mattermos - `channels.signal.account`：将渠道启动固定到特定的 Signal 账号身份。 - `channels.signal.configWrites`：允许或拒绝由 Signal 发起的配置写入。 -- 可选的 `channels.signal.defaultAccount` 会在其匹配某个已配置账号 id 时覆盖默认账号选择。 +- 可选的 `channels.signal.defaultAccount` 可在其匹配某个已配置账号 id 时覆盖默认账号选择。 ### BlueBubbles -BlueBubbles 是推荐的 iMessage 路径（插件支持，配置位于 `channels.bluebubbles` 下）。 +BlueBubbles 是推荐的 iMessage 路径（由插件支持，配置位于 `channels.bluebubbles` 下）。 ```json5 { @@ -569,7 +577,7 @@ BlueBubbles 是推荐的 iMessage 路径（插件支持，配置位于 `channels bluebubbles: { enabled: true, dmPolicy: "pairing", - // serverUrl、password、webhookPath、群组控制和高级操作： + // serverUrl、password、webhookPath、群组控制以及高级操作： // 参见 /channels/bluebubbles }, }, @@ -577,13 +585,13 @@ BlueBubbles 是推荐的 iMessage 路径（插件支持，配置位于 `channels ``` - 此处涵盖的核心键路径：`channels.bluebubbles`、`channels.bluebubbles.dmPolicy`。 -- 可选的 `channels.bluebubbles.defaultAccount` 会在其匹配某个已配置账号 id 时覆盖默认账号选择。 -- 顶层 `bindings[]` 中 `type: "acp"` 的条目可以将 BlueBubbles 会话绑定到持久化 ACP 会话。在 `match.peer.id` 中使用 BlueBubbles handle 或 target 字符串（`chat_id:*`、`chat_guid:*`、`chat_identifier:*`）。共享字段语义： [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings)。 -- 完整的 BlueBubbles 渠道配置记录在 [BlueBubbles](/zh-CN/channels/bluebubbles) 中。 +- 可选的 `channels.bluebubbles.defaultAccount` 可在其匹配某个已配置账号 id 时覆盖默认账号选择。 +- 顶层 `bindings[]` 中 `type: "acp"` 的条目可将 BlueBubbles 会话绑定到持久 ACP 会话。请在 `match.peer.id` 中使用 BlueBubbles handle 或目标字符串（`chat_id:*`、`chat_guid:*`、`chat_identifier:*`）。共享字段语义： [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings)。 +- 完整的 BlueBubbles 渠道配置见 [BlueBubbles](/zh-CN/channels/bluebubbles)。 ### iMessage -OpenClaw 会生成 `imsg rpc`（基于 stdio 的 JSON-RPC）。无需守护进程或端口。 +OpenClaw 会启动 `imsg rpc`（基于 stdio 的 JSON-RPC）。无需 daemon 或端口。 ```json5 { @@ -607,17 +615,17 @@ OpenClaw 会生成 `imsg rpc`（基于 stdio 的 JSON-RPC）。无需守护进 } ``` -- 可选的 `channels.imessage.defaultAccount` 会在其匹配某个已配置账号 id 时覆盖默认账号选择。 +- 可选的 `channels.imessage.defaultAccount` 可在其匹配某个已配置账号 id 时覆盖默认账号选择。 - 需要对 Messages 数据库授予 Full Disk Access。 -- 优先使用 `chat_id:` 目标。使用 `imsg chats --limit 20` 列出聊天。 -- `cliPath` 可以指向 SSH 包装器；设置 `remoteHost`（`host` 或 `user@host`）以便通过 SCP 获取附件。 -- `attachmentRoots` 和 `remoteAttachmentRoots` 会限制入站附件路径（默认值：`/Users/*/Library/Messages/Attachments`）。 -- SCP 使用严格的 host-key 检查，因此请确保中继主机密钥已存在于 `~/.ssh/known_hosts` 中。 +- 优先使用 `chat_id:` 目标。使用 `imsg chats --limit 20` 可列出聊天。 +- `cliPath` 可以指向 SSH 包装脚本；设置 `remoteHost`（`host` 或 `user@host`）以便通过 SCP 获取附件。 +- `attachmentRoots` 和 `remoteAttachmentRoots` 会限制入站附件路径（默认：`/Users/*/Library/Messages/Attachments`）。 +- SCP 使用严格的主机密钥检查，因此请确保中继主机密钥已存在于 `~/.ssh/known_hosts` 中。 - `channels.imessage.configWrites`：允许或拒绝由 iMessage 发起的配置写入。 -- 顶层 `bindings[]` 中 `type: "acp"` 的条目可以将 iMessage 会话绑定到持久化 ACP 会话。在 `match.peer.id` 中使用规范化后的 handle 或显式聊天目标（`chat_id:*`、`chat_guid:*`、`chat_identifier:*`）。共享字段语义： [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings)。 +- 顶层 `bindings[]` 中 `type: "acp"` 的条目可将 iMessage 会话绑定到持久 ACP 会话。请在 `match.peer.id` 中使用规范化 handle 或显式聊天目标（`chat_id:*`、`chat_guid:*`、`chat_identifier:*`）。共享字段语义： [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings)。 - + ```bash #!/usr/bin/env bash @@ -659,20 +667,20 @@ Matrix 由扩展支持，配置位于 `channels.matrix` 下。 ``` - Token 认证使用 `accessToken`；密码认证使用 `userId` + `password`。 -- `channels.matrix.proxy` 会通过显式 HTTP(S) 代理转发 Matrix HTTP 流量。命名账号可通过 `channels.matrix.accounts..proxy` 覆盖它。 -- `channels.matrix.network.dangerouslyAllowPrivateNetwork` 允许私有/内部 homeserver。`proxy` 与此网络显式启用项是相互独立的控制项。 -- `channels.matrix.defaultAccount` 在多账号配置中选择首选账号。 -- `channels.matrix.autoJoin` 默认为 `off`，因此在你设置 `autoJoin: "allowlist"` 并配合 `autoJoinAllowlist`，或设置 `autoJoin: "always"` 之前，受邀房间和新的私信式邀请都会被忽略。 -- `channels.matrix.execApprovals`：Matrix 原生的 exec 审批投递和审批人授权。 - - `enabled`：`true`、`false` 或 `"auto"`（默认）。在自动模式下，当可以从 `approvers` 或 `commands.ownerAllowFrom` 解析出审批人时，exec 审批会激活。 - - `approvers`：允许审批 exec 请求的 Matrix 用户 ID（例如 `@owner:example.org`）。 - - `agentFilter`：可选的智能体 ID 允许列表。省略时会转发所有智能体的审批。 - - `sessionFilter`：可选的会话键模式（子字符串或正则表达式）。 - - `target`：发送审批提示的位置。`"dm"`（默认）、`"channel"`（发起房间）或 `"both"`。 - - 按账号覆盖：`channels.matrix.accounts..execApprovals`。 -- `channels.matrix.dm.sessionScope` 控制 Matrix 私信如何归组到会话中：`per-user`（默认）按路由对端共享，而 `per-room` 会隔离每个私信房间。 -- Matrix 状态探测和在线目录查找与运行时流量使用相同的代理策略。 -- 完整的 Matrix 配置、目标规则和设置示例记录在 [Matrix](/zh-CN/channels/matrix) 中。 +- `channels.matrix.proxy` 会通过显式 HTTP(S) 代理转发 Matrix HTTP 流量。命名账号可通过 `channels.matrix.accounts..proxy` 覆盖该设置。 +- `channels.matrix.network.dangerouslyAllowPrivateNetwork` 允许私有/内部 homeserver。`proxy` 与该网络显式启用项是彼此独立的控制项。 +- `channels.matrix.defaultAccount` 会在多账号配置中选择首选账号。 +- `channels.matrix.autoJoin` 默认为 `off`，因此受邀房间和新的私信式邀请会被忽略，直到你设置 `autoJoin: "allowlist"` 并配置 `autoJoinAllowlist`，或设置 `autoJoin: "always"`。 +- `channels.matrix.execApprovals`：Matrix 原生 exec 审批交付和审批人授权。 + - `enabled`：`true`、`false` 或 `"auto"`（默认）。在自动模式下，当可从 `approvers` 或 `commands.ownerAllowFrom` 解析出审批人时，exec 审批会激活。 + - `approvers`：允许批准 exec 请求的 Matrix 用户 ID（例如 `@owner:example.org`）。 + - `agentFilter`：可选的智能体 ID 允许列表。省略时会为所有智能体转发审批。 + - `sessionFilter`：可选的会话键模式（子串或正则）。 + - `target`：审批提示发送位置。`"dm"`（默认）、`"channel"`（来源房间）或 `"both"`。 + - 每账号覆盖：`channels.matrix.accounts..execApprovals`。 +- `channels.matrix.dm.sessionScope` 控制 Matrix 私信如何归并到会话中：`per-user`（默认）按路由后的对端共享，而 `per-room` 会隔离每个私信房间。 +- Matrix 状态探测和实时目录查找使用与运行时流量相同的代理策略。 +- 完整的 Matrix 配置、目标规则和设置示例见 [Matrix](/zh-CN/channels/matrix)。 ### Microsoft Teams @@ -692,7 +700,7 @@ Microsoft Teams 由扩展支持，配置位于 `channels.msteams` 下。 ``` - 此处涵盖的核心键路径：`channels.msteams`、`channels.msteams.configWrites`。 -- 完整的 Teams 配置（凭据、webhook、私信/群组策略、按团队/按渠道覆盖）记录在 [Microsoft Teams](/zh-CN/channels/msteams) 中。 +- 完整的 Teams 配置（凭证、webhook、私信/群组策略、按团队/按渠道覆盖）见 [Microsoft Teams](/zh-CN/channels/msteams)。 ### IRC @@ -718,12 +726,12 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ``` - 此处涵盖的核心键路径：`channels.irc`、`channels.irc.dmPolicy`、`channels.irc.configWrites`、`channels.irc.nickserv.*`。 -- 可选的 `channels.irc.defaultAccount` 会在其匹配某个已配置账号 id 时覆盖默认账号选择。 -- 完整的 IRC 渠道配置（host/port/TLS/channels/allowlists/mention gating）记录在 [IRC](/zh-CN/channels/irc) 中。 +- 可选的 `channels.irc.defaultAccount` 可在其匹配某个已配置账号 id 时覆盖默认账号选择。 +- 完整的 IRC 渠道配置（host/port/TLS/channels/allowlists/mention gating）见 [IRC](/zh-CN/channels/irc)。 ### 多账号（所有渠道） -为每个渠道运行多个账号（每个账号都有自己的 `accountId`）： +每个渠道可运行多个账号（每个账号都有自己的 `accountId`）： ```json5 { @@ -744,28 +752,28 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 } ``` -- 当省略 `accountId` 时，会使用 `default`（CLI + 路由）。 +- 省略 `accountId` 时，会使用 `default`（CLI + 路由）。 - 环境变量 token 仅适用于 **default** 账号。 -- 基础渠道设置会应用于所有账号，除非按账号覆盖。 +- 基础渠道设置适用于所有账号，除非按账号覆盖。 - 使用 `bindings[].match.accountId` 可将每个账号路由到不同的智能体。 -- 如果你在仍处于单账号顶层渠道配置时，通过 `openclaw channels add`（或渠道新手引导）添加非默认账号，OpenClaw 会先将按账号作用域的顶层单账号值提升到该渠道账号映射中，以便原账号继续工作。大多数渠道会将其移动到 `channels..accounts.default`；而 Matrix 则可以改为保留现有匹配的命名/default 目标。 -- 现有仅渠道级的绑定（无 `accountId`）仍会匹配 default 账号；按账号作用域的绑定仍然是可选的。 -- `openclaw doctor --fix` 也会通过将按账号作用域的顶层单账号值移动到为该渠道选定的提升后账号中，来修复混合形态。大多数渠道使用 `accounts.default`；Matrix 则可以改为保留现有匹配的命名/default 目标。 +- 如果你通过 `openclaw channels add`（或渠道新手引导）添加一个非默认账号，而当前仍是单账号顶层渠道配置，OpenClaw 会先将账号作用域的顶层单账号值提升到渠道账号映射中，以便原始账号继续工作。大多数渠道会将其迁移到 `channels..accounts.default`；Matrix 则可以保留现有的匹配命名/默认目标。 +- 现有的仅渠道绑定（无 `accountId`）会继续匹配默认账号；按账号作用域的绑定仍然是可选的。 +- `openclaw doctor --fix` 也会通过将账号作用域的顶层单账号值移入该渠道所选的提升账号中来修复混合形态。大多数渠道使用 `accounts.default`；Matrix 则可以保留现有的匹配命名/默认目标。 ### 其他扩展渠道 -许多扩展渠道都配置为 `channels.`，并在各自专用的渠道页面中记录（例如 Feishu、Matrix、LINE、Nostr、Zalo、Nextcloud Talk、Synology Chat 和 Twitch）。 -请参见完整渠道索引： [Channels](/zh-CN/channels)。 +许多扩展渠道都配置为 `channels.`，并在其专属渠道页面中说明（例如 Feishu、Matrix、LINE、Nostr、Zalo、Nextcloud Talk、Synology Chat 和 Twitch）。 +请参阅完整渠道索引： [Channels](/zh-CN/channels)。 ### 群聊提及门控 -群组消息默认**要求提及**（元数据提及或安全正则模式）。适用于 WhatsApp、Telegram、Discord、Google Chat 和 iMessage 群聊。 +群组消息默认 **需要提及**（元数据提及或安全正则模式）。适用于 WhatsApp、Telegram、Discord、Google Chat 和 iMessage 群聊。 **提及类型：** -- **元数据提及**：原生平台 @ 提及。在 WhatsApp self-chat 模式下会被忽略。 +- **元数据提及**：平台原生 @ 提及。在 WhatsApp self-chat 模式下会被忽略。 - **文本模式**：位于 `agents.list[].groupChat.mentionPatterns` 中的安全正则模式。无效模式和不安全的嵌套重复会被忽略。 -- 仅当能够检测提及时（原生提及或至少一个模式）才会强制执行提及门控。 +- 仅在可以检测到提及时（原生提及或至少一个模式）才会执行提及门控。 ```json5 { @@ -778,7 +786,7 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 } ``` -`messages.groupChat.historyLimit` 用于设置全局默认值。渠道可通过 `channels..historyLimit`（或按账号）覆盖。设为 `0` 可禁用。 +`messages.groupChat.historyLimit` 设置全局默认值。渠道可通过 `channels..historyLimit`（或按账号）覆盖。设置为 `0` 可禁用。 #### 私信历史限制 @@ -795,13 +803,13 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 } ``` -解析顺序：按私信覆盖 → 提供商默认值 → 无限制（全部保留）。 +解析顺序：按私信覆盖 → 提供商默认值 → 不限制（全部保留）。 -支持的渠道：`telegram`、`whatsapp`、`discord`、`slack`、`signal`、`imessage`、`msteams`。 +支持：`telegram`、`whatsapp`、`discord`、`slack`、`signal`、`imessage`、`msteams`。 #### self-chat 模式 -将你自己的号码加入 `allowFrom` 以启用 self-chat 模式（忽略原生 @ 提及，仅响应文本模式）： +将你自己的号码加入 `allowFrom` 以启用 self-chat 模式（忽略原生 @ 提及，只响应文本模式）： ```json5 { @@ -827,8 +835,8 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ```json5 { commands: { - native: "auto", // 在支持时注册原生命令 - nativeSkills: "auto", // 在支持时注册原生 Skills 命令 + native: "auto", // 支持时注册原生命令 + nativeSkills: "auto", // 支持时注册原生 Skills 命令 text: true, // 解析聊天消息中的 /commands bash: false, // 允许 !（别名：/bash） bashForegroundMs: 2000, @@ -851,31 +859,31 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 -- 此配置块用于设置命令面。当前内置 + 内置插件命令目录请参见 [Slash Commands](/zh-CN/tools/slash-commands)。 -- 本页是**配置键参考**，不是完整命令目录。诸如 QQ Bot `/bot-ping` `/bot-help` `/bot-logs`、LINE `/card`、device-pair `/pair`、memory `/dreaming`、phone-control `/phone` 和 Talk `/voice` 等渠道/插件自有命令，记录在其各自的渠道/插件页面以及 [Slash Commands](/zh-CN/tools/slash-commands) 中。 -- 文本命令必须是带前导 `/` 的**独立**消息。 -- `native: "auto"` 会为 Discord/Telegram 启用原生命令，对 Slack 则保持关闭。 -- `nativeSkills: "auto"` 会为 Discord/Telegram 启用原生 Skills 命令，对 Slack 则保持关闭。 -- 可按渠道覆盖：`channels.discord.commands.native`（bool 或 `"auto"`）。`false` 会清除先前已注册的命令。 -- 可通过 `channels..commands.nativeSkills` 按渠道覆盖原生技能命令注册。 +- 此配置块用于设置命令层面。当前内置 + 内置插件命令目录请参阅 [Slash Commands](/zh-CN/tools/slash-commands)。 +- 本页是**配置键参考**，不是完整命令目录。像 QQ Bot `/bot-ping` `/bot-help` `/bot-logs`、LINE `/card`、device-pair `/pair`、memory `/dreaming`、phone-control `/phone` 和 Talk `/voice` 这类由渠道/插件自有的命令，记录在各自的渠道/插件页面以及 [Slash Commands](/zh-CN/tools/slash-commands) 中。 +- 文本命令必须是带有前导 `/` 的**独立**消息。 +- `native: "auto"` 会为 Discord/Telegram 打开原生命令，Slack 保持关闭。 +- `nativeSkills: "auto"` 会为 Discord/Telegram 打开原生 Skills 命令，Slack 保持关闭。 +- 按渠道覆盖：`channels.discord.commands.native`（布尔值或 `"auto"`）。`false` 会清除之前注册的命令。 +- 可通过 `channels..commands.nativeSkills` 按渠道覆盖原生 Skills 注册。 - `channels.telegram.customCommands` 会添加额外的 Telegram bot 菜单项。 - `bash: true` 会为主机 shell 启用 `! `。需要 `tools.elevated.enabled`，且发送者位于 `tools.elevated.allowFrom.` 中。 -- `config: true` 会启用 `/config`（读取/写入 `openclaw.json`）。对于 Gateway 网关 `chat.send` 客户端，持久化 `/config set|unset` 写入还需要 `operator.admin`；只读的 `/config show` 对普通写作用域 operator 客户端仍然可用。 -- `mcp: true` 会为位于 `mcp.servers` 下、由 OpenClaw 管理的 MCP 服务器配置启用 `/mcp`。 -- `plugins: true` 会启用 `/plugins`，用于插件发现、安装以及启用/禁用控制。 -- `channels..configWrites` 按渠道控制配置变更（默认：true）。 +- `config: true` 会启用 `/config`（读取/写入 `openclaw.json`）。对于 Gateway 网关 `chat.send` 客户端，持久化的 `/config set|unset` 写入还需要 `operator.admin`；只读的 `/config show` 对普通写权限范围的 operator 客户端仍然可用。 +- `mcp: true` 会为 `mcp.servers` 下由 OpenClaw 管理的 MCP 服务器配置启用 `/mcp`。 +- `plugins: true` 会为插件发现、安装以及启用/禁用控制启用 `/plugins`。 +- `channels..configWrites` 控制每个渠道的配置变更权限（默认：true）。 - 对于多账号渠道，`channels..accounts..configWrites` 也会控制针对该账号的写入（例如 `/allowlist --config --account ` 或 `/config set channels..accounts....`）。 - `restart: false` 会禁用 `/restart` 和 Gateway 网关重启工具操作。默认值：`true`。 -- `ownerAllowFrom` 是 owner-only 命令/工具的显式 owner 允许列表。它独立于 `allowFrom`。 -- `ownerDisplay: "hash"` 会在系统提示中对 owner id 进行哈希。设置 `ownerDisplaySecret` 可控制哈希。 -- `allowFrom` 是按提供商划分的。设置后，它将成为**唯一**授权来源（会忽略渠道 allowlist/pairing 和 `useAccessGroups`）。 +- `ownerAllowFrom` 是仅限 owner 的命令/工具所使用的显式 owner 允许列表。它与 `allowFrom` 分开。 +- `ownerDisplay: "hash"` 会在系统提示中对 owner id 进行哈希处理。设置 `ownerDisplaySecret` 可控制哈希方式。 +- `allowFrom` 按提供商生效。设置后，它就是**唯一**的授权来源（渠道允许列表/配对以及 `useAccessGroups` 都会被忽略）。 - `useAccessGroups: false` 会在未设置 `allowFrom` 时允许命令绕过访问组策略。 - 命令文档映射： - 内置 + 内置插件目录： [Slash Commands](/zh-CN/tools/slash-commands) - - 渠道专用命令面： [Channels](/zh-CN/channels) + - 渠道特定命令层面： [Channels](/zh-CN/channels) - QQ Bot 命令： [QQ Bot](/zh-CN/channels/qqbot) - 配对命令： [Pairing](/zh-CN/channels/pairing) - - LINE card 命令： [LINE](/zh-CN/channels/line) + - LINE 卡片命令： [LINE](/zh-CN/channels/line) - memory dreaming： [Dreaming](/zh-CN/concepts/dreaming) @@ -896,7 +904,7 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ### `agents.defaults.repoRoot` -可选的仓库根目录，会显示在系统提示的 Runtime 行中。如果未设置，OpenClaw 会从 workspace 开始向上遍历自动检测。 +可选的仓库根目录，会显示在系统提示的 Runtime 行中。若未设置，OpenClaw 会从 workspace 开始向上遍历自动检测。 ```json5 { @@ -906,7 +914,8 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ### `agents.defaults.skills` -为未设置 `agents.list[].skills` 的智能体提供可选的默认技能 allowlist。 +为未设置 +`agents.list[].skills` 的智能体提供可选的默认 Skills 允许列表。 ```json5 { @@ -921,10 +930,11 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 } ``` -- 省略 `agents.defaults.skills` 表示默认不限制 Skills。 -- 省略 `agents.list[].skills` 表示继承默认值。 +- 省略 `agents.defaults.skills` 则默认 Skills 不受限制。 +- 省略 `agents.list[].skills` 则继承默认值。 - 设置 `agents.list[].skills: []` 表示不启用任何 Skills。 -- 非空的 `agents.list[].skills` 列表就是该智能体的最终集合；它不会与默认值合并。 +- 非空的 `agents.list[].skills` 列表就是该智能体的最终集合； + 不会与默认值合并。 ### `agents.defaults.skipBootstrap` @@ -938,9 +948,9 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ### `agents.defaults.contextInjection` -控制何时将 workspace bootstrap 文件注入系统提示。默认值：`"always"`。 +控制何时将 workspace bootstrap 文件注入到系统提示中。默认值：`"always"`。 -- `"continuation-skip"`：安全续接回合（在 assistant 完成响应之后）会跳过 workspace bootstrap 的重新注入，从而减少提示大小。Heartbeat 运行和压缩后的重试仍会重建上下文。 +- `"continuation-skip"`：安全续接轮次（在 assistant 完成回复之后）会跳过再次注入 workspace bootstrap，从而减少提示大小。heartbeat 运行和压缩后的重试仍会重建上下文。 ```json5 { @@ -970,10 +980,11 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ### `agents.defaults.bootstrapPromptTruncationWarning` -控制在 bootstrap 上下文被截断时，对智能体可见的警告文本。默认值：`"once"`。 +控制 bootstrap 上下文被截断时对智能体可见的警告文本。 +默认值：`"once"`。 -- `"off"`：绝不向系统提示注入警告文本。 -- `"once"`：每个唯一截断签名仅注入一次警告（推荐）。 +- `"off"`：绝不在系统提示中注入警告文本。 +- `"once"`：每个唯一的截断签名只注入一次警告（推荐）。 - `"always"`：只要存在截断，就在每次运行时都注入警告。 ```json5 @@ -984,10 +995,10 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ### `agents.defaults.imageMaxDimensionPx` -在调用提供商之前，转录/工具图像块中图像最长边允许的最大像素尺寸。 +在调用提供商之前，转录/工具图像块中图像最长边的最大像素尺寸。 默认值：`1200`。 -较低的值通常会降低 vision token 使用量以及以截图为主的运行请求负载大小。 +较低的值通常会减少视觉 token 使用量，以及以截图为主的运行中的请求负载大小。 较高的值则会保留更多视觉细节。 ```json5 @@ -998,7 +1009,7 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ### `agents.defaults.userTimezone` -用于系统提示上下文的时区（不影响消息时间戳）。未设置时会回退为主机时区。 +系统提示上下文使用的时区（不影响消息时间戳）。会回退到主机时区。 ```json5 { @@ -1008,7 +1019,7 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ### `agents.defaults.timeFormat` -系统提示中的时间格式。默认值：`auto`（OS 偏好）。 +系统提示中的时间格式。默认值：`auto`（操作系统偏好）。 ```json5 { @@ -1048,7 +1059,7 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 }, params: { cacheRetention: "long" }, // 全局默认提供商参数 embeddedHarness: { - runtime: "auto", // auto | pi | 已注册 harness id，例如 codex + runtime: "auto", // auto | pi | 已注册的 harness id，例如 codex fallback: "pi", // pi | none }, pdfMaxBytesMb: 10, @@ -1066,47 +1077,47 @@ IRC 由扩展支持，配置位于 `channels.irc` 下。 ``` - `model`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 字符串形式仅设置主模型。 - - 对象形式设置主模型以及有序故障转移模型。 + - 字符串形式只设置主模型。 + - 对象形式设置主模型以及按顺序排列的故障转移模型。 - `imageModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 由 `image` 工具路径作为其视觉模型配置使用。 - - 当已选/默认模型无法接受图像输入时，也会作为回退路由使用。 + - 由 `image` 工具路径用作其 vision 模型配置。 + - 当选定/默认模型无法接受图像输入时，也会用作回退路由。 - `imageGenerationModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 由共享图像生成功能以及任何未来会生成图像的工具/插件面使用。 - - 典型值：`google/gemini-3.1-flash-image-preview`（用于原生 Gemini 图像生成）、`fal/fal-ai/flux/dev`（用于 fal）或 `openai/gpt-image-1`（用于 OpenAI Images）。 - - 如果你直接选择提供商/模型，也请配置匹配的提供商凭证/API key（例如 `google/*` 对应 `GEMINI_API_KEY` 或 `GOOGLE_API_KEY`，`openai/*` 对应 `OPENAI_API_KEY`，`fal/*` 对应 `FAL_KEY`）。 - - 如果省略，`image_generate` 仍可推断出有凭证支持的默认提供商。它会先尝试当前默认提供商，然后按提供商 id 顺序尝试其余已注册的图像生成提供商。 + - 由共享图像生成能力以及任何未来生成图像的工具/插件层面使用。 + - 常见值：`google/gemini-3.1-flash-image-preview`（原生 Gemini 图像生成）、`fal/fal-ai/flux/dev`（fal）或 `openai/gpt-image-1`（OpenAI Images）。 + - 如果你直接选择某个提供商/模型，也要配置匹配的提供商凭证/API key（例如 `google/*` 使用 `GEMINI_API_KEY` 或 `GOOGLE_API_KEY`，`openai/*` 使用 `OPENAI_API_KEY`，`fal/*` 使用 `FAL_KEY`）。 + - 如果省略，`image_generate` 仍可推断出带凭证的提供商默认值。它会先尝试当前默认提供商，然后按 provider-id 顺序尝试其余已注册的图像生成提供商。 - `musicGenerationModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 由共享音乐生成功能和内置 `music_generate` 工具使用。 - - 典型值：`google/lyria-3-clip-preview`、`google/lyria-3-pro-preview` 或 `minimax/music-2.5+`。 - - 如果省略，`music_generate` 仍可推断出有凭证支持的默认提供商。它会先尝试当前默认提供商，然后按提供商 id 顺序尝试其余已注册的音乐生成提供商。 - - 如果你直接选择提供商/模型，也请配置匹配的提供商凭证/API key。 + - 由共享音乐生成能力和内置 `music_generate` 工具使用。 + - 常见值：`google/lyria-3-clip-preview`、`google/lyria-3-pro-preview` 或 `minimax/music-2.5+`。 + - 如果省略，`music_generate` 仍可推断出带凭证的提供商默认值。它会先尝试当前默认提供商，然后按 provider-id 顺序尝试其余已注册的音乐生成提供商。 + - 如果你直接选择某个提供商/模型，也要配置匹配的提供商凭证/API key。 - `videoGenerationModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 由共享视频生成功能和内置 `video_generate` 工具使用。 - - 典型值：`qwen/wan2.6-t2v`、`qwen/wan2.6-i2v`、`qwen/wan2.6-r2v`、`qwen/wan2.6-r2v-flash` 或 `qwen/wan2.7-r2v`。 - - 如果省略，`video_generate` 仍可推断出有凭证支持的默认提供商。它会先尝试当前默认提供商，然后按提供商 id 顺序尝试其余已注册的视频生成提供商。 - - 如果你直接选择提供商/模型，也请配置匹配的提供商凭证/API key。 - - 内置的 Qwen 视频生成提供商最多支持 1 个输出视频、1 张输入图像、4 个输入视频、10 秒时长，以及提供商级 `size`、`aspectRatio`、`resolution`、`audio` 和 `watermark` 选项。 + - 由共享视频生成能力和内置 `video_generate` 工具使用。 + - 常见值：`qwen/wan2.6-t2v`、`qwen/wan2.6-i2v`、`qwen/wan2.6-r2v`、`qwen/wan2.6-r2v-flash` 或 `qwen/wan2.7-r2v`。 + - 如果省略，`video_generate` 仍可推断出带凭证的提供商默认值。它会先尝试当前默认提供商，然后按 provider-id 顺序尝试其余已注册的视频生成提供商。 + - 如果你直接选择某个提供商/模型，也要配置匹配的提供商凭证/API key。 + - 内置的 Qwen 视频生成提供商最多支持 1 个输出视频、1 张输入图片、4 个输入视频、10 秒时长，以及提供商级别的 `size`、`aspectRatio`、`resolution`、`audio` 和 `watermark` 选项。 - `pdfModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - 由 `pdf` 工具用于模型路由。 - - 如果省略，PDF 工具会依次回退到 `imageModel`，再回退到已解析的会话/默认模型。 -- `pdfMaxBytesMb`：当调用时未传入 `maxBytesMb` 时，`pdf` 工具的默认 PDF 大小限制。 + - 如果省略，PDF 工具会依次回退到 `imageModel`，然后回退到解析后的会话/默认模型。 +- `pdfMaxBytesMb`：当调用时未传入 `maxBytesMb` 时，`pdf` 工具使用的默认 PDF 大小限制。 - `pdfMaxPages`：`pdf` 工具在提取回退模式下默认考虑的最大页数。 -- `verboseDefault`：智能体的默认详细级别。可选值：`"off"`、`"on"`、`"full"`。默认值：`"off"`。 -- `elevatedDefault`：智能体的默认 elevated-output 级别。可选值：`"off"`、`"on"`、`"ask"`、`"full"`。默认值：`"on"`。 -- `model.primary`：格式为 `provider/model`（例如 `openai/gpt-5.4`）。如果你省略提供商，OpenClaw 会先尝试别名，然后尝试精确匹配该模型 id 的唯一已配置提供商，最后才回退到已配置的默认提供商（这是已弃用的兼容行为，因此更推荐显式写成 `provider/model`）。如果该提供商不再公开已配置的默认模型，OpenClaw 会回退到第一个已配置的提供商/模型，而不是继续暴露一个陈旧、已移除提供商的默认值。 -- `models`：为 `/model` 配置的模型目录和 allowlist。每个条目都可以包含 `alias`（快捷方式）和 `params`（提供商专用，例如 `temperature`、`maxTokens`、`cacheRetention`、`context1m`）。 -- `params`：应用于所有模型的全局默认提供商参数。设置位置为 `agents.defaults.params`（例如 `{ cacheRetention: "long" }`）。 -- `params` 合并优先级（配置）：`agents.defaults.params`（全局基础）会被 `agents.defaults.models["provider/model"].params`（按模型）覆盖，然后 `agents.list[].params`（匹配的智能体 id）再按键覆盖。详见 [Prompt Caching](/zh-CN/reference/prompt-caching)。 -- `embeddedHarness`：默认的底层嵌入式智能体运行时策略。使用 `runtime: "auto"` 可让已注册插件 harness 接管其支持的模型，使用 `runtime: "pi"` 可强制使用内置 PI harness，或使用已注册 harness id，如 `runtime: "codex"`。设置 `fallback: "none"` 可禁用自动 PI 回退。 -- 会变更这些字段的配置写入器（例如 `/models set`、`/models set-image` 以及回退项添加/删除命令）会保存规范对象形式，并在可能时保留现有回退列表。 -- `maxConcurrent`：跨会话的最大并行智能体运行数（每个会话仍然串行）。默认值：4。 +- `verboseDefault`：智能体的默认详细级别。取值：`"off"`、`"on"`、`"full"`。默认值：`"off"`。 +- `elevatedDefault`：智能体的默认 elevated-output 级别。取值：`"off"`、`"on"`、`"ask"`、`"full"`。默认值：`"on"`。 +- `model.primary`：格式为 `provider/model`（例如 `openai/gpt-5.4`）。如果你省略提供商，OpenClaw 会先尝试别名，然后尝试与该确切模型 id 唯一匹配的已配置提供商，最后才回退到已配置的默认提供商（这是已弃用的兼容行为，因此推荐显式使用 `provider/model`）。如果该提供商不再暴露已配置的默认模型，OpenClaw 会回退到第一个已配置的提供商/模型，而不是继续保留陈旧的已移除提供商默认值。 +- `models`：为 `/model` 配置的模型目录和允许列表。每个条目可以包含 `alias`（快捷名）和 `params`（提供商特定参数，例如 `temperature`、`maxTokens`、`cacheRetention`、`context1m`）。 +- `params`：应用于所有模型的全局默认提供商参数。设置于 `agents.defaults.params`（例如 `{ cacheRetention: "long" }`）。 +- `params` 合并优先级（配置）：`agents.defaults.params`（全局基础）会被 `agents.defaults.models["provider/model"].params`（每模型）覆盖，然后 `agents.list[].params`（匹配的智能体 id）按键覆盖。详情见 [Prompt Caching](/zh-CN/reference/prompt-caching)。 +- `embeddedHarness`：默认的底层嵌入式智能体运行时策略。使用 `runtime: "auto"` 让已注册插件 harness 认领其支持的模型，使用 `runtime: "pi"` 强制使用内置 PI harness，或使用已注册的 harness id，例如 `runtime: "codex"`。设置 `fallback: "none"` 可禁用自动 PI 回退。 +- 会修改这些字段的配置写入器（例如 `/models set`、`/models set-image` 以及回退添加/删除命令）会保存为规范的对象形式，并在可能时保留现有回退列表。 +- `maxConcurrent`：跨会话并行运行的最大智能体数（每个会话本身仍是串行的）。默认值：4。 ### `agents.defaults.embeddedHarness` -`embeddedHarness` 用于控制哪个底层执行器运行嵌入式智能体回合。 -大多数部署应保持默认值 `{ runtime: "auto", fallback: "pi" }`。 -当受信任的插件提供原生 harness 时使用它，例如内置的 +`embeddedHarness` 控制哪个底层执行器运行嵌入式智能体轮次。 +大多数部署应保留默认值 `{ runtime: "auto", fallback: "pi" }`。 +当受信任的插件提供原生 harness 时可使用此项，例如内置的 Codex app-server harness。 ```json5 @@ -1123,15 +1134,15 @@ Codex app-server harness。 } ``` -- `runtime`：`"auto"`、`"pi"` 或已注册插件 harness id。内置的 Codex 插件会注册 `codex`。 -- `fallback`：`"pi"` 或 `"none"`。`"pi"` 会保留内置 PI harness 作为兼容回退。`"none"` 则会在插件 harness 选择缺失或不受支持时直接失败，而不是静默使用 PI。 +- `runtime`：`"auto"`、`"pi"` 或已注册的插件 harness id。内置 Codex 插件注册的 id 是 `codex`。 +- `fallback`：`"pi"` 或 `"none"`。`"pi"` 会保留内置 PI harness 作为兼容性回退。`"none"` 则会在插件 harness 选择缺失或不受支持时直接失败，而不是静默使用 PI。 - 环境变量覆盖：`OPENCLAW_AGENT_RUNTIME=` 会覆盖 `runtime`；`OPENCLAW_AGENT_HARNESS_FALLBACK=none` 会为该进程禁用 PI 回退。 - 对于仅使用 Codex 的部署，请设置 `model: "codex/gpt-5.4"`、`embeddedHarness.runtime: "codex"` 和 `embeddedHarness.fallback: "none"`。 -- 这只控制嵌入式聊天 harness。媒体生成、视觉、PDF、音乐、视频和 TTS 仍使用它们各自的提供商/模型设置。 +- 这只控制嵌入式聊天 harness。媒体生成、vision、PDF、音乐、视频和 TTS 仍使用各自的提供商/模型设置。 -**内置 alias 简写**（仅在模型位于 `agents.defaults.models` 中时适用）： +**内置别名简写**（仅在模型位于 `agents.defaults.models` 中时生效）： -| Alias | 模型 | +| 别名 | 模型 | | ------------------- | -------------------------------------- | | `opus` | `anthropic/claude-opus-4-6` | | `sonnet` | `anthropic/claude-sonnet-4-6` | @@ -1142,15 +1153,15 @@ Codex app-server harness。 | `gemini-flash` | `google/gemini-3-flash-preview` | | `gemini-flash-lite` | `google/gemini-3.1-flash-lite-preview` | -你配置的 alias 总是优先于默认值。 +你配置的别名始终优先于默认值。 Z.AI GLM-4.x 模型会自动启用 thinking 模式，除非你设置 `--thinking off`，或自行定义 `agents.defaults.models["zai/"].params.thinking`。 -Z.AI 模型默认启用 `tool_stream` 以进行工具调用流式传输。将 `agents.defaults.models["zai/"].params.tool_stream` 设为 `false` 可禁用它。 -Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 `adaptive` thinking。 +Z.AI 模型默认启用 `tool_stream` 以进行工具调用流式传输。将 `agents.defaults.models["zai/"].params.tool_stream` 设为 `false` 可禁用。 +Anthropic Claude 4.6 模型在未显式设置 thinking 级别时，默认使用 `adaptive` thinking。 ### `agents.defaults.cliBackends` -用于纯文本回退运行（无工具调用）的可选 CLI 后端。适合作为 API 提供商失败时的备用方案。 +用于纯文本回退运行（无工具调用）的可选 CLI 后端。在 API 提供商失败时可作为备用方案。 ```json5 { @@ -1184,7 +1195,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 ### `agents.defaults.systemPromptOverride` -用固定字符串替换整个由 OpenClaw 组装的系统提示。可在默认级别（`agents.defaults.systemPromptOverride`）或按智能体设置（`agents.list[].systemPromptOverride`）。按智能体设置的值优先；空值或仅空白字符的值会被忽略。适用于受控提示实验。 +将 OpenClaw 组装出的完整系统提示替换为固定字符串。可在默认级别设置（`agents.defaults.systemPromptOverride`），也可按智能体设置（`agents.list[].systemPromptOverride`）。按智能体的值优先；空值或仅空白字符的值会被忽略。适用于受控提示实验。 ```json5 { @@ -1198,7 +1209,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 ### `agents.defaults.heartbeat` -周期性 Heartbeat 运行。 +周期性 heartbeat 运行。 ```json5 { @@ -1208,12 +1219,12 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 every: "30m", // 0m 表示禁用 model: "openai/gpt-5.4-mini", includeReasoning: false, - includeSystemPromptSection: true, // 默认：true；false 会从系统提示中省略 Heartbeat 段 + includeSystemPromptSection: true, // 默认：true；false 会从系统提示中省略 Heartbeat 部分 lightContext: false, // 默认：false；true 仅保留 workspace bootstrap 文件中的 HEARTBEAT.md - isolatedSession: false, // 默认：false；true 会在全新会话中运行每次 Heartbeat（无会话历史） + isolatedSession: false, // 默认：false；true 会让每次 heartbeat 在全新会话中运行（无对话历史） session: "main", to: "+15555550123", - directPolicy: "allow", // allow（默认） | block + directPolicy: "allow", // allow（默认）| block target: "none", // 默认：none | 可选值：last | whatsapp | telegram | discord | ... prompt: "Read HEARTBEAT.md if it exists...", ackMaxChars: 300, @@ -1225,15 +1236,15 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 } ``` -- `every`：时长字符串（ms/s/m/h）。默认值：`30m`（API key 认证）或 `1h`（OAuth 认证）。设为 `0m` 可禁用。 -- `includeSystemPromptSection`：设为 false 时，会从系统提示中省略 Heartbeat 段，并跳过将 `HEARTBEAT.md` 注入 bootstrap 上下文。默认值：`true`。 -- `suppressToolErrorWarnings`：设为 true 时，会在 Heartbeat 运行期间抑制工具错误警告负载。 -- `timeoutSeconds`：Heartbeat 智能体回合在被中止前允许的最长秒数。若不设置，则使用 `agents.defaults.timeoutSeconds`。 -- `directPolicy`：直接/私信投递策略。`allow`（默认）允许直接目标投递。`block` 会阻止直接目标投递，并输出 `reason=dm-blocked`。 -- `lightContext`：设为 true 时，Heartbeat 运行会使用轻量 bootstrap 上下文，并且只保留 workspace bootstrap 文件中的 `HEARTBEAT.md`。 -- `isolatedSession`：设为 true 时，每次 Heartbeat 都会在一个没有先前会话历史的全新会话中运行。其隔离模式与 cron `sessionTarget: "isolated"` 相同。可将每次 Heartbeat 的 token 成本从约 100K 降低到约 2-5K。 -- 按智能体设置：使用 `agents.list[].heartbeat`。当任意智能体定义了 `heartbeat` 时，**只有这些智能体**会运行 Heartbeat。 -- Heartbeat 会运行完整的智能体回合——更短的间隔会消耗更多 token。 +- `every`：时长字符串（ms/s/m/h）。默认值：`30m`（API-key 认证）或 `1h`（OAuth 认证）。设置为 `0m` 可禁用。 +- `includeSystemPromptSection`：为 false 时，会从系统提示中省略 Heartbeat 部分，并跳过将 `HEARTBEAT.md` 注入 bootstrap 上下文。默认值：`true`。 +- `suppressToolErrorWarnings`：为 true 时，会在 heartbeat 运行期间抑制工具错误警告负载。 +- `timeoutSeconds`：heartbeat 智能体轮次在被中止前允许的最长秒数。若未设置，则使用 `agents.defaults.timeoutSeconds`。 +- `directPolicy`：直接/私信交付策略。`allow`（默认）允许直接目标交付。`block` 会阻止直接目标交付，并发出 `reason=dm-blocked`。 +- `lightContext`：为 true 时，heartbeat 运行会使用轻量 bootstrap 上下文，并且仅保留 workspace bootstrap 文件中的 `HEARTBEAT.md`。 +- `isolatedSession`：为 true 时，每次 heartbeat 都会在一个没有先前对话历史的全新会话中运行。与 cron `sessionTarget: "isolated"` 采用相同的隔离模式。可将每次 heartbeat 的 token 成本从约 100K 降低到约 2-5K。 +- 按智能体设置：使用 `agents.list[].heartbeat`。当任一智能体定义了 `heartbeat` 时，**只有这些智能体**会运行 heartbeat。 +- Heartbeat 会执行完整的智能体轮次 —— 更短的间隔会消耗更多 token。 ### `agents.defaults.compaction` @@ -1247,15 +1258,15 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 timeoutSeconds: 900, reserveTokensFloor: 24000, identifierPolicy: "strict", // strict | off | custom - identifierInstructions: "精确保留部署 ID、工单 ID 和 host:port 对。", // 当 identifierPolicy=custom 时使用 + identifierInstructions: "Preserve deployment IDs, ticket IDs, and host:port pairs exactly.", // 当 identifierPolicy=custom 时使用 postCompactionSections: ["Session Startup", "Red Lines"], // [] 表示禁用重新注入 - model: "openrouter/anthropic/claude-sonnet-4-6", // 仅用于 compaction 的可选模型覆盖 - notifyUser: true, // 在 compaction 开始时发送简短通知（默认：false） + model: "openrouter/anthropic/claude-sonnet-4-6", // 可选，仅用于 compaction 的模型覆盖 + notifyUser: true, // compaction 开始时向用户发送简短通知（默认：false） memoryFlush: { enabled: true, softThresholdTokens: 6000, - systemPrompt: "会话即将执行 compaction。现在存储持久记忆。", - prompt: "将任何持久笔记写入 memory/YYYY-MM-DD.md；如果没有要存储的内容，请回复精确的静默 token NO_REPLY。", + systemPrompt: "Session nearing compaction. Store durable memories now.", + prompt: "Write any lasting notes to memory/YYYY-MM-DD.md; reply with the exact silent token NO_REPLY if nothing to store.", }, }, }, @@ -1264,18 +1275,18 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 ``` - `mode`：`default` 或 `safeguard`（针对长历史的分块摘要）。参见 [Compaction](/zh-CN/concepts/compaction)。 -- `provider`：已注册 compaction 提供商插件的 id。设置后，会调用该提供商的 `summarize()`，而不是使用内置 LLM 摘要。失败时会回退到内置方式。设置提供商会强制启用 `mode: "safeguard"`。参见 [Compaction](/zh-CN/concepts/compaction)。 -- `timeoutSeconds`：OpenClaw 中止单次 compaction 操作前允许的最长秒数。默认值：`900`。 -- `identifierPolicy`：`strict`（默认）、`off` 或 `custom`。`strict` 会在 compaction 摘要期间预置内建的不透明标识符保留指导。 -- `identifierInstructions`：当 `identifierPolicy=custom` 时使用的可选自定义标识符保留说明文本。 -- `postCompactionSections`：在 compaction 后重新注入的可选 AGENTS.md H2/H3 段落名。默认值为 `["Session Startup", "Red Lines"]`；设为 `[]` 可禁用重新注入。未设置或显式设为该默认对时，也会接受旧版 `Every Session`/`Safety` 标题作为兼容回退。 -- `model`：仅用于 compaction 摘要的可选 `provider/model-id` 覆盖。当主会话需要保留某个模型，但希望 compaction 摘要改用另一个模型时使用；未设置时，compaction 会使用会话的主模型。 -- `notifyUser`：为 `true` 时，在 compaction 开始时向用户发送简短通知（例如 “正在压缩上下文...”）。默认禁用，以保持 compaction 静默。 -- `memoryFlush`：在自动 compaction 前执行静默的智能体回合，以存储持久记忆。当 workspace 为只读时会跳过。 +- `provider`：已注册 compaction 提供商插件的 id。设置后，会调用该提供商的 `summarize()`，而不是使用内置 LLM 摘要。失败时会回退到内置实现。设置提供商会强制 `mode: "safeguard"`。参见 [Compaction](/zh-CN/concepts/compaction)。 +- `timeoutSeconds`：OpenClaw 在中止前允许单次 compaction 操作运行的最长秒数。默认值：`900`。 +- `identifierPolicy`：`strict`（默认）、`off` 或 `custom`。`strict` 会在 compaction 摘要期间预先附加内置的不透明标识符保留指引。 +- `identifierInstructions`：当 `identifierPolicy=custom` 时使用的可选自定义标识符保留文本。 +- `postCompactionSections`：compaction 后重新注入的可选 AGENTS.md H2/H3 章节名。默认值为 `["Session Startup", "Red Lines"]`；设置为 `[]` 可禁用重新注入。未设置时，或显式设置为该默认对时，也会接受旧版 `Every Session`/`Safety` 标题作为兼容性回退。 +- `model`：可选的 `provider/model-id` 覆盖，仅用于 compaction 摘要。当主会话应保持使用某个模型，而 compaction 摘要应改用另一个模型时可使用此项；未设置时，compaction 使用会话的主模型。 +- `notifyUser`：为 `true` 时，compaction 开始时向用户发送简短通知（例如“正在压缩上下文...”）。默认禁用，以保持 compaction 静默。 +- `memoryFlush`：在自动 compaction 前执行静默的智能体轮次，用于存储持久 memory。workspace 为只读时会跳过。 ### `agents.defaults.contextPruning` -在发送给 LLM 之前，从内存上下文中裁剪**旧的工具结果**。**不会**修改磁盘上的会话历史。 +在发送给 LLM 之前，从内存上下文中修剪**旧的工具结果**。**不会**修改磁盘上的会话历史。 ```json5 { @@ -1289,7 +1300,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 hardClearRatio: 0.5, minPrunableToolChars: 50000, softTrim: { maxChars: 4000, headChars: 1500, tailChars: 1500 }, - hardClear: { enabled: true, placeholder: "[旧工具结果内容已清除]" }, + hardClear: { enabled: true, placeholder: "[Old tool result content cleared]" }, tools: { deny: ["browser", "canvas"] }, }, }, @@ -1299,23 +1310,23 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 -- `mode: "cache-ttl"` 会启用裁剪过程。 -- `ttl` 控制何时允许再次运行裁剪（自上次缓存触碰之后）。 -- 如有需要，裁剪会先对过大的工具结果执行软裁剪，然后再对较旧的工具结果执行硬清除。 +- `mode: "cache-ttl"` 会启用修剪流程。 +- `ttl` 控制多久之后才允许再次运行修剪（自上次缓存触碰后计算）。 +- 修剪会先对过大的工具结果做软裁剪，然后在需要时对更旧的工具结果做硬清除。 -**软裁剪** 会保留开头 + 结尾，并在中间插入 `...`。 +**软裁剪** 会保留开头和结尾，并在中间插入 `...`。 **硬清除** 会用占位符替换整个工具结果。 -说明： +注意： - 图像块永远不会被裁剪/清除。 -- 比例基于字符数（近似值），不是精确 token 数。 -- 如果 assistant 消息少于 `keepLastAssistants` 条，则会跳过裁剪。 +- 比例按字符计算（近似值），不是精确 token 数。 +- 如果 assistant 消息少于 `keepLastAssistants`，则会跳过修剪。 -行为详情参见 [Session Pruning](/zh-CN/concepts/session-pruning)。 +行为细节见 [Session Pruning](/zh-CN/concepts/session-pruning)。 ### 分块流式传输 @@ -1334,12 +1345,12 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 ``` - 非 Telegram 渠道需要显式设置 `*.blockStreaming: true` 才会启用分块回复。 -- 渠道级覆盖：`channels..blockStreamingCoalesce`（以及按账号变体）。Signal/Slack/Discord/Google Chat 默认使用 `minChars: 1500`。 +- 渠道覆盖：`channels..blockStreamingCoalesce`（以及按账号变体）。Signal/Slack/Discord/Google Chat 默认 `minChars: 1500`。 - `humanDelay`：分块回复之间的随机暂停。`natural` = 800–2500ms。按智能体覆盖：`agents.list[].humanDelay`。 -行为和分块细节参见 [Streaming](/zh-CN/concepts/streaming)。 +行为和分块细节见 [Streaming](/zh-CN/concepts/streaming)。 -### 输入中指示器 +### 输入指示器 ```json5 { @@ -1352,7 +1363,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 } ``` -- 默认值：私聊/被提及时为 `instant`，未被提及的群聊为 `message`。 +- 默认值：私聊/提及时为 `instant`，未提及的群聊为 `message`。 - 按会话覆盖：`session.typingMode`、`session.typingIntervalSeconds`。 参见 [Typing Indicators](/zh-CN/concepts/typing-indicators)。 @@ -1361,7 +1372,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 ### `agents.defaults.sandbox` -嵌入式智能体的可选沙箱隔离。完整指南参见 [Sandboxing](/zh-CN/gateway/sandboxing)。 +嵌入式智能体的可选沙箱隔离。完整指南见 [Sandboxing](/zh-CN/gateway/sandboxing)。 ```json5 { @@ -1461,37 +1472,37 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 **后端：** - `docker`：本地 Docker 运行时（默认） -- `ssh`：通用的 SSH 支持远程运行时 +- `ssh`：通用 SSH 支持的远程运行时 - `openshell`：OpenShell 运行时 -选择 `backend: "openshell"` 时，运行时专用设置会移到 +选择 `backend: "openshell"` 时，运行时特定设置会移到 `plugins.entries.openshell.config`。 **SSH 后端配置：** - `target`：`user@host[:port]` 形式的 SSH 目标 - `command`：SSH 客户端命令（默认：`ssh`） -- `workspaceRoot`：用于按作用域 workspace 的远程绝对根目录 +- `workspaceRoot`：供各作用域 workspace 使用的远程绝对根目录 - `identityFile` / `certificateFile` / `knownHostsFile`：传递给 OpenSSH 的现有本地文件 -- `identityData` / `certificateData` / `knownHostsData`：内联内容或 SecretRef，OpenClaw 会在运行时将其实体化为临时文件 -- `strictHostKeyChecking` / `updateHostKeys`：OpenSSH host-key 策略选项 +- `identityData` / `certificateData` / `knownHostsData`：内联内容或 SecretRef，OpenClaw 会在运行时将其物化为临时文件 +- `strictHostKeyChecking` / `updateHostKeys`：OpenSSH 主机密钥策略开关 **SSH 认证优先级：** - `identityData` 优先于 `identityFile` - `certificateData` 优先于 `certificateFile` - `knownHostsData` 优先于 `knownHostsFile` -- 由 SecretRef 支持的 `*Data` 值会在沙箱会话开始前从活动 secrets 运行时快照中解析 +- 由 SecretRef 支持的 `*Data` 值会在沙箱会话启动前，从当前 active secrets 运行时快照中解析 **SSH 后端行为：** -- 在创建或重建后对远程 workspace 执行一次初始化 -- 随后保持远程 SSH workspace 为规范副本 +- 在创建或重建后，先对远程 workspace 执行一次初始填充 +- 此后保持远程 SSH workspace 为规范副本 - 通过 SSH 路由 `exec`、文件工具和媒体路径 - 不会自动将远程变更同步回主机 - 不支持沙箱浏览器容器 -**Workspace 访问：** +**workspace 访问：** - `none`：在 `~/.openclaw/sandboxes` 下为每个作用域创建沙箱 workspace - `ro`：沙箱 workspace 位于 `/workspace`，智能体 workspace 以只读方式挂载到 `/agent` @@ -1531,30 +1542,30 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 **OpenShell 模式：** -- `mirror`：执行前从本地初始化到远程，执行后再同步回本地；本地 workspace 保持为规范副本 -- `remote`：仅在创建沙箱时向远程初始化一次，随后保持远程 workspace 为规范副本 +- `mirror`：执行前先从本地填充远程，执行后再同步回本地；本地 workspace 保持为规范副本 +- `remote`：仅在创建沙箱时向远程填充一次，此后保持远程 workspace 为规范副本 -在 `remote` 模式下，初始化之后，在 OpenClaw 外部对主机本地所做的编辑不会自动同步到沙箱中。 -传输方式是通过 SSH 进入 OpenShell 沙箱，但插件负责沙箱生命周期以及可选的镜像同步。 +在 `remote` 模式下，种子步骤之后，在 OpenClaw 之外于主机本地所做的编辑不会自动同步到沙箱中。 +传输通过 SSH 连接到 OpenShell 沙箱，但插件负责沙箱生命周期以及可选的镜像同步。 **`setupCommand`** 会在容器创建后运行一次（通过 `sh -lc`）。需要网络出口、可写根文件系统以及 root 用户。 **容器默认使用 `network: "none"`** —— 如果智能体需要出站访问，请设置为 `"bridge"`（或自定义 bridge 网络）。 默认会阻止 `"host"`。默认也会阻止 `"container:"`，除非你显式设置 -`sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true`（破窗模式）。 +`sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true`（紧急放行）。 -**入站附件** 会被暂存到活动 workspace 中的 `media/inbound/*`。 +**入站附件** 会被暂存到当前 workspace 的 `media/inbound/*` 中。 -**`docker.binds`** 会挂载额外的主机目录；全局和按智能体的 binds 会被合并。 +**`docker.binds`** 会挂载额外的主机目录；全局和按智能体的绑定会合并。 -**沙箱隔离浏览器**（`sandbox.browser.enabled`）：容器中的 Chromium + CDP。noVNC URL 会注入系统提示。无需在 `openclaw.json` 中启用 `browser.enabled`。 -noVNC 观察者访问默认使用 VNC 认证，OpenClaw 会发出短时有效的 token URL（而不是在共享 URL 中暴露密码）。 +**沙箱隔离浏览器**（`sandbox.browser.enabled`）：在容器中运行 Chromium + CDP。noVNC URL 会注入到系统提示中。无需在 `openclaw.json` 中启用 `browser.enabled`。 +noVNC 观察者访问默认使用 VNC 身份验证，OpenClaw 会发出一个短时有效的 token URL（而不是在共享 URL 中暴露密码）。 -- `allowHostControl: false`（默认）会阻止沙箱隔离会话将目标指向主机浏览器。 -- `network` 默认为 `openclaw-sandbox-browser`（专用 bridge 网络）。只有在你明确需要全局 bridge 连通性时才设置为 `bridge`。 -- `cdpSourceRange` 可选地将容器边界处的 CDP 入站限制为某个 CIDR 范围（例如 `172.21.0.1/32`）。 -- `sandbox.browser.binds` 仅会为沙箱隔离浏览器容器挂载额外的主机目录。设置后（包括 `[]`）它会替代浏览器容器上的 `docker.binds`。 -- 启动默认值定义在 `scripts/sandbox-browser-entrypoint.sh` 中，并针对容器主机进行了调优： +- `allowHostControl: false`（默认）会阻止沙箱隔离会话以主机浏览器为目标。 +- `network` 默认为 `openclaw-sandbox-browser`（专用 bridge 网络）。仅当你明确需要全局 bridge 连通性时才设置为 `bridge`。 +- `cdpSourceRange` 可选地将容器边缘的 CDP 入站流量限制为某个 CIDR 范围（例如 `172.21.0.1/32`）。 +- `sandbox.browser.binds` 仅为沙箱隔离浏览器容器挂载额外的主机目录。设置后（包括 `[]`），它会替换浏览器容器的 `docker.binds`。 +- 启动默认值定义于 `scripts/sandbox-browser-entrypoint.sh`，并针对容器主机进行了调优： - `--remote-debugging-address=127.0.0.1` - `--remote-debugging-port=` - `--user-data-dir=${HOME}/.chrome` @@ -1572,11 +1583,11 @@ noVNC 观察者访问默认使用 VNC 认证，OpenClaw 会发出短时有效的 - `--no-zygote` - `--metrics-recording-only` - `--disable-extensions`（默认启用） - - `--disable-3d-apis`、`--disable-software-rasterizer` 和 `--disable-gpu` 默认启用；如果 WebGL/3D 使用需要它们，可通过设置 `OPENCLAW_BROWSER_DISABLE_GRAPHICS_FLAGS=0` 来禁用这些标志。 - - `OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0` 会重新启用扩展，如果你的工作流依赖它们。 - - `--renderer-process-limit=2` 可通过 `OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=` 修改；设为 `0` 则使用 Chromium 的默认进程限制。 - - 另外，当启用 `noSandbox` 时，还会加上 `--no-sandbox` 和 `--disable-setuid-sandbox`。 - - 这些默认值是容器镜像的基线；如需修改容器默认行为，请使用自定义浏览器镜像和自定义入口点。 + - 默认会启用 `--disable-3d-apis`、`--disable-software-rasterizer` 和 `--disable-gpu`，如果你的工作流需要使用 WebGL/3D，可通过设置 `OPENCLAW_BROWSER_DISABLE_GRAPHICS_FLAGS=0` 来禁用这些选项。 + - 如果你的工作流依赖扩展，可通过 `OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0` 重新启用扩展。 + - `--renderer-process-limit=2` 可通过 `OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=` 修改；设为 `0` 则使用 Chromium 的默认进程上限。 + - 当启用 `noSandbox` 时，还会额外使用 `--no-sandbox` 和 `--disable-setuid-sandbox`。 + - 这些默认值是容器镜像的基线；如需更改容器默认值，请使用带有自定义 entrypoint 的自定义浏览器镜像。 @@ -1602,12 +1613,12 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 workspace: "~/.openclaw/workspace", agentDir: "~/.openclaw/agents/main/agent", model: "anthropic/claude-opus-4-6", // 或 { primary, fallbacks } - thinkingDefault: "high", // 按智能体覆盖 thinking 级别 - reasoningDefault: "on", // 按智能体覆盖 reasoning 可见性 - fastModeDefault: false, // 按智能体覆盖 fast mode + thinkingDefault: "high", // 按智能体覆盖的默认 thinking 级别 + reasoningDefault: "on", // 按智能体覆盖的默认 reasoning 可见性 + fastModeDefault: false, // 按智能体覆盖的默认 fast mode embeddedHarness: { runtime: "auto", fallback: "pi" }, params: { cacheRetention: "none" }, // 按键覆盖匹配 defaults.models params - skills: ["docs-search"], // 设置后会替代 agents.defaults.skills + skills: ["docs-search"], // 设置后替换 agents.defaults.skills identity: { name: "Samantha", theme: "helpful sloth", @@ -1639,26 +1650,26 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 ``` - `id`：稳定的智能体 id（必填）。 -- `default`：如果设置了多个，以第一个为准（会记录警告）。如果一个都没设置，则列表第一项为默认值。 -- `model`：字符串形式仅覆盖 `primary`；对象形式 `{ primary, fallbacks }` 会同时覆盖两者（`[]` 会禁用全局回退）。仅覆盖 `primary` 的 cron 作业仍会继承默认回退，除非你设置 `fallbacks: []`。 -- `params`：按智能体的流参数，会合并覆盖到 `agents.defaults.models` 中所选模型条目之上。适合用于 `cacheRetention`、`temperature` 或 `maxTokens` 这类按智能体覆盖，而无需复制整个模型目录。 -- `skills`：可选的按智能体 Skills allowlist。若省略，在设置了 `agents.defaults.skills` 时会继承它；显式列表会替代默认值而不是合并，`[]` 表示不启用任何 Skills。 -- `thinkingDefault`：可选的按智能体默认 thinking 级别（`off | minimal | low | medium | high | xhigh | adaptive`）。当未设置按消息或按会话覆盖时，它会覆盖该智能体的 `agents.defaults.thinkingDefault`。 -- `reasoningDefault`：可选的按智能体默认 reasoning 可见性（`on | off | stream`）。当未设置按消息或按会话 reasoning 覆盖时应用。 -- `fastModeDefault`：可选的按智能体默认 fast mode（`true | false`）。当未设置按消息或按会话 fast mode 覆盖时应用。 +- `default`：若设置了多个，则第一个生效（会记录警告）。若一个都未设置，则列表中的第一个条目为默认值。 +- `model`：字符串形式只覆盖 `primary`；对象形式 `{ primary, fallbacks }` 同时覆盖两者（`[]` 会禁用全局回退）。仅覆盖 `primary` 的 cron 作业仍会继承默认回退，除非你设置 `fallbacks: []`。 +- `params`：按智能体设置的流式参数，会合并覆盖到 `agents.defaults.models` 中所选模型条目之上。用于设置特定智能体覆盖项，例如 `cacheRetention`、`temperature` 或 `maxTokens`，而无需复制整个模型目录。 +- `skills`：可选的按智能体 Skills 允许列表。若省略，则在已设置时继承 `agents.defaults.skills`；显式列表会替换默认值而不是合并，`[]` 表示不启用任何 Skills。 +- `thinkingDefault`：可选的按智能体默认 thinking 级别（`off | minimal | low | medium | high | xhigh | adaptive`）。在未设置按消息或会话覆盖时，会覆盖该智能体的 `agents.defaults.thinkingDefault`。 +- `reasoningDefault`：可选的按智能体默认 reasoning 可见性（`on | off | stream`）。在未设置按消息或会话 reasoning 覆盖时生效。 +- `fastModeDefault`：可选的按智能体 fast mode 默认值（`true | false`）。在未设置按消息或会话 fast-mode 覆盖时生效。 - `embeddedHarness`：可选的按智能体底层 harness 策略覆盖。使用 `{ runtime: "codex", fallback: "none" }` 可让某个智能体仅使用 Codex，而其他智能体保留默认的 PI 回退。 -- `runtime`：可选的按智能体运行时描述符。当某个智能体应默认使用 ACP harness 会话时，使用 `type: "acp"` 和 `runtime.acp` 默认值（`agent`、`backend`、`mode`、`cwd`）。 +- `runtime`：可选的按智能体运行时描述符。当智能体应默认使用 ACP harness 会话时，可使用 `type: "acp"` 并设置 `runtime.acp` 默认值（`agent`、`backend`、`mode`、`cwd`）。 - `identity.avatar`：相对于 workspace 的路径、`http(s)` URL 或 `data:` URI。 - `identity` 会派生默认值：`ackReaction` 来自 `emoji`，`mentionPatterns` 来自 `name`/`emoji`。 -- `subagents.allowAgents`：`sessions_spawn` 允许的智能体 id 列表（`["*"]` = 任意；默认：仅限相同智能体）。 -- 沙箱继承防护：如果请求方会话处于沙箱隔离中，`sessions_spawn` 会拒绝运行目标为非沙箱隔离的情况。 -- `subagents.requireAgentId`：设为 true 时，会阻止省略 `agentId` 的 `sessions_spawn` 调用（强制显式选择配置；默认：false）。 +- `subagents.allowAgents`：用于 `sessions_spawn` 的智能体 id 允许列表（`["*"]` = 任意；默认：仅同一智能体）。 +- 沙箱继承保护：如果请求方会话处于沙箱隔离中，`sessions_spawn` 会拒绝那些会以非沙箱方式运行的目标。 +- `subagents.requireAgentId`：为 true 时，阻止省略 `agentId` 的 `sessions_spawn` 调用（强制显式选择配置；默认：false）。 --- ## 多智能体路由 -在一个 Gateway 网关内运行多个相互隔离的智能体。参见 [Multi-Agent](/zh-CN/concepts/multi-agent)。 +在一个 Gateway 网关 中运行多个彼此隔离的智能体。参见 [Multi-Agent](/zh-CN/concepts/multi-agent)。 ```json5 { @@ -1677,11 +1688,11 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 ### 绑定匹配字段 -- `type`（可选）：`route` 用于普通路由（缺失时默认是 route），`acp` 用于持久化 ACP 会话绑定。 +- `type`（可选）：普通路由使用 `route`（缺失时默认即为 route），持久 ACP 会话绑定使用 `acp` - `match.channel`（必填） - `match.accountId`（可选；`*` = 任意账号；省略 = 默认账号） - `match.peer`（可选；`{ kind: direct|group|channel, id }`） -- `match.guildId` / `match.teamId`（可选；渠道专用） +- `match.guildId` / `match.teamId`（可选；渠道特定） - `acp`（可选；仅适用于 `type: "acp"`）：`{ mode, label, cwd, backend }` **确定性匹配顺序：** @@ -1695,9 +1706,9 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 在每一层级内，第一个匹配的 `bindings` 条目获胜。 -对于 `type: "acp"` 条目，OpenClaw 会按精确会话身份（`match.channel` + 账号 + `match.peer.id`）解析，不使用上面的 route 绑定层级顺序。 +对于 `type: "acp"` 条目，OpenClaw 会按精确会话身份（`match.channel` + 账号 + `match.peer.id`）解析，不使用上述 route 绑定层级顺序。 -### 按智能体划分的访问配置 +### 按智能体访问配置 @@ -1792,7 +1803,7 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 -优先级细节参见 [Multi-Agent Sandbox & Tools](/zh-CN/tools/multi-agent-sandbox-tools)。 +优先级细节见 [Multi-Agent Sandbox & Tools](/zh-CN/tools/multi-agent-sandbox-tools)。 --- @@ -1818,7 +1829,7 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 }, resetTriggers: ["/new", "/reset"], store: "~/.openclaw/agents/{agentId}/sessions/sessions.json", - parentForkMaxTokens: 100000, // 超过该 token 数时跳过父线程 fork（0 表示禁用） + parentForkMaxTokens: 100000, // 超过此 token 数时跳过父线程 fork（0 表示禁用） maintenance: { mode: "warn", // warn | enforce pruneAfter: "30d", @@ -1830,10 +1841,10 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 }, threadBindings: { enabled: true, - idleHours: 24, // 默认按小时计算的无活动自动取消聚焦（`0` 表示禁用） - maxAgeHours: 0, // 默认按小时计算的硬性最大时长（`0` 表示禁用） + idleHours: 24, // 默认按小时计的非活动自动取消聚焦（`0` 表示禁用） + maxAgeHours: 0, // 默认按小时计的硬性最大存活时长（`0` 表示禁用） }, - mainKey: "main", // 旧版（运行时始终使用 "main"） + mainKey: "main", // 旧版字段（运行时始终使用 "main"） agentToAgent: { maxPingPongTurns: 5 }, sendPolicy: { rules: [{ action: "deny", match: { channel: "discord", chatType: "group" } }], @@ -1846,34 +1857,34 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 - **`scope`**：群聊上下文的基础会话分组策略。 - - `per-sender`（默认）：在某个渠道上下文中，每个发送者拥有独立会话。 - - `global`：某个渠道上下文中的所有参与者共享一个会话（仅在你明确需要共享上下文时使用）。 -- **`dmScope`**：私信的分组方式。 + - `per-sender`（默认）：在同一渠道上下文中，每个发送者都有独立会话。 + - `global`：同一渠道上下文中的所有参与者共享一个会话（仅在确实需要共享上下文时使用）。 +- **`dmScope`**：私信如何分组。 - `main`：所有私信共享主会话。 - `per-peer`：按发送者 id 跨渠道隔离。 - `per-channel-peer`：按渠道 + 发送者隔离（推荐用于多用户收件箱）。 - `per-account-channel-peer`：按账号 + 渠道 + 发送者隔离（推荐用于多账号）。 - **`identityLinks`**：将规范 id 映射到带提供商前缀的对端，以实现跨渠道会话共享。 -- **`reset`**：主要重置策略。`daily` 会在本地时间 `atHour` 重置；`idle` 会在 `idleMinutes` 后重置。当两者都已配置时，以先到期者为准。 -- **`resetByType`**：按类型覆盖（`direct`、`group`、`thread`）。旧版 `dm` 可作为 `direct` 的别名使用。 -- **`parentForkMaxTokens`**：创建 fork 线程会话时，允许的父会话 `totalTokens` 最大值（默认 `100000`）。 - - 如果父会话的 `totalTokens` 高于此值，OpenClaw 会启动一个全新的线程会话，而不是继承父转录历史。 - - 设为 `0` 可禁用此防护，并始终允许从父会话 fork。 +- **`reset`**：主重置策略。`daily` 会在本地时间 `atHour` 重置；`idle` 会在 `idleMinutes` 后重置。若两者都已配置，则以先到期者为准。 +- **`resetByType`**：按类型覆盖（`direct`、`group`、`thread`）。旧版 `dm` 可作为 `direct` 的别名。 +- **`parentForkMaxTokens`**：创建 fork 线程会话时允许的父会话 `totalTokens` 上限（默认 `100000`）。 + - 如果父会话的 `totalTokens` 高于该值，OpenClaw 会启动一个全新的线程会话，而不是继承父级转录历史。 + - 设置为 `0` 可禁用此保护，并始终允许父级 fork。 - **`mainKey`**：旧版字段。运行时始终对主私聊桶使用 `"main"`。 -- **`agentToAgent.maxPingPongTurns`**：智能体之间交换消息时，允许的最大来回回复轮数（整数，范围：`0`–`5`）。`0` 会禁用 ping-pong 链式回复。 -- **`sendPolicy`**：按 `channel`、`chatType`（`direct|group|channel`，旧版 `dm` 也可作为别名）、`keyPrefix` 或 `rawKeyPrefix` 匹配。第一个 deny 规则优先。 +- **`agentToAgent.maxPingPongTurns`**：智能体之间在智能体对智能体交互期间允许的最大来回回复轮数（整数，范围：`0`–`5`）。`0` 表示禁用 ping-pong 链。 +- **`sendPolicy`**：可按 `channel`、`chatType`（`direct|group|channel`，旧版 `dm` 可作别名）、`keyPrefix` 或 `rawKeyPrefix` 进行匹配。第一个 deny 优先生效。 - **`maintenance`**：会话存储清理 + 保留控制。 - - `mode`：`warn` 仅发出警告；`enforce` 会实际执行清理。 - - `pruneAfter`：陈旧条目的年龄截止值（默认 `30d`）。 + - `mode`：`warn` 仅发出警告；`enforce` 实施清理。 + - `pruneAfter`：过期条目的年龄截止值（默认 `30d`）。 - `maxEntries`：`sessions.json` 中条目的最大数量（默认 `500`）。 - `rotateBytes`：当 `sessions.json` 超过该大小时进行轮转（默认 `10mb`）。 - - `resetArchiveRetention`：`*.reset.` 转录归档的保留期。默认继承 `pruneAfter`；设为 `false` 可禁用。 - - `maxDiskBytes`：可选的会话目录磁盘预算。在 `warn` 模式下会记录警告；在 `enforce` 模式下会优先删除最旧的制品/会话。 + - `resetArchiveRetention`：`*.reset.` 转录归档的保留期。默认等于 `pruneAfter`；设置为 `false` 可禁用。 + - `maxDiskBytes`：可选的会话目录磁盘预算。在 `warn` 模式下仅记录警告；在 `enforce` 模式下会优先移除最旧的产物/会话。 - `highWaterBytes`：预算清理后的可选目标值。默认是 `maxDiskBytes` 的 `80%`。 - **`threadBindings`**：线程绑定会话功能的全局默认值。 - `enabled`：主默认开关（提供商可覆盖；Discord 使用 `channels.discord.threadBindings.enabled`） - - `idleHours`：按小时计算的默认无活动自动取消聚焦时间（`0` 表示禁用；提供商可覆盖） - - `maxAgeHours`：按小时计算的默认硬性最大时长（`0` 表示禁用；提供商可覆盖） + - `idleHours`：默认的按小时计非活动自动取消聚焦时间（`0` 表示禁用；提供商可覆盖） + - `maxAgeHours`：默认的按小时计硬性最大存活时长（`0` 表示禁用；提供商可覆盖） @@ -1909,17 +1920,17 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 } ``` -### 响应前缀 +### 回复前缀 按渠道/账号覆盖：`channels..responsePrefix`、`channels..accounts..responsePrefix`。 -解析顺序（越具体越优先）：账号 → 渠道 → 全局。`""` 会禁用并停止级联。`"auto"` 会派生为 `[{identity.name}]`。 +解析顺序（最具体者优先）：账号 → 渠道 → 全局。`""` 会禁用并停止继续级联。`"auto"` 会派生为 `[{identity.name}]`。 **模板变量：** | 变量 | 说明 | 示例 | | ----------------- | ---------------- | --------------------------- | -| `{model}` | 短模型名 | `claude-opus-4-6` | +| `{model}` | 简短模型名 | `claude-opus-4-6` | | `{modelFull}` | 完整模型标识符 | `anthropic/claude-opus-4-6` | | `{provider}` | 提供商名称 | `anthropic` | | `{thinkingLevel}` | 当前 thinking 级别 | `high`、`low`、`off` | @@ -1929,20 +1940,20 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 ### 确认 reaction -- 默认使用活动智能体的 `identity.emoji`，否则为 `"👀"`。设为 `""` 可禁用。 +- 默认使用活动智能体的 `identity.emoji`，否则为 `"👀"`。设置为 `""` 可禁用。 - 按渠道覆盖：`channels..ackReaction`、`channels..accounts..ackReaction`。 - 解析顺序：账号 → 渠道 → `messages.ackReaction` → identity 回退。 -- 作用范围：`group-mentions`（默认）、`group-all`、`direct`、`all`。 -- `removeAckAfterReply`：在 Slack、Discord 和 Telegram 上于回复后移除确认 reaction。 +- 作用域：`group-mentions`（默认）、`group-all`、`direct`、`all`。 +- `removeAckAfterReply`：在 Slack、Discord 和 Telegram 上回复后移除 ack。 - `messages.statusReactions.enabled`：在 Slack、Discord 和 Telegram 上启用生命周期状态 reactions。 - 在 Slack 和 Discord 上，未设置时，如果确认 reactions 处于启用状态，则状态 reactions 保持启用。 + 在 Slack 和 Discord 上，若未设置，当 ack reactions 处于活动状态时会保持状态 reactions 启用。 在 Telegram 上，需显式设为 `true` 才会启用生命周期状态 reactions。 -### 入站防抖 +### 入站去抖 -将同一发送者的快速纯文本消息合并为单个智能体回合。媒体/附件会立即刷新。控制命令会绕过防抖。 +将来自同一发送者的快速纯文本消息合并为一次智能体轮次。媒体/附件会立即刷新。控制命令会绕过去抖。 -### TTS（text-to-speech） +### TTS（文本转语音） ```json5 { @@ -1983,12 +1994,12 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 } ``` -- `auto` 用于控制默认的自动 TTS 模式：`off`、`always`、`inbound` 或 `tagged`。`/tts on|off` 可覆盖本地偏好，`/tts status` 会显示生效状态。 -- `summaryModel` 会覆盖自动摘要所使用的 `agents.defaults.model.primary`。 -- `modelOverrides` 默认启用；`modelOverrides.allowProvider` 默认为 `false`（需显式启用）。 +- `auto` 控制默认自动 TTS 模式：`off`、`always`、`inbound` 或 `tagged`。`/tts on|off` 可覆盖本地偏好，`/tts status` 会显示实际生效状态。 +- `summaryModel` 会覆盖用于自动摘要的 `agents.defaults.model.primary`。 +- `modelOverrides` 默认启用；`modelOverrides.allowProvider` 默认值为 `false`（需显式启用）。 - API key 会回退到 `ELEVENLABS_API_KEY`/`XI_API_KEY` 和 `OPENAI_API_KEY`。 - `openai.baseUrl` 会覆盖 OpenAI TTS 端点。解析顺序为配置值，然后 `OPENAI_TTS_BASE_URL`，最后是 `https://api.openai.com/v1`。 -- 当 `openai.baseUrl` 指向非 OpenAI 端点时，OpenClaw 会将其视为兼容 OpenAI 的 TTS 服务器，并放宽模型/语音校验。 +- 当 `openai.baseUrl` 指向非 OpenAI 端点时，OpenClaw 会将其视为 OpenAI 兼容 TTS 服务器，并放宽模型/语音校验。 --- @@ -2019,12 +2030,12 @@ Talk 模式的默认值（macOS/iOS/Android）。 ``` - 当配置了多个 Talk 提供商时，`talk.provider` 必须匹配 `talk.providers` 中的某个键。 -- 旧版扁平 Talk 键（`talk.voiceId`、`talk.voiceAliases`、`talk.modelId`、`talk.outputFormat`、`talk.apiKey`）仅用于兼容，并会自动迁移到 `talk.providers.`。 +- 旧版扁平 Talk 键（`talk.voiceId`、`talk.voiceAliases`、`talk.modelId`、`talk.outputFormat`、`talk.apiKey`）仅用于兼容，会自动迁移到 `talk.providers.` 中。 - Voice ID 会回退到 `ELEVENLABS_VOICE_ID` 或 `SAG_VOICE_ID`。 - `providers.*.apiKey` 接受明文字符串或 SecretRef 对象。 -- 仅当未配置 Talk API key 时，才会应用 `ELEVENLABS_API_KEY` 回退。 +- 只有在未配置 Talk API key 时，才会使用 `ELEVENLABS_API_KEY` 回退。 - `providers.*.voiceAliases` 允许 Talk 指令使用友好名称。 -- `silenceTimeoutMs` 控制 Talk 模式在用户静默后等待多长时间再发送转录。未设置时会保留平台默认暂停窗口（`macOS 和 Android 为 700 ms，iOS 为 900 ms`）。 +- `silenceTimeoutMs` 控制 Talk 模式在用户静音后等待多长时间才发送转录。未设置时保持平台默认停顿窗口（`macOS 和 Android 为 700 ms，iOS 为 900 ms`）。 --- @@ -2032,37 +2043,37 @@ Talk 模式的默认值（macOS/iOS/Android）。 ### 工具配置 -`tools.profile` 会在应用 `tools.allow`/`tools.deny` 之前设置基础 allowlist： +`tools.profile` 会在 `tools.allow`/`tools.deny` 之前设置基础允许列表： -本地新手引导会在未设置时，将新的本地配置默认设为 `tools.profile: "coding"`（已存在的显式配置不会被更改）。 +本地新手引导在未设置时，会将新的本地配置默认设为 `tools.profile: "coding"`（现有的显式配置会保留）。 -| 配置 | 包含内容 | -| ------------ | ------------------------------------------------------------------------------------------------------------------------- | -| `minimal` | 仅 `session_status` | -| `coding` | `group:fs`、`group:runtime`、`group:web`、`group:sessions`、`group:memory`、`cron`、`image`、`image_generate`、`video_generate` | -| `messaging` | `group:messaging`、`sessions_list`、`sessions_history`、`sessions_send`、`session_status` | -| `full` | 无限制（与未设置相同） | +| 配置 | 包含内容 | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `minimal` | 仅 `session_status` | +| `coding` | `group:fs`、`group:runtime`、`group:web`、`group:sessions`、`group:memory`、`cron`、`image`、`image_generate`、`video_generate` | +| `messaging` | `group:messaging`、`sessions_list`、`sessions_history`、`sessions_send`、`session_status` | +| `full` | 无限制（与未设置相同） | ### 工具组 | 组 | 工具 | | ------------------ | ----------------------------------------------------------------------------------------------------------------------- | -| `group:runtime` | `exec`、`process`、`code_execution`（`bash` 可作为 `exec` 的别名使用） | -| `group:fs` | `read`、`write`、`edit`、`apply_patch` | +| `group:runtime` | `exec`、`process`、`code_execution`（`bash` 可作为 `exec` 的别名） | +| `group:fs` | `read`、`write`、`edit`、`apply_patch` | | `group:sessions` | `sessions_list`、`sessions_history`、`sessions_send`、`sessions_spawn`、`sessions_yield`、`subagents`、`session_status` | -| `group:memory` | `memory_search`、`memory_get` | -| `group:web` | `web_search`、`x_search`、`web_fetch` | -| `group:ui` | `browser`、`canvas` | -| `group:automation` | `cron`、`gateway` | -| `group:messaging` | `message` | -| `group:nodes` | `nodes` | -| `group:agents` | `agents_list` | -| `group:media` | `image`、`image_generate`、`video_generate`、`tts` | -| `group:openclaw` | 所有内置工具（不包括提供商插件） | +| `group:memory` | `memory_search`、`memory_get` | +| `group:web` | `web_search`、`x_search`、`web_fetch` | +| `group:ui` | `browser`、`canvas` | +| `group:automation` | `cron`、`gateway` | +| `group:messaging` | `message` | +| `group:nodes` | `nodes` | +| `group:agents` | `agents_list` | +| `group:media` | `image`、`image_generate`、`video_generate`、`tts` | +| `group:openclaw` | 所有内置工具（不包括提供商插件） | ### `tools.allow` / `tools.deny` -全局工具允许/拒绝策略（拒绝优先）。不区分大小写，支持 `*` 通配符。即使 Docker 沙箱隔离关闭时也会应用。 +全局工具允许/拒绝策略（拒绝优先）。不区分大小写，支持 `*` 通配符。即使 Docker 沙箱已关闭也会应用。 ```json5 { @@ -2072,7 +2083,7 @@ Talk 模式的默认值（macOS/iOS/Android）。 ### `tools.byProvider` -进一步限制特定提供商或模型的工具。顺序为：基础配置 → 提供商配置 → allow/deny。 +进一步为特定提供商或模型限制工具。顺序：基础配置 → 提供商配置 → allow/deny。 ```json5 { @@ -2088,7 +2099,7 @@ Talk 模式的默认值（macOS/iOS/Android）。 ### `tools.elevated` -控制沙箱外部的 elevated exec 访问： +控制沙箱外的 elevated exec 访问： ```json5 { @@ -2104,9 +2115,9 @@ Talk 模式的默认值（macOS/iOS/Android）。 } ``` -- 按智能体覆盖（`agents.list[].tools.elevated`）只能进一步收紧限制。 +- 按智能体覆盖（`agents.list[].tools.elevated`）只能进一步收紧。 - `/elevated on|off|ask|full` 会按会话存储状态；内联指令仅作用于单条消息。 -- elevated `exec` 会绕过沙箱隔离，并使用已配置的逃逸路径（默认是 `gateway`，若 exec 目标是 `node` 则使用 `node`）。 +- Elevated `exec` 会绕过沙箱隔离，并使用已配置的逃逸路径（默认是 `gateway`，当 exec 目标是 `node` 时则为 `node`）。 ### `tools.exec` @@ -2130,8 +2141,8 @@ Talk 模式的默认值（macOS/iOS/Android）。 ### `tools.loopDetection` -工具循环安全检查默认**禁用**。设置 `enabled: true` 以启用检测。 -可在 `tools.loopDetection` 中定义全局设置，并在 `agents.list[].tools.loopDetection` 中按智能体覆盖。 +工具循环安全检查默认**关闭**。设置 `enabled: true` 可启用检测。 +设置可在全局 `tools.loopDetection` 中定义，并在按智能体的 `agents.list[].tools.loopDetection` 中覆盖。 ```json5 { @@ -2152,14 +2163,14 @@ Talk 模式的默认值（macOS/iOS/Android）。 } ``` -- `historySize`：用于循环分析保留的最大工具调用历史。 -- `warningThreshold`：重复无进展模式触发警告的阈值。 -- `criticalThreshold`：阻止严重循环的更高重复阈值。 -- `globalCircuitBreakerThreshold`：任意无进展运行的硬停止阈值。 +- `historySize`：为循环分析保留的最大工具调用历史。 +- `warningThreshold`：针对重复无进展模式发出警告的阈值。 +- `criticalThreshold`：用于阻止严重循环的更高重复阈值。 +- `globalCircuitBreakerThreshold`：任何无进展运行的硬停止阈值。 - `detectors.genericRepeat`：对重复的同工具/同参数调用发出警告。 -- `detectors.knownPollNoProgress`：对已知轮询工具（`process.poll`、`command_status` 等）的无进展情况发出警告/阻止。 -- `detectors.pingPong`：对交替出现的无进展成对模式发出警告/阻止。 -- 如果 `warningThreshold >= criticalThreshold` 或 `criticalThreshold >= globalCircuitBreakerThreshold`，验证会失败。 +- `detectors.knownPollNoProgress`：对已知轮询工具（`process.poll`、`command_status` 等）的无进展模式发出警告/阻止。 +- `detectors.pingPong`：对交替出现的无进展配对模式发出警告/阻止。 +- 如果 `warningThreshold >= criticalThreshold` 或 `criticalThreshold >= globalCircuitBreakerThreshold`，则验证失败。 ### `tools.web` @@ -2176,7 +2187,7 @@ Talk 模式的默认值（macOS/iOS/Android）。 }, fetch: { enabled: true, - provider: "firecrawl", // 可选；省略时自动检测 + provider: "firecrawl", // 可选；省略则自动检测 maxChars: 50000, maxCharsCap: 50000, maxResponseBytes: 2000000, @@ -2248,9 +2259,9 @@ Talk 模式的默认值（macOS/iOS/Android）。 **异步完成字段：** -- `asyncCompletion.directSend`：设为 `true` 时，已完成的异步 `music_generate` - 和 `video_generate` 任务会先尝试直接投递到渠道。默认值：`false` - （保留旧版请求方会话唤醒/模型投递路径）。 +- `asyncCompletion.directSend`：为 `true` 时，已完成的异步 `music_generate` + 和 `video_generate` 任务会优先尝试直接渠道交付。默认值：`false` + （旧版的请求者会话唤醒/模型交付路径）。 @@ -2269,9 +2280,9 @@ Talk 模式的默认值（macOS/iOS/Android）。 ### `tools.sessions` -控制 session 工具（`sessions_list`、`sessions_history`、`sessions_send`）可以面向哪些会话。 +控制哪些会话可以被会话工具（`sessions_list`、`sessions_history`、`sessions_send`）作为目标。 -默认值：`tree`（当前会话 + 由其生成的会话，例如 subagents）。 +默认值：`tree`（当前会话 + 由其派生的会话，例如子智能体）。 ```json5 { @@ -2284,13 +2295,13 @@ Talk 模式的默认值（macOS/iOS/Android）。 } ``` -说明： +注意： - `self`：仅当前会话键。 -- `tree`：当前会话 + 由当前会话生成的会话（subagents）。 -- `agent`：属于当前智能体 id 的任意会话（如果你在同一智能体 id 下运行按发送者划分的会话，则可能包含其他用户）。 -- `all`：任意会话。跨智能体定向仍需要 `tools.agentToAgent`。 -- 沙箱限制：当当前会话处于沙箱隔离中且 `agents.defaults.sandbox.sessionToolsVisibility="spawned"` 时，即使 `tools.sessions.visibility="all"`，可见性也会被强制为 `tree`。 +- `tree`：当前会话 + 由当前会话派生的会话（子智能体）。 +- `agent`：属于当前智能体 id 的任意会话（如果你在同一智能体 id 下运行按发送者区分的会话，可能包含其他用户）。 +- `all`：任意会话。跨智能体目标仍需要 `tools.agentToAgent`。 +- 沙箱钳制：当当前会话处于沙箱隔离中，且 `agents.defaults.sandbox.sessionToolsVisibility="spawned"` 时，即使 `tools.sessions.visibility="all"`，可见性也会被强制为 `tree`。 ### `tools.sessions_spawn` @@ -2302,28 +2313,28 @@ Talk 模式的默认值（macOS/iOS/Android）。 sessions_spawn: { attachments: { enabled: false, // 显式启用：设为 true 以允许内联文件附件 - maxTotalBytes: 5242880, // 所有文件合计 5 MB + maxTotalBytes: 5242880, // 所有文件总计 5 MB maxFiles: 50, maxFileBytes: 1048576, // 每个文件 1 MB - retainOnSessionKeep: false, // 当 cleanup="keep" 时保留附件 + retainOnSessionKeep: false, // cleanup="keep" 时保留附件 }, }, }, } ``` -说明： +注意： -- 附件仅支持 `runtime: "subagent"`。ACP 运行时会拒绝它们。 -- 文件会实体化到子 workspace 的 `.openclaw/attachments//` 中，并附带一个 `.manifest.json`。 +- 仅 `runtime: "subagent"` 支持附件。ACP 运行时会拒绝它们。 +- 文件会被物化到子 workspace 的 `.openclaw/attachments//` 中，并带有一个 `.manifest.json`。 - 附件内容会自动从转录持久化中脱敏。 -- Base64 输入会使用严格的字母表/填充校验以及解码前大小防护进行验证。 -- 文件权限为目录 `0700`、文件 `0600`。 -- 清理由 `cleanup` 策略控制：`delete` 总会删除附件；`keep` 仅在 `retainOnSessionKeep: true` 时保留它们。 +- Base64 输入会通过严格的字母表/填充检查以及解码前大小保护进行验证。 +- 目录权限为 `0700`，文件权限为 `0600`。 +- 清理由 `cleanup` 策略控制：`delete` 总会移除附件；`keep` 仅在 `retainOnSessionKeep: true` 时保留。 ### `tools.experimental` -实验性内置工具开关。默认关闭，除非严格智能体式 GPT-5 自动启用规则适用。 +实验性内置工具开关。默认关闭，除非严格 agentic GPT-5 自动启用规则生效。 ```json5 { @@ -2335,11 +2346,11 @@ Talk 模式的默认值（macOS/iOS/Android）。 } ``` -说明： +注意： - `planTool`：为非平凡的多步骤工作跟踪启用结构化 `update_plan` 工具。 -- 默认值：`false`，除非 `agents.defaults.embeddedPi.executionContract`（或按智能体覆盖）对 OpenAI 或 OpenAI Codex GPT-5 系列运行设置为 `"strict-agentic"`。设为 `true` 可在该范围外强制启用该工具，设为 `false` 则即使在 strict-agentic GPT-5 运行中也保持关闭。 -- 启用后，系统提示还会加入使用指导，使模型仅在实质性工作中使用它，并始终最多只保留一个 `in_progress` 步骤。 +- 默认值：`false`，除非 `agents.defaults.embeddedPi.executionContract`（或按智能体覆盖）对 OpenAI 或 OpenAI Codex GPT-5 系列运行设置为 `"strict-agentic"`。设置为 `true` 可在该范围外强制启用此工具，设置为 `false` 则即使在严格 agentic GPT-5 运行中也保持关闭。 +- 启用后，系统提示还会加入使用指引，以便模型仅在重要工作中使用该工具，并且始终最多只有一个步骤处于 `in_progress`。 ### `agents.defaults.subagents` @@ -2359,10 +2370,10 @@ Talk 模式的默认值（macOS/iOS/Android）。 } ``` -- `model`：生成的子智能体默认模型。若省略，子智能体会继承调用方模型。 -- `allowAgents`：当请求方智能体未设置自己的 `subagents.allowAgents` 时，`sessions_spawn` 目标智能体 id 的默认 allowlist（`["*"]` = 任意；默认：仅同一智能体）。 -- `runTimeoutSeconds`：当工具调用省略 `runTimeoutSeconds` 时，`sessions_spawn` 使用的默认超时时间（秒）。`0` 表示无超时。 -- 按子智能体的工具策略：`tools.subagents.tools.allow` / `tools.subagents.tools.deny`。 +- `model`：派生子智能体的默认模型。若省略，子智能体会继承调用方模型。 +- `allowAgents`：当请求智能体未设置自己的 `subagents.allowAgents` 时，`sessions_spawn` 默认允许的目标智能体 id 列表（`["*"]` = 任意；默认：仅同一智能体）。 +- `runTimeoutSeconds`：当工具调用省略 `runTimeoutSeconds` 时，`sessions_spawn` 使用的默认超时（秒）。`0` 表示无超时。 +- 按子智能体工具策略：`tools.subagents.tools.allow` / `tools.subagents.tools.deny`。 --- @@ -2373,7 +2384,7 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 ```json5 { models: { - mode: "merge", // merge（默认） | replace + mode: "merge", // merge（默认）| replace providers: { "custom-proxy": { baseUrl: "http://localhost:4000/v1", @@ -2397,48 +2408,48 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 } ``` -- 对于自定义认证需求，请使用 `authHeader: true` + `headers`。 -- 使用 `OPENCLAW_AGENT_DIR` 覆盖智能体配置根目录（或使用旧版环境变量别名 `PI_CODING_AGENT_DIR`）。 +- 使用 `authHeader: true` + `headers` 可满足自定义认证需求。 +- 使用 `OPENCLAW_AGENT_DIR`（或旧版环境变量别名 `PI_CODING_AGENT_DIR`）覆盖智能体配置根目录。 - 对于匹配的提供商 ID，合并优先级如下： - 非空的智能体 `models.json` `baseUrl` 值优先。 - - 非空的智能体 `apiKey` 值仅在该提供商在当前配置/auth-profile 上下文中不是 SecretRef 管理时优先。 - - 由 SecretRef 管理的提供商 `apiKey` 值会从来源标记刷新（环境变量引用使用 `ENV_VAR_NAME`，file/exec 引用使用 `secretref-managed`），而不是持久化已解析的 secret。 - - 由 SecretRef 管理的提供商 header 值会从来源标记刷新（环境变量引用使用 `secretref-env:ENV_VAR_NAME`，file/exec 引用使用 `secretref-managed`）。 + - 非空的智能体 `apiKey` 值仅在该提供商未在当前配置/auth-profile 上下文中由 SecretRef 管理时优先。 + - 由 SecretRef 管理的提供商 `apiKey` 值会从源标记刷新（环境变量引用使用 `ENV_VAR_NAME`，文件/exec 引用使用 `secretref-managed`），而不是持久化已解析的 secret。 + - 由 SecretRef 管理的提供商 header 值会从源标记刷新（环境变量引用使用 `secretref-env:ENV_VAR_NAME`，文件/exec 引用使用 `secretref-managed`）。 - 空或缺失的智能体 `apiKey`/`baseUrl` 会回退到配置中的 `models.providers`。 - - 匹配模型的 `contextWindow`/`maxTokens` 会在显式配置值与隐式目录值之间取较高者。 - - 匹配模型的 `contextTokens` 会在存在时保留显式运行时上限；可用它在不更改原生模型元数据的情况下限制有效上下文。 - - 当你希望配置完全重写 `models.json` 时，请使用 `models.mode: "replace"`。 - - 标记持久化遵循来源权威：标记来自活动来源配置快照（解析前）写入，而不是来自已解析的运行时 secret 值。 + - 匹配模型的 `contextWindow`/`maxTokens` 会在显式配置值和隐式目录值之间取较高者。 + - 匹配模型的 `contextTokens` 会在存在时保留显式运行时上限；可用它限制有效上下文，而不改变原生模型元数据。 + - 当你希望配置完全重写 `models.json` 时，使用 `models.mode: "replace"`。 + - 标记持久化以源为准：标记写入自活动源配置快照（解析前），而不是来自已解析的运行时 secret 值。 ### 提供商字段详情 - `models.mode`：提供商目录行为（`merge` 或 `replace`）。 -- `models.providers`：以提供商 id 为键的自定义提供商映射。 +- `models.providers`：按提供商 id 作为键的自定义提供商映射。 - `models.providers.*.api`：请求适配器（`openai-completions`、`openai-responses`、`anthropic-messages`、`google-generative-ai` 等）。 -- `models.providers.*.apiKey`：提供商凭证（推荐使用 SecretRef/环境变量替换）。 +- `models.providers.*.apiKey`：提供商凭证（优先使用 SecretRef/环境变量替换）。 - `models.providers.*.auth`：认证策略（`api-key`、`token`、`oauth`、`aws-sdk`）。 -- `models.providers.*.injectNumCtxForOpenAICompat`：对于 Ollama + `openai-completions`，向请求中注入 `options.num_ctx`（默认：`true`）。 +- `models.providers.*.injectNumCtxForOpenAICompat`：用于 Ollama + `openai-completions` 时，将 `options.num_ctx` 注入请求中（默认：`true`）。 - `models.providers.*.authHeader`：在需要时强制通过 `Authorization` header 传输凭证。 - `models.providers.*.baseUrl`：上游 API base URL。 - `models.providers.*.headers`：用于代理/租户路由的额外静态 headers。 - `models.providers.*.request`：模型提供商 HTTP 请求的传输覆盖。 - - `request.headers`：额外 headers（与提供商默认值合并）。值支持 SecretRef。 - - `request.auth`：认证策略覆盖。模式：`"provider-default"`（使用提供商内置认证）、`"authorization-bearer"`（配合 `token`）、`"header"`（配合 `headerName`、`value`，可选 `prefix`）。 + - `request.headers`：额外 headers（与提供商默认值合并）。值接受 SecretRef。 + - `request.auth`：认证策略覆盖。模式：`"provider-default"`（使用提供商内置认证）、`"authorization-bearer"`（配合 `token`）、`"header"`（配合 `headerName`、`value` 和可选的 `prefix`）。 - `request.proxy`：HTTP 代理覆盖。模式：`"env-proxy"`（使用 `HTTP_PROXY`/`HTTPS_PROXY` 环境变量）、`"explicit-proxy"`（配合 `url`）。两种模式都接受可选的 `tls` 子对象。 - - `request.tls`：直连时的 TLS 覆盖。字段：`ca`、`cert`、`key`、`passphrase`（均支持 SecretRef）、`serverName`、`insecureSkipVerify`。 - - `request.allowPrivateNetwork`：设为 `true` 时，当 DNS 解析到私有、CGNAT 或类似地址范围时，允许通过提供商 HTTP 获取防护访问 `baseUrl` 的 HTTPS（这是针对受信任、自托管、兼容 OpenAI 端点的 operator 显式启用项）。WebSocket 也会使用同一个 `request` 来处理 headers/TLS，但不会使用该 fetch SSRF 防护。默认值 `false`。 -- `models.providers.*.models`：显式的提供商模型目录条目。 + - `request.tls`：直接连接的 TLS 覆盖。字段：`ca`、`cert`、`key`、`passphrase`（都接受 SecretRef）、`serverName`、`insecureSkipVerify`。 + - `request.allowPrivateNetwork`：为 `true` 时，当 DNS 解析到私有、CGNAT 或类似地址范围时，允许通过提供商 HTTP fetch 防护向 `baseUrl` 发起 HTTPS 请求（这是对受信任自托管 OpenAI 兼容端点的 operator 显式启用项）。WebSocket 会对 headers/TLS 使用相同的 `request`，但不会使用该 fetch SSRF 防护。默认 `false`。 +- `models.providers.*.models`：显式提供商模型目录条目。 - `models.providers.*.models.*.contextWindow`：原生模型上下文窗口元数据。 -- `models.providers.*.models.*.contextTokens`：可选的运行时上下文上限。当你希望有效上下文预算小于模型原生 `contextWindow` 时使用它。 -- `models.providers.*.models.*.compat.supportsDeveloperRole`：可选兼容性提示。对于 `api: "openai-completions"` 且 `baseUrl` 为非空、非原生值（host 不是 `api.openai.com`）的情况，OpenClaw 会在运行时强制将其设为 `false`。空或省略 `baseUrl` 时保留默认 OpenAI 行为。 -- `models.providers.*.models.*.compat.requiresStringContent`：适用于仅支持字符串的兼容 OpenAI 聊天端点的可选兼容性提示。设为 `true` 时，OpenClaw 会在发送请求前，将纯文本 `messages[].content` 数组压平为普通字符串。 +- `models.providers.*.models.*.contextTokens`：可选的运行时上下文上限。当你希望有效上下文预算小于模型原生 `contextWindow` 时使用此项。 +- `models.providers.*.models.*.compat.supportsDeveloperRole`：可选兼容性提示。对于 `api: "openai-completions"` 且 `baseUrl` 为非空非原生值（host 不是 `api.openai.com`）的情况，OpenClaw 会在运行时强制将其设为 `false`。空的/省略的 `baseUrl` 会保持默认 OpenAI 行为。 +- `models.providers.*.models.*.compat.requiresStringContent`：针对仅支持字符串的 OpenAI 兼容聊天端点的可选兼容性提示。为 `true` 时，OpenClaw 会在发送请求前，将纯文本 `messages[].content` 数组展平为普通字符串。 - `plugins.entries.amazon-bedrock.config.discovery`：Bedrock 自动发现设置根路径。 -- `plugins.entries.amazon-bedrock.config.discovery.enabled`：开启/关闭隐式发现。 +- `plugins.entries.amazon-bedrock.config.discovery.enabled`：打开/关闭隐式发现。 - `plugins.entries.amazon-bedrock.config.discovery.region`：用于发现的 AWS 区域。 - `plugins.entries.amazon-bedrock.config.discovery.providerFilter`：用于定向发现的可选 provider-id 过滤器。 -- `plugins.entries.amazon-bedrock.config.discovery.refreshInterval`：发现刷新轮询间隔。 -- `plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow`：已发现模型的回退上下文窗口。 -- `plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens`：已发现模型的回退最大输出 token 数。 +- `plugins.entries.amazon-bedrock.config.discovery.refreshInterval`：发现刷新的轮询间隔。 +- `plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow`：已发现模型的后备上下文窗口。 +- `plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens`：已发现模型的后备最大输出 token 数。 ### 提供商示例 @@ -2476,7 +2487,7 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 } ``` -对于 Cerebras，请使用 `cerebras/zai-glm-4.7`；对于 Z.AI 直连，请使用 `zai/glm-4.7`。 +对 Cerebras 使用 `cerebras/zai-glm-4.7`；对 Z.AI 直连使用 `zai/glm-4.7`。 @@ -2510,11 +2521,11 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 } ``` -设置 `ZAI_API_KEY`。`z.ai/*` 和 `z-ai/*` 都是可接受的别名。快捷方式：`openclaw onboard --auth-choice zai-api-key`。 +设置 `ZAI_API_KEY`。`z.ai/*` 和 `z-ai/*` 都是接受的别名。快捷方式：`openclaw onboard --auth-choice zai-api-key`。 - 通用端点：`https://api.z.ai/api/paas/v4` -- 编码端点（默认）：`https://api.z.ai/api/coding/paas/v4` -- 若要使用通用端点，请定义带 base URL 覆盖的自定义提供商。 +- Coding 端点（默认）：`https://api.z.ai/api/coding/paas/v4` +- 对于通用端点，请定义带有 base URL 覆盖的自定义提供商。 @@ -2553,11 +2564,11 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 } ``` -对于中国端点：`baseUrl: "https://api.moonshot.cn/v1"` 或 `openclaw onboard --auth-choice moonshot-api-key-cn`。 +对于中国区端点：`baseUrl: "https://api.moonshot.cn/v1"` 或 `openclaw onboard --auth-choice moonshot-api-key-cn`。 原生 Moonshot 端点会在共享的 -`openai-completions` 传输上声明流式传输使用兼容性，而 OpenClaw 会依据端点能力 -而不仅仅是内置提供商 id 本身来处理这一点。 +`openai-completions` 传输上声明流式使用兼容性，OpenClaw 会基于端点能力 +而不只是基于内置 provider id 本身来决定相关行为。 @@ -2575,11 +2586,11 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 } ``` -兼容 Anthropic 的内置提供商。快捷方式：`openclaw onboard --auth-choice kimi-code-api-key`。 +Anthropic 兼容，内置提供商。快捷方式：`openclaw onboard --auth-choice kimi-code-api-key`。 - + ```json5 { @@ -2614,7 +2625,7 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 } ``` -Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式：`openclaw onboard --auth-choice synthetic-api-key`。 +Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方式：`openclaw onboard --auth-choice synthetic-api-key`。 @@ -2658,15 +2669,16 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式 `openclaw onboard --auth-choice minimax-global-api` 或 `openclaw onboard --auth-choice minimax-cn-api`。 模型目录默认仅包含 M2.7。 -在兼容 Anthropic 的流式传输路径上，除非你显式设置 `thinking`，否则 OpenClaw 默认会禁用 MiniMax thinking。 -`/fast on` 或 `params.fastMode: true` 会将 `MiniMax-M2.7` 重写为 +在 Anthropic 兼容的流式路径上，OpenClaw 默认会禁用 MiniMax thinking， +除非你显式自行设置 `thinking`。`/fast on` 或 +`params.fastMode: true` 会将 `MiniMax-M2.7` 重写为 `MiniMax-M2.7-highspeed`。 -参见 [Local Models](/zh-CN/gateway/local-models)。简而言之：在性能足够的硬件上通过 LM Studio Responses API 运行大型本地模型；同时保留已合并的托管模型作为回退。 +参见 [Local Models](/zh-CN/gateway/local-models)。简要说明：在性能足够强的硬件上，通过 LM Studio Responses API 运行大型本地模型；同时保留已合并的托管模型作为回退。 @@ -2697,13 +2709,14 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式 } ``` -- `allowBundled`：仅针对内置 Skills 的可选 allowlist（托管/workspace Skills 不受影响）。 -- `load.extraDirs`：额外的共享 skill 根目录（优先级最低）。 -- `install.preferBrew`：设为 true 时，如果 `brew` 可用，则优先使用 Homebrew 安装器，然后才回退到其他安装器类型。 -- `install.nodeManager`：`metadata.openclaw.install` - 规范所使用的 node 安装器偏好（`npm` | `pnpm` | `yarn` | `bun`）。 -- `entries..enabled: false`：即使某个 skill 已内置/已安装，也会将其禁用。 -- `entries..apiKey`：为声明了主环境变量的 skill 提供便捷设置（明文字符串或 SecretRef 对象）。 +- `allowBundled`：仅针对内置 Skills 的可选允许列表（托管/workspace Skills 不受影响）。 +- `load.extraDirs`：额外的共享 Skills 根目录（最低优先级）。 +- `install.preferBrew`：为 true 时，若 `brew` 可用，则优先使用 Homebrew 安装器，再回退到其他安装器类型。 +- `install.nodeManager`：用于 `metadata.openclaw.install` + 规范的 node 安装器偏好 + （`npm` | `pnpm` | `yarn` | `bun`）。 +- `entries..enabled: false`：即使 Skill 已内置/已安装，也会禁用它。 +- `entries..apiKey`：为声明主环境变量的 Skills 提供便捷设置（明文字符串或 SecretRef 对象）。 --- @@ -2732,40 +2745,40 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式 ``` - 从 `~/.openclaw/extensions`、`/.openclaw/extensions` 以及 `plugins.load.paths` 加载。 -- 发现机制接受原生 OpenClaw 插件，以及兼容的 Codex bundle 和 Claude bundle，包括无 manifest 的 Claude 默认布局 bundle。 +- 设备发现接受原生 OpenClaw 插件，以及兼容的 Codex bundle 和 Claude bundle，包括无 manifest 的 Claude 默认布局 bundle。 - **配置变更需要重启 Gateway 网关。** -- `allow`：可选 allowlist（仅加载列出的插件）。`deny` 优先。 +- `allow`：可选允许列表（仅加载列出的插件）。`deny` 优先生效。 - `plugins.entries..apiKey`：插件级 API key 便捷字段（当插件支持时）。 - `plugins.entries..env`：插件作用域环境变量映射。 -- `plugins.entries..hooks.allowPromptInjection`：为 `false` 时，core 会阻止 `before_prompt_build`，并忽略旧版 `before_agent_start` 中会修改提示的字段，同时保留旧版 `modelOverride` 和 `providerOverride`。适用于原生插件 hooks 以及受支持的 bundle 提供 hook 目录。 -- `plugins.entries..subagent.allowModelOverride`：显式信任此插件在后台子智能体运行中请求按次运行的 `provider` 和 `model` 覆盖。 -- `plugins.entries..subagent.allowedModels`：受信任子智能体覆盖所允许的规范 `provider/model` 目标的可选 allowlist。仅在你明确希望允许任意模型时才使用 `"*"`。 -- `plugins.entries..config`：由插件定义的配置对象（在可用时由原生 OpenClaw 插件 schema 验证）。 -- `plugins.entries.firecrawl.config.webFetch`：Firecrawl web 获取提供商设置。 +- `plugins.entries..hooks.allowPromptInjection`：为 `false` 时，核心会阻止 `before_prompt_build`，并忽略旧版 `before_agent_start` 中会修改提示的字段，同时保留旧版 `modelOverride` 和 `providerOverride`。适用于原生插件 hooks 以及受支持的 bundle 提供 hook 目录。 +- `plugins.entries..subagent.allowModelOverride`：显式信任此插件可以为后台子智能体运行请求按次覆盖 `provider` 和 `model`。 +- `plugins.entries..subagent.allowedModels`：受信任子智能体覆盖可用的规范 `provider/model` 目标可选允许列表。仅当你确实希望允许任意模型时才使用 `"*"`。 +- `plugins.entries..config`：插件定义的配置对象（在可用时由原生 OpenClaw 插件 schema 验证）。 +- `plugins.entries.firecrawl.config.webFetch`：Firecrawl web-fetch 提供商设置。 - `apiKey`：Firecrawl API key（接受 SecretRef）。会回退到 `plugins.entries.firecrawl.config.webSearch.apiKey`、旧版 `tools.web.fetch.firecrawl.apiKey` 或 `FIRECRAWL_API_KEY` 环境变量。 - `baseUrl`：Firecrawl API base URL（默认：`https://api.firecrawl.dev`）。 - - `onlyMainContent`：仅提取页面主要内容（默认：`true`）。 - - `maxAgeMs`：缓存最大年龄（毫秒）（默认：`172800000` / 2 天）。 + - `onlyMainContent`：仅提取页面主体内容（默认：`true`）。 + - `maxAgeMs`：缓存最大年龄（毫秒，默认：`172800000` / 2 天）。 - `timeoutSeconds`：抓取请求超时秒数（默认：`60`）。 - `plugins.entries.xai.config.xSearch`：xAI X Search（Grok web 搜索）设置。 - `enabled`：启用 X Search 提供商。 - `model`：用于搜索的 Grok 模型（例如 `"grok-4-1-fast"`）。 -- `plugins.entries.memory-core.config.dreaming`：memory dreaming（实验性）设置。各阶段和阈值请参见 [Dreaming](/zh-CN/concepts/dreaming)。 - - `enabled`：dreaming 主开关（默认 `false`）。 +- `plugins.entries.memory-core.config.dreaming`：memory dreaming（实验性）设置。阶段和阈值见 [Dreaming](/zh-CN/concepts/dreaming)。 + - `enabled`：dreaming 总开关（默认 `false`）。 - `frequency`：每次完整 dreaming 扫描的 cron 频率（默认 `"0 3 * * *"`）。 - 阶段策略和阈值属于实现细节（不是面向用户的配置键）。 -- 完整的 memory 配置位于 [Memory configuration reference](/zh-CN/reference/memory-config)： +- 完整 memory 配置见 [Memory configuration reference](/zh-CN/reference/memory-config)： - `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"`，除非你安装并选择了其他引擎。 +- 已启用的 Claude bundle 插件也可以从 `settings.json` 提供嵌入式 Pi 默认值；OpenClaw 会将其作为已清理的智能体设置来应用，而不是作为原始 OpenClaw 配置补丁。 +- `plugins.slots.memory`：选择活动 memory 插件 id，或设为 `"none"` 以禁用 memory 插件。 +- `plugins.slots.contextEngine`：选择活动上下文引擎插件 id；默认是 `"legacy"`，除非你安装并选择了其他引擎。 - `plugins.installs`：由 CLI 管理的安装元数据，供 `openclaw plugins update` 使用。 - - 包括 `source`、`spec`、`sourcePath`、`installPath`、`version`、`resolvedName`、`resolvedVersion`、`resolvedSpec`、`integrity`、`shasum`、`resolvedAt`、`installedAt`。 - - 将 `plugins.installs.*` 视为托管状态；优先使用 CLI 命令，而不是手动编辑。 + - 包含 `source`、`spec`、`sourcePath`、`installPath`、`version`、`resolvedName`、`resolvedVersion`、`resolvedSpec`、`integrity`、`shasum`、`resolvedAt`、`installedAt`。 + - 请将 `plugins.installs.*` 视为托管状态；优先使用 CLI 命令，不要手动编辑。 参见 [Plugins](/zh-CN/tools/plugin)。 @@ -2780,7 +2793,7 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式 evaluateEnabled: true, defaultProfile: "user", ssrfPolicy: { - // dangerouslyAllowPrivateNetwork: true, // 仅在受信任的私有网络访问中显式启用 + // dangerouslyAllowPrivateNetwork: true, // 仅在你信任私有网络访问时显式启用 // allowPrivateNetwork: true, // 旧版别名 // hostnameAllowlist: ["*.example.com", "example.com"], // allowedHostnames: ["localhost"], @@ -2808,28 +2821,27 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式 ``` - `evaluateEnabled: false` 会禁用 `act:evaluate` 和 `wait --fn`。 -- 未设置时，`ssrfPolicy.dangerouslyAllowPrivateNetwork` 为禁用，因此默认会对浏览器导航保持严格限制。 -- 仅当你明确受信任私有网络浏览器导航时，才设置 `ssrfPolicy.dangerouslyAllowPrivateNetwork: true`。 -- 在严格模式下，远程 CDP 配置目标（`profiles.*.cdpUrl`）在可达性/发现检查期间也会受到同样的私有网络阻止。 -- `ssrfPolicy.allowPrivateNetwork` 仍作为旧版别名受支持。 -- 在严格模式下，请使用 `ssrfPolicy.hostnameAllowlist` 和 `ssrfPolicy.allowedHostnames` 进行显式例外配置。 -- 远程配置为仅附加模式（禁用 start/stop/reset）。 +- `ssrfPolicy.dangerouslyAllowPrivateNetwork` 未设置时为禁用，因此浏览器导航默认保持严格模式。 +- 只有在你明确确信任私有网络浏览器导航时，才设置 `ssrfPolicy.dangerouslyAllowPrivateNetwork: true`。 +- 在严格模式下，远程 CDP 配置端点（`profiles.*.cdpUrl`）在可达性/设备发现检查期间也会受到同样的私有网络阻止。 +- `ssrfPolicy.allowPrivateNetwork` 仍作为旧版别名受到支持。 +- 在严格模式下，使用 `ssrfPolicy.hostnameAllowlist` 和 `ssrfPolicy.allowedHostnames` 可为特定主机添加显式例外。 +- 远程配置为仅附加模式（禁用启动/停止/重置）。 - `profiles.*.cdpUrl` 接受 `http://`、`https://`、`ws://` 和 `wss://`。 - 当你希望 OpenClaw 发现 `/json/version` 时，请使用 HTTP(S)； + 当你希望 OpenClaw 通过 `/json/version` 进行设备发现时，请使用 HTTP(S)； 当你的提供商直接给出 DevTools WebSocket URL 时，请使用 WS(S)。 - `existing-session` 配置仅适用于主机，并使用 Chrome MCP 而不是 CDP。 -- `existing-session` 配置可设置 `userDataDir`，以指向特定 - 基于 Chromium 的浏览器配置，例如 Brave 或 Edge。 -- `existing-session` 配置保留当前 Chrome MCP 路线限制： - 使用 snapshot/ref 驱动的操作而不是基于 CSS selector 的目标定位、单文件上传 - hooks、无对话框超时覆盖、无 `wait --load networkidle`，且无 +- `existing-session` 配置可设置 `userDataDir` 以定位特定的 + Chromium 内核浏览器用户配置，例如 Brave 或 Edge。 +- `existing-session` 配置保留当前 Chrome MCP 路由限制： + 基于快照/引用的操作，而非 CSS 选择器定位；单文件上传 + hooks；无对话框超时覆盖；无 `wait --load networkidle`，以及无 `responsebody`、PDF 导出、下载拦截或批量操作。 -- 本地托管的 `openclaw` 配置会自动分配 `cdpPort` 和 `cdpUrl`；只有 - 远程 CDP 才需要显式设置 `cdpUrl`。 -- 自动检测顺序：默认浏览器（如果基于 Chromium）→ Chrome → Brave → Edge → Chromium → Chrome Canary。 -- 控制服务：仅 loopback（端口由 `gateway.port` 推导，默认 `18791`）。 -- `extraArgs` 会向本地 Chromium 启动追加额外标志（例如 - `--disable-gpu`、窗口尺寸或调试标志）。 +- 本地托管的 `openclaw` 配置会自动分配 `cdpPort` 和 `cdpUrl`；仅在远程 CDP 场景下才需要显式设置 `cdpUrl`。 +- 自动检测顺序：默认浏览器若为 Chromium 内核 → Chrome → Brave → Edge → Chromium → Chrome Canary。 +- Control 服务：仅绑定 loopback（端口由 `gateway.port` 派生，默认 `18791`）。 +- `extraArgs` 会将额外启动参数附加到本地 Chromium 启动命令中（例如 + `--disable-gpu`、窗口大小设置或调试参数）。 --- @@ -2847,8 +2859,8 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式 } ``` -- `seamColor`：原生应用 UI 外观的强调色（Talk Mode 气泡着色等）。 -- `assistant`：Control UI 身份覆盖。未设置时回退为当前活动智能体身份。 +- `seamColor`：原生应用 UI 外观的强调色（Talk 模式气泡色调等）。 +- `assistant`：Control UI 身份覆盖。会回退到活动智能体身份。 --- @@ -2881,8 +2893,10 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式 enabled: true, basePath: "/openclaw", // root: "dist/control-ui", + // embedSandbox: "scripts", // strict | scripts | trusted + // allowExternalEmbedUrls: false, // 危险：允许绝对外部 http(s) 嵌入 URL // allowedOrigins: ["https://control.example.com"], // 非 loopback Control UI 必填 - // dangerouslyAllowHostHeaderOriginFallback: false, // 危险的基于 Host header 的来源回退模式 + // dangerouslyAllowHostHeaderOriginFallback: false, // 危险的 Host-header origin 回退模式 // allowInsecureAuth: false, // dangerouslyDisableDeviceAuth: false, }, @@ -2915,64 +2929,64 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会追加它）。快捷方式 -- `mode`：`local`（运行 Gateway 网关）或 `remote`（连接远程 Gateway 网关）。除非为 `local`，否则 Gateway 网关会拒绝启动。 -- `port`：用于 WS + HTTP 的单一复用端口。优先级：`--port` > `OPENCLAW_GATEWAY_PORT` > `gateway.port` > `18789`。 +- `mode`：`local`（运行 Gateway 网关）或 `remote`（连接到远程 Gateway 网关）。除非为 `local`，否则 Gateway 网关会拒绝启动。 +- `port`：WS + HTTP 共用的单一复用端口。优先级：`--port` > `OPENCLAW_GATEWAY_PORT` > `gateway.port` > `18789`。 - `bind`：`auto`、`loopback`（默认）、`lan`（`0.0.0.0`）、`tailnet`（仅 Tailscale IP）或 `custom`。 -- **旧版 bind 别名**：请在 `gateway.bind` 中使用 bind 模式值（`auto`、`loopback`、`lan`、`tailnet`、`custom`），而不是主机别名（`0.0.0.0`、`127.0.0.1`、`localhost`、`::`、`::1`）。 -- **Docker 注意事项**：默认的 `loopback` bind 会在容器内部监听 `127.0.0.1`。在 Docker bridge 网络（`-p 18789:18789`）下，流量会到达 `eth0`，因此 Gateway 网关不可达。请使用 `--network host`，或设置 `bind: "lan"`（或使用 `bind: "custom"` 并配合 `customBindHost: "0.0.0.0"`）以监听所有接口。 -- **认证**：默认必需。非 loopback 绑定必须启用 Gateway 网关认证。实际这意味着使用共享 token/password，或使用带 `gateway.auth.mode: "trusted-proxy"` 的身份感知反向代理。新手引导向导默认会生成 token。 -- 如果同时配置了 `gateway.auth.token` 和 `gateway.auth.password`（包括 SecretRef），请显式设置 `gateway.auth.mode` 为 `token` 或 `password`。若两者都已配置但 mode 未设置，启动和服务安装/修复流程都会失败。 -- `gateway.auth.mode: "none"`：显式无认证模式。仅适用于受信任的本地 local loopback 配置；新手引导提示中不会提供此选项。 -- `gateway.auth.mode: "trusted-proxy"`：将认证委托给身份感知反向代理，并信任来自 `gateway.trustedProxies` 的身份 headers（参见 [Trusted Proxy Auth](/zh-CN/gateway/trusted-proxy-auth)）。此模式要求**非 loopback** 代理来源；同主机 loopback 反向代理不满足 trusted-proxy 认证要求。 -- `gateway.auth.allowTailscale`：设为 `true` 时，Tailscale Serve 身份 headers 可用于满足 Control UI/WebSocket 认证（通过 `tailscale whois` 验证）。HTTP API 端点**不会**使用该 Tailscale header 认证；它们仍遵循 Gateway 网关的常规 HTTP 认证模式。该无 token 流程假定 Gateway 网关主机是可信的。当 `tailscale.mode = "serve"` 时默认值为 `true`。 -- `gateway.auth.rateLimit`：可选的认证失败限流器。按客户端 IP 和认证作用域生效（共享密钥和设备 token 会分别跟踪）。被阻止的尝试会返回 `429` + `Retry-After`。 - - 在异步 Tailscale Serve Control UI 路径上，相同 `{scope, clientIp}` 的失败尝试会在写入失败记录前串行化。因此，同一客户端的并发错误尝试，可能会在第二个请求时触发限流，而不是两个都竞争通过并仅作为普通不匹配处理。 +- **旧版 bind 别名**：在 `gateway.bind` 中请使用 bind 模式值（`auto`、`loopback`、`lan`、`tailnet`、`custom`），不要使用主机别名（`0.0.0.0`、`127.0.0.1`、`localhost`、`::`、`::1`）。 +- **Docker 注意事项**：默认的 `loopback` bind 会在容器内监听 `127.0.0.1`。在 Docker bridge 网络（`-p 18789:18789`）下，流量会到达 `eth0`，因此 Gateway 网关 不可达。请使用 `--network host`，或设置 `bind: "lan"`（或 `bind: "custom"` 并设置 `customBindHost: "0.0.0.0"`）以监听所有接口。 +- **认证**：默认必需。非 loopback 绑定要求使用 Gateway 网关认证。实际意味着需要共享 token/password，或使用带 `gateway.auth.mode: "trusted-proxy"` 的身份感知型反向代理。新手引导向导默认会生成 token。 +- 如果同时配置了 `gateway.auth.token` 和 `gateway.auth.password`（包括 SecretRef），必须显式设置 `gateway.auth.mode` 为 `token` 或 `password`。若两者都已配置但未设置 mode，启动以及服务安装/修复流程都会失败。 +- `gateway.auth.mode: "none"`：显式无认证模式。仅用于受信任的本地 local loopback 场景；新手引导提示中不会提供此选项。 +- `gateway.auth.mode: "trusted-proxy"`：将认证委托给身份感知型反向代理，并信任来自 `gateway.trustedProxies` 的身份 headers（参见 [Trusted Proxy Auth](/zh-CN/gateway/trusted-proxy-auth)）。此模式要求**非 loopback** 的代理来源；同主机 loopback 反向代理不满足 trusted-proxy 认证条件。 +- `gateway.auth.allowTailscale`：为 `true` 时，Tailscale Serve 身份 headers 可用于满足 Control UI/WebSocket 认证（通过 `tailscale whois` 验证）。HTTP API 端点**不会**使用该 Tailscale header 认证；它们仍遵循 Gateway 网关 的常规 HTTP 认证模式。此无 token 流程假定 Gateway 网关 主机受信任。当 `tailscale.mode = "serve"` 时默认值为 `true`。 +- `gateway.auth.rateLimit`：可选的认证失败限流器。按客户端 IP 和认证作用域生效（共享 secret 和设备 token 会分别跟踪）。被阻止的尝试返回 `429` + `Retry-After`。 + - 在异步的 Tailscale Serve Control UI 路径上，来自相同 `{scope, clientIp}` 的失败尝试会在写入失败记录前被串行化。因此，同一客户端的并发错误尝试可能会在第二个请求时触发限流，而不是两个都作为普通不匹配同时穿过。 - `gateway.auth.rateLimit.exemptLoopback` 默认值为 `true`；如果你明确希望 localhost 流量也被限流（例如测试环境或严格代理部署），请设为 `false`。 -- 来自浏览器源的 WS 认证尝试始终会在禁用 loopback 豁免的情况下进行限流（作为对基于浏览器的 localhost 暴力尝试的纵深防御）。 +- 来自浏览器源的 WS 认证尝试始终会在关闭 loopback 豁免的情况下进行限流（作为针对基于浏览器的 localhost 暴力破解的纵深防御）。 - 在 loopback 上，这些来自浏览器源的锁定会按规范化后的 `Origin` - 值隔离，因此来自某个 localhost origin 的重复失败不会自动 + 值彼此隔离，因此某个 localhost origin 的重复失败不会自动 锁定另一个 origin。 -- `tailscale.mode`：`serve`（仅 tailnet，loopback 绑定）或 `funnel`（公网，要求认证）。 -- `controlUi.allowedOrigins`：用于 Gateway 网关 WebSocket 连接的显式浏览器源 allowlist。当预期浏览器客户端来自非 loopback 源时为必填。 -- `controlUi.dangerouslyAllowHostHeaderOriginFallback`：危险模式，为刻意依赖 Host header 源策略的部署启用基于 Host header 的源回退。 +- `tailscale.mode`：`serve`（仅 tailnet，loopback 绑定）或 `funnel`（公网，需要认证）。 +- `controlUi.allowedOrigins`：用于 Gateway 网关 WebSocket 连接的显式浏览器源允许列表。当预期浏览器客户端来自非 loopback 源时为必填。 +- `controlUi.dangerouslyAllowHostHeaderOriginFallback`：危险模式，为刻意依赖 Host-header origin 策略的部署启用 Host-header origin 回退。 - `remote.transport`：`ssh`（默认）或 `direct`（ws/wss）。对于 `direct`，`remote.url` 必须是 `ws://` 或 `wss://`。 -- `OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1`：客户端侧的破窗覆盖，允许对受信任私有网络 IP 使用明文 `ws://`；默认情况下，明文连接仍仅限 local loopback。 -- `gateway.remote.token` / `.password` 是远程客户端凭证字段。它们本身不会配置 Gateway 网关认证。 -- `gateway.push.apns.relay.baseUrl`：官方/TestFlight iOS 构建在将基于 relay 的注册发布到 Gateway 网关之后，供其使用的外部 APNs relay 的基础 HTTPS URL。该 URL 必须与编译进 iOS 构建的 relay URL 匹配。 -- `gateway.push.apns.relay.timeoutMs`：Gateway 网关到 relay 的发送超时时间（毫秒）。默认值为 `10000`。 -- 基于 relay 的注册会被委托给特定 Gateway 网关身份。已配对的 iOS 应用会获取 `gateway.identity.get`，在 relay 注册中包含该身份，并将一个以注册为作用域的发送授权转发给 Gateway 网关。其他 Gateway 网关无法复用该已存储注册。 -- `OPENCLAW_APNS_RELAY_BASE_URL` / `OPENCLAW_APNS_RELAY_TIMEOUT_MS`：对上述 relay 配置的临时环境变量覆盖。 -- `OPENCLAW_APNS_RELAY_ALLOW_HTTP=true`：仅用于开发的逃生开关，允许使用 loopback HTTP relay URL。生产 relay URL 应保持为 HTTPS。 +- `OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1`：客户端侧的紧急放行覆盖，允许对受信任私有网络 IP 使用明文 `ws://`；默认情况下明文仍仅限 loopback。 +- `gateway.remote.token` / `.password` 是远程客户端凭证字段。它们本身并不会配置 Gateway 网关认证。 +- `gateway.push.apns.relay.baseUrl`：官方/TestFlight iOS 构建在将基于 relay 的注册发布到 Gateway 网关 后，供其使用的外部 APNs relay 的基础 HTTPS URL。该 URL 必须与编译进 iOS 构建中的 relay URL 一致。 +- `gateway.push.apns.relay.timeoutMs`：Gateway 网关 向 relay 发送时的超时，单位毫秒。默认值：`10000`。 +- 基于 relay 的注册会委派给某个特定 Gateway 网关 身份。已配对的 iOS 应用会调用 `gateway.identity.get`，在 relay 注册中包含该身份，并向 Gateway 网关 转发一个作用于该注册的发送授权。其他 Gateway 网关 无法复用已存储的该注册。 +- `OPENCLAW_APNS_RELAY_BASE_URL` / `OPENCLAW_APNS_RELAY_TIMEOUT_MS`：上述 relay 配置的临时环境变量覆盖。 +- `OPENCLAW_APNS_RELAY_ALLOW_HTTP=true`：仅供开发使用的放行开关，用于 loopback HTTP relay URL。生产环境的 relay URL 应保持为 HTTPS。 - `gateway.channelHealthCheckMinutes`：渠道健康监控间隔（分钟）。设为 `0` 可全局禁用健康监控重启。默认值：`5`。 - `gateway.channelStaleEventThresholdMinutes`：陈旧 socket 阈值（分钟）。请保持其大于或等于 `gateway.channelHealthCheckMinutes`。默认值：`30`。 -- `gateway.channelMaxRestartsPerHour`：滚动一小时内每个渠道/账号允许的最大健康监控重启次数。默认值：`10`。 -- `channels..healthMonitor.enabled`：在保持全局监控启用的同时，按渠道选择退出健康监控重启。 +- `gateway.channelMaxRestartsPerHour`：滚动一小时内每个渠道/账号最多允许的健康监控重启次数。默认值：`10`。 +- `channels..healthMonitor.enabled`：在保持全局监控启用的同时，对某个渠道禁用健康监控重启。 - `channels..accounts..healthMonitor.enabled`：多账号渠道的按账号覆盖。设置后，其优先级高于渠道级覆盖。 -- 仅当 `gateway.auth.*` 未设置时，本地 Gateway 网关调用路径才可将 `gateway.remote.*` 用作回退。 -- 如果 `gateway.auth.token` / `gateway.auth.password` 通过 SecretRef 显式配置但未解析，则解析会以失败关闭方式处理（不会由远程回退掩盖）。 -- `trustedProxies`：终止 TLS 或注入转发客户端 headers 的反向代理 IP。仅列出你控制的代理。loopback 条目对于同主机代理/本地检测配置（例如 Tailscale Serve 或本地反向代理）仍然有效，但它们**不会**让 loopback 请求符合 `gateway.auth.mode: "trusted-proxy"` 的条件。 -- `allowRealIpFallback`：设为 `true` 时，如果缺少 `X-Forwarded-For`，Gateway 网关会接受 `X-Real-IP`。默认值 `false`，以保持失败关闭行为。 -- `gateway.tools.deny`：对 HTTP `POST /tools/invoke` 额外阻止的工具名（在默认拒绝列表基础上扩展）。 +- 本地 Gateway 网关 调用路径仅在 `gateway.auth.*` 未设置时，才可将 `gateway.remote.*` 作为回退。 +- 如果 `gateway.auth.token` / `gateway.auth.password` 通过 SecretRef 显式配置但无法解析，将按默认拒绝方式失败（不会被远程回退掩盖）。 +- `trustedProxies`：会终止 TLS 或注入 forwarded-client headers 的反向代理 IP。只列出你控制的代理。loopback 条目对于同主机代理/本地检测设置（例如 Tailscale Serve 或本地反向代理）仍然有效，但它们**不会**让 loopback 请求有资格使用 `gateway.auth.mode: "trusted-proxy"`。 +- `allowRealIpFallback`：为 `true` 时，当缺少 `X-Forwarded-For` 时，Gateway 网关 会接受 `X-Real-IP`。默认 `false`，以保持默认拒绝。 +- `gateway.tools.deny`：对 HTTP `POST /tools/invoke` 额外阻止的工具名（扩展默认拒绝列表）。 - `gateway.tools.allow`：从默认 HTTP 拒绝列表中移除工具名。 -### 兼容 OpenAI 的端点 +### OpenAI 兼容端点 -- Chat Completions：默认禁用。使用 `gateway.http.endpoints.chatCompletions.enabled: true` 启用。 +- 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` - 空 allowlist 会被视为未设置；请使用 `gateway.http.endpoints.responses.files.allowUrl=false` - 和/或 `gateway.http.endpoints.responses.images.allowUrl=false` 来禁用 URL 获取。 -- 可选响应加固 header： + 空允许列表会被视为未设置；如需禁用 URL 抓取，请使用 `gateway.http.endpoints.responses.files.allowUrl=false` + 和/或 `gateway.http.endpoints.responses.images.allowUrl=false`。 +- 可选的响应加固 header： - `gateway.http.securityHeaders.strictTransportSecurity`（仅对你控制的 HTTPS 源设置；参见 [Trusted Proxy Auth](/zh-CN/gateway/trusted-proxy-auth#tls-termination-and-hsts)） ### 多实例隔离 -在一台主机上运行多个 Gateway 网关，并为其分配不同端口和状态目录： +在同一主机上运行多个 Gateway 网关，并为其配置唯一端口和状态目录： ```bash OPENCLAW_CONFIG_PATH=~/.openclaw/a.json \ @@ -2980,7 +2994,7 @@ OPENCLAW_STATE_DIR=~/.openclaw-a \ openclaw gateway --port 19001 ``` -便捷标志：`--dev`（使用 `~/.openclaw-dev` + 端口 `19001`）、`--profile `（使用 `~/.openclaw-`）。 +便捷参数：`--dev`（使用 `~/.openclaw-dev` + 端口 `19001`）、`--profile `（使用 `~/.openclaw-`）。 参见 [Multiple Gateways](/zh-CN/gateway/multiple-gateways)。 @@ -3000,10 +3014,10 @@ openclaw gateway --port 19001 } ``` -- `enabled`：在 Gateway 网关监听器上启用 TLS 终止（HTTPS/WSS）（默认：`false`）。 -- `autoGenerate`：当未配置显式文件时，自动生成本地自签名证书/密钥对；仅适用于本地/开发用途。 +- `enabled`：在 Gateway 网关 监听器处启用 TLS 终止（HTTPS/WSS）（默认：`false`）。 +- `autoGenerate`：在未配置显式文件时自动生成本地自签名证书/密钥对；仅适用于本地/开发环境。 - `certPath`：TLS 证书文件的文件系统路径。 -- `keyPath`：TLS 私钥文件的文件系统路径；应限制访问权限。 +- `keyPath`：TLS 私钥文件的文件系统路径；请限制其权限。 - `caPath`：用于客户端验证或自定义信任链的可选 CA bundle 路径。 ### `gateway.reload` @@ -3020,13 +3034,13 @@ openclaw gateway --port 19001 } ``` -- `mode`：控制如何在运行时应用配置编辑。 - - `"off"`：忽略实时编辑；变更需要显式重启。 - - `"restart"`：配置变更时始终重启 Gateway 网关进程。 - - `"hot"`：在进程内应用变更而不重启。 - - `"hybrid"`（默认）：先尝试热重载；如有需要再回退到重启。 -- `debounceMs`：应用配置变更前的防抖窗口（毫秒）（非负整数）。 -- `deferralTimeoutMs`：在强制重启前等待进行中操作完成的最长时间（毫秒）（默认：`300000` = 5 分钟）。 +- `mode`：控制配置编辑在运行时如何应用。 + - `"off"`：忽略实时编辑；更改需要显式重启。 + - `"restart"`：配置更改时始终重启 Gateway 网关 进程。 + - `"hot"`：无需重启，在进程内直接应用更改。 + - `"hybrid"`（默认）：先尝试热重载；必要时回退到重启。 +- `debounceMs`：应用配置更改前的去抖窗口（毫秒，非负整数）。 +- `deferralTimeoutMs`：在强制重启前等待进行中操作完成的最长时间（毫秒，默认：`300000` = 5 分钟）。 --- @@ -3053,7 +3067,7 @@ openclaw gateway --port 19001 wakeMode: "now", name: "Gmail", sessionKey: "hook:gmail:{{messages[0].id}}", - messageTemplate: "发件人：{{messages[0].from}}\n主题：{{messages[0].subject}}\n{{messages[0].snippet}}", + messageTemplate: "From: {{messages[0].from}}\nSubject: {{messages[0].subject}}\n{{messages[0].snippet}}", deliver: true, channel: "last", model: "openai/gpt-5.4-mini", @@ -3064,36 +3078,36 @@ openclaw gateway --port 19001 ``` 认证：`Authorization: Bearer ` 或 `x-openclaw-token: `。 -拒绝使用查询字符串传递 hook token。 +拒绝使用查询字符串 hook token。 -验证与安全说明： +验证和安全说明： -- `hooks.enabled=true` 要求提供非空的 `hooks.token`。 -- `hooks.token` 必须与 `gateway.auth.token` **不同**；复用 Gateway 网关 token 会被拒绝。 -- `hooks.path` 不能为 `/`；请使用专用子路径，例如 `/hooks`。 -- 如果 `hooks.allowRequestSessionKey=true`，请约束 `hooks.allowedSessionKeyPrefixes`（例如 `["hook:"]`）。 +- `hooks.enabled=true` 需要非空的 `hooks.token`。 +- `hooks.token` 必须与 `gateway.auth.token` **不同**；拒绝复用 Gateway 网关 token。 +- `hooks.path` 不能是 `/`；请使用专用子路径，例如 `/hooks`。 +- 如果 `hooks.allowRequestSessionKey=true`，请限制 `hooks.allowedSessionKeyPrefixes`（例如 `["hook:"]`）。 **端点：** - `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`（默认：`false`）时，才会接受请求负载中的 `sessionKey`。 + - 只有当 `hooks.allowRequestSessionKey=true`（默认：`false`）时，才接受请求负载中的 `sessionKey`。 - `POST /hooks/` → 通过 `hooks.mappings` 解析 -- `match.path` 会匹配 `/hooks` 之后的子路径（例如 `/hooks/gmail` → `gmail`）。 -- `match.source` 会匹配通用路径中的某个负载字段。 -- 像 `{{messages[0].subject}}` 这样的模板会从负载中读取。 -- `transform` 可以指向返回 hook action 的 JS/TS 模块。 - - `transform.module` 必须是相对路径，并且保持在 `hooks.transformsDir` 内（绝对路径和路径穿越都会被拒绝）。 -- `agentId` 会路由到特定智能体；未知 ID 会回退到默认值。 +- `match.path` 匹配 `/hooks` 之后的子路径（例如 `/hooks/gmail` → `gmail`）。 +- `match.source` 匹配通用路径中的某个负载字段。 +- 像 `{{messages[0].subject}}` 这样的模板会从负载中读取值。 +- `transform` 可指向一个返回 hook action 的 JS/TS 模块。 + - `transform.module` 必须是相对路径，并且保持在 `hooks.transformsDir` 内（绝对路径和路径遍历都会被拒绝）。 +- `agentId` 会路由到特定智能体；未知 id 会回退到默认智能体。 - `allowedAgentIds`：限制显式路由（`*` 或省略 = 允许全部，`[]` = 全部拒绝）。 -- `defaultSessionKey`：对于没有显式 `sessionKey` 的 hook 智能体运行，可选的固定会话键。 +- `defaultSessionKey`：用于没有显式 `sessionKey` 的 hook 智能体运行的可选固定会话键。 - `allowRequestSessionKey`：允许 `/hooks/agent` 调用方设置 `sessionKey`（默认：`false`）。 -- `allowedSessionKeyPrefixes`：针对显式 `sessionKey` 值（请求 + 映射）的可选前缀 allowlist，例如 `["hook:"]`。 -- `deliver: true` 会将最终回复发送到某个渠道；`channel` 默认值为 `last`。 -- `model` 会覆盖此次 hook 运行所用的 LLM（若设置了模型目录，则该模型必须被允许）。 +- `allowedSessionKeyPrefixes`：用于显式 `sessionKey` 值（请求 + 映射）的可选前缀允许列表，例如 `["hook:"]`。 +- `deliver: true` 会将最终回复发送到某个渠道；`channel` 默认为 `last`。 +- `model` 会覆盖此次 hook 运行使用的 LLM（如果设置了模型目录，则该模型必须被允许）。 @@ -3120,8 +3134,8 @@ openclaw gateway --port 19001 } ``` -- 配置后，Gateway 网关会在启动时自动启动 `gog gmail watch serve`。设置 `OPENCLAW_SKIP_GMAIL_WATCHER=1` 可禁用。 -- 不要在 Gateway 网关旁边单独运行 `gog gmail watch serve`。 +- 配置后，Gateway 网关 会在启动时自动启动 `gog gmail watch serve`。设置 `OPENCLAW_SKIP_GMAIL_WATCHER=1` 可禁用。 +- 不要在 Gateway 网关 旁边单独运行另一个 `gog gmail watch serve`。 --- @@ -3137,18 +3151,18 @@ openclaw gateway --port 19001 } ``` -- 会在 Gateway 网关端口下通过 HTTP 提供可由智能体编辑的 HTML/CSS/JS 和 A2UI： +- 通过 Gateway 网关 端口，在 HTTP 下提供可由智能体编辑的 HTML/CSS/JS 和 A2UI： - `http://:/__openclaw__/canvas/` - `http://:/__openclaw__/a2ui/` - 仅限本地：保持 `gateway.bind: "loopback"`（默认）。 -- 非 loopback 绑定：canvas 路由与其他 Gateway 网关 HTTP 面相同，需要 Gateway 网关认证（token/password/trusted-proxy）。 -- Node WebView 通常不会发送认证 headers；在某个 node 完成配对并连接后，Gateway 网关会为其广播 node 作用域的 capability URL，用于访问 canvas/A2UI。 -- Capability URL 绑定到当前活动的 node WS 会话，并且会很快过期。不使用基于 IP 的回退。 -- 会向提供的 HTML 注入 live-reload 客户端。 -- 当目录为空时，会自动创建起始 `index.html`。 +- 非 loopback 绑定：canvas 路由与其他 Gateway 网关 HTTP 层面相同，需要 Gateway 网关认证（token/password/trusted-proxy）。 +- Node WebViews 通常不会发送认证 headers；在某个节点完成配对并连接后，Gateway 网关 会为 canvas/A2UI 访问广播节点作用域的 capability URL。 +- Capability URL 绑定到当前活动节点的 WS 会话，并且很快过期。不使用基于 IP 的回退。 +- 会向已提供的 HTML 注入 live-reload 客户端。 +- 为空时会自动创建初始 `index.html`。 - 也会在 `/__openclaw__/a2ui/` 提供 A2UI。 -- 变更需要重启 Gateway 网关。 -- 对于大目录或出现 `EMFILE` 错误时，请禁用 live reload。 +- 更改需要重启 Gateway 网关。 +- 对于大型目录或 `EMFILE` 错误，请禁用 live reload。 --- @@ -3170,7 +3184,7 @@ openclaw gateway --port 19001 - `full`：包含 `cliPath` + `sshPort`。 - 主机名默认为 `openclaw`。可通过 `OPENCLAW_MDNS_HOSTNAME` 覆盖。 -### 广域（DNS-SD） +### 广域网（DNS-SD） ```json5 { @@ -3180,7 +3194,7 @@ openclaw gateway --port 19001 } ``` -会在 `~/.openclaw/dns/` 下写入单播 DNS-SD 区域。若要实现跨网络设备发现，请配合 DNS 服务器（推荐 CoreDNS）+ Tailscale split DNS 一起使用。 +会在 `~/.openclaw/dns/` 下写入单播 DNS-SD 区域。若需跨网络设备发现，请搭配 DNS 服务器（推荐 CoreDNS）+ Tailscale split DNS。 设置：`openclaw dns setup --apply`。 @@ -3207,12 +3221,12 @@ openclaw gateway --port 19001 - 仅当进程环境中缺少该键时，才会应用内联环境变量。 - `.env` 文件：当前工作目录 `.env` + `~/.openclaw/.env`（两者都不会覆盖现有变量）。 -- `shellEnv`：从你的登录 shell 配置文件中导入缺失的预期键名。 -- 完整优先级请参见 [Environment](/zh-CN/help/environment)。 +- `shellEnv`：从你的登录 shell 配置中导入缺失的预期键名。 +- 完整优先级见 [Environment](/zh-CN/help/environment)。 ### 环境变量替换 -可以在任意配置字符串中使用 `${VAR_NAME}` 引用环境变量： +可在任意配置字符串中使用 `${VAR_NAME}` 引用环境变量： ```json5 { @@ -3223,7 +3237,7 @@ openclaw gateway --port 19001 ``` - 仅匹配大写名称：`[A-Z_][A-Z0-9_]*`。 -- 缺失/为空的变量会在加载配置时抛出错误。 +- 缺失/空变量会在配置加载时报错。 - 使用 `$${VAR}` 可转义为字面量 `${VAR}`。 - 适用于 `$include`。 @@ -3231,7 +3245,7 @@ openclaw gateway --port 19001 ## Secrets -SecretRef 是增量能力：明文值依然可用。 +Secret refs 是增量支持：明文值仍然可用。 ### `SecretRef` @@ -3245,15 +3259,15 @@ SecretRef 是增量能力：明文值依然可用。 - `provider` 模式：`^[a-z][a-z0-9_-]{0,63}$` - `source: "env"` 的 id 模式：`^[A-Z][A-Z0-9_]{0,127}$` -- `source: "file"` 的 id：绝对 JSON 指针（例如 `"/providers/openai/apiKey"`） +- `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` 会被拒绝） +- `source: "exec"` 的 id 不能包含 `.` 或 `..` 的斜杠分隔路径段（例如 `a/../b` 会被拒绝） -### 支持的凭证面 +### 支持的凭证层面 - 规范矩阵： [SecretRef Credential Surface](/zh-CN/reference/secretref-credential-surface) -- `secrets apply` 会针对受支持的 `openclaw.json` 凭证路径执行。 -- `auth-profiles.json` 引用也会纳入运行时解析和审计覆盖范围。 +- `secrets apply` 以受支持的 `openclaw.json` 凭证路径为目标。 +- `auth-profiles.json` refs 也包含在运行时解析和审计覆盖中。 ### Secret 提供商配置 @@ -3287,11 +3301,11 @@ SecretRef 是增量能力：明文值依然可用。 - `file` 提供商支持 `mode: "json"` 和 `mode: "singleValue"`（在 singleValue 模式下，`id` 必须为 `"value"`）。 - `exec` 提供商要求使用绝对 `command` 路径，并通过 stdin/stdout 使用协议负载。 -- 默认会拒绝符号链接命令路径。设置 `allowSymlinkCommand: true` 可允许符号链接路径，同时验证其解析后的目标路径。 +- 默认情况下，会拒绝符号链接命令路径。设置 `allowSymlinkCommand: true` 可允许符号链接路径，同时仍校验解析后的目标路径。 - 如果配置了 `trustedDirs`，则受信任目录检查会应用到解析后的目标路径。 -- `exec` 子进程环境默认最小化；请使用 `passEnv` 显式传递所需变量。 -- Secret 引用会在激活时解析为内存快照，随后请求路径只读取该快照。 -- 激活期间会应用活动面过滤：已启用面的未解析引用会导致启动/重载失败，而非活动面则会跳过并附带诊断信息。 +- `exec` 子进程环境默认最小化；请通过 `passEnv` 显式传递所需变量。 +- Secret refs 会在激活时解析为内存快照，此后请求路径只读取该快照。 +- 激活期间会应用活动层面过滤：启用层面上的未解析 refs 会导致启动/重载失败，而非活动层面会被跳过并记录诊断信息。 --- @@ -3313,10 +3327,10 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- 按智能体配置文件存储在 `/auth-profiles.json`。 -- `auth-profiles.json` 支持静态凭证模式的值级引用（`api_key` 对应 `keyRef`，`token` 对应 `tokenRef`）。 -- OAuth 模式配置文件（`auth.profiles..mode = "oauth"`）不支持由 SecretRef 支持的 auth-profile 凭证。 -- 静态运行时凭证来自已解析的内存快照；发现旧版静态 `auth.json` 条目时会进行清理。 +- 按智能体的配置存储在 `/auth-profiles.json`。 +- `auth-profiles.json` 对静态凭证模式支持值级 refs（`api_key` 使用 `keyRef`，`token` 使用 `tokenRef`）。 +- OAuth 模式配置（`auth.profiles..mode = "oauth"`）不支持由 SecretRef 支持的 auth-profile 凭证。 +- 静态运行时凭证来自已解析的内存快照；发现旧版静态 `auth.json` 条目时会清理。 - 旧版 OAuth 从 `~/.openclaw/credentials/oauth.json` 导入。 - 参见 [OAuth](/zh-CN/concepts/oauth)。 - Secrets 运行时行为以及 `audit/configure/apply` 工具： [Secrets Management](/zh-CN/gateway/secrets)。 @@ -3341,21 +3355,20 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- `billingBackoffHours`：当某个配置文件因真实 - 计费/余额不足错误而失败时的基础回退时间（小时）（默认：`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`：在切换到模型回退之前，对于 overloaded 错误允许的同提供商 auth-profile 轮换最大次数（默认：`1`）。像 `ModelNotReadyException` 这类提供商繁忙形态会归入这里。 -- `overloadedBackoffMs`：在重试 overloaded 提供商/配置文件轮换前的固定延迟（默认：`0`）。 -- `rateLimitedProfileRotations`：在切换到模型回退之前，对于 rate-limit 错误允许的同提供商 auth-profile 轮换最大次数（默认：`1`）。该 rate-limit 桶也包括诸如 `Too many concurrent requests`、`ThrottlingException`、`concurrency limit reached`、`workers_ai ... quota limit exceeded` 和 `resource exhausted` 等提供商形态文本。 +- `billingBackoffHours`：当某个配置因真实的 + 计费/余额不足错误而失败时使用的基础回退时长（小时，默认：`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`）。该 rate-limit 类别包括提供商形态的文本，例如 `Too many concurrent requests`、`ThrottlingException`、`concurrency limit reached`、`workers_ai ... quota limit exceeded` 和 `resource exhausted`。 --- @@ -3377,7 +3390,7 @@ SecretRef 是增量能力：明文值依然可用。 - 默认日志文件：`/tmp/openclaw/openclaw-YYYY-MM-DD.log`。 - 设置 `logging.file` 可使用固定路径。 - 使用 `--verbose` 时，`consoleLevel` 会提升为 `debug`。 -- `maxFileBytes`：日志文件在停止写入前允许的最大大小（字节）（正整数；默认：`524288000` = 500 MB）。生产部署请使用外部日志轮转。 +- `maxFileBytes`：在停止写入前允许的最大日志文件大小（字节，正整数；默认：`524288000` = 500 MB）。生产部署请使用外部日志轮转。 --- @@ -3414,20 +3427,20 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- `enabled`：检测输出的主开关（默认：`true`）。 -- `flags`：用于启用定向日志输出的标志字符串数组（支持如 `"telegram.*"` 或 `"*"` 这样的通配符）。 -- `stuckSessionWarnMs`：当某个会话持续处于处理状态时，用于发出卡住会话警告的年龄阈值（毫秒）。 -- `otel.enabled`：启用 OpenTelemetry 导出管线（默认：`false`）。 -- `otel.endpoint`：OTel 导出的采集器 URL。 +- `enabled`：instrumentation 输出总开关（默认：`true`）。 +- `flags`：启用定向日志输出的标志字符串数组（支持像 `"telegram.*"` 或 `"*"` 这样的通配符）。 +- `stuckSessionWarnMs`：当会话仍处于 processing 状态时，发出卡住会话警告所使用的年龄阈值（毫秒）。 +- `otel.enabled`：启用 OpenTelemetry 导出流水线（默认：`false`）。 +- `otel.endpoint`：OTel 导出的收集器 URL。 - `otel.protocol`：`"http/protobuf"`（默认）或 `"grpc"`。 -- `otel.headers`：随 OTel 导出请求一起发送的额外 HTTP/gRPC 元数据 headers。 -- `otel.serviceName`：资源属性中的服务名称。 -- `otel.traces` / `otel.metrics` / `otel.logs`：启用 trace、metrics 或 log 导出。 -- `otel.sampleRate`：`0`–`1` 的 trace 采样率。 +- `otel.headers`：随 OTel 导出请求发送的额外 HTTP/gRPC 元数据 headers。 +- `otel.serviceName`：资源属性中的服务名。 +- `otel.traces` / `otel.metrics` / `otel.logs`：启用 trace、metrics 或日志导出。 +- `otel.sampleRate`：trace 采样率 `0`–`1`。 - `otel.flushIntervalMs`：周期性 telemetry 刷新间隔（毫秒）。 - `cacheTrace.enabled`：为嵌入式运行记录缓存跟踪快照（默认：`false`）。 - `cacheTrace.filePath`：缓存跟踪 JSONL 的输出路径（默认：`$OPENCLAW_STATE_DIR/logs/cache-trace.jsonl`）。 -- `cacheTrace.includeMessages` / `includePrompt` / `includeSystem`：控制缓存跟踪输出中包含哪些内容（默认均为 `true`）。 +- `cacheTrace.includeMessages` / `includePrompt` / `includeSystem`：控制缓存跟踪输出中包含哪些内容（默认都为 `true`）。 --- @@ -3449,12 +3462,12 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- `channel`：用于 npm/git 安装的发布渠道——`"stable"`、`"beta"` 或 `"dev"`。 -- `checkOnStart`：在 Gateway 网关启动时检查 npm 更新（默认：`true`）。 +- `channel`：用于 npm/git 安装的发布渠道 —— `"stable"`、`"beta"` 或 `"dev"`。 +- `checkOnStart`：Gateway 网关 启动时检查 npm 更新（默认：`true`）。 - `auto.enabled`：为包安装启用后台自动更新（默认：`false`）。 -- `auto.stableDelayHours`：stable 渠道自动应用前的最小延迟小时数（默认：`6`；最大：`168`）。 -- `auto.stableJitterHours`：stable 渠道额外的发布扩散窗口小时数（默认：`12`；最大：`168`）。 -- `auto.betaCheckIntervalHours`：beta 渠道检查运行的间隔小时数（默认：`1`；最大：`24`）。 +- `auto.stableDelayHours`：stable 渠道自动应用前的最小延迟（小时，默认：`6`；最大：`168`）。 +- `auto.stableJitterHours`：stable 渠道额外滚动发布扩散窗口（小时，默认：`12`；最大：`168`）。 +- `auto.betaCheckIntervalHours`：beta 渠道检查运行频率（小时，默认：`1`；最大：`24`）。 --- @@ -3487,22 +3500,22 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- `enabled`：全局 ACP 功能门控（默认：`false`）。 -- `dispatch.enabled`：ACP 会话回合分发的独立门控（默认：`true`）。设为 `false` 时，可保留 ACP 命令可用，但阻止执行。 -- `backend`：默认 ACP 运行时后端 id（必须匹配某个已注册的 ACP 运行时插件）。 -- `defaultAgent`：当生成时未指定显式目标时，使用的回退 ACP 目标智能体 id。 -- `allowedAgents`：允许用于 ACP 运行时会话的智能体 id allowlist；为空表示无额外限制。 -- `maxConcurrentSessions`：并发活跃 ACP 会话的最大数量。 -- `stream.coalesceIdleMs`：流式文本的空闲刷新窗口（毫秒）。 -- `stream.maxChunkChars`：在拆分流式分块投影前允许的最大分块大小。 -- `stream.repeatSuppression`：按回合抑制重复状态/工具行（默认：`true`）。 -- `stream.deliveryMode`：`"live"` 会增量流式传输；`"final_only"` 会缓冲到回合终止事件后再发送。 -- `stream.hiddenBoundarySeparator`：隐藏工具事件之后、可见文本之前的分隔符（默认：`"paragraph"`）。 -- `stream.maxOutputChars`：每个 ACP 回合允许投影的 assistant 输出最大字符数。 -- `stream.maxSessionUpdateChars`：投影 ACP 状态/更新行的最大字符数。 -- `stream.tagVisibility`：流式事件中标签名称到布尔可见性覆盖的记录。 -- `runtime.ttlMinutes`：ACP 会话 worker 在可被清理前的空闲 TTL（分钟）。 -- `runtime.installCommand`：在引导 ACP 运行时环境时运行的可选安装命令。 +- `enabled`：ACP 全局功能开关（默认：`false`）。 +- `dispatch.enabled`：ACP 会话轮次分发的独立开关（默认：`true`）。设为 `false` 可在保留 ACP 命令可用的同时阻止执行。 +- `backend`：默认 ACP 运行时后端 id（必须匹配某个已注册 ACP 运行时插件）。 +- `defaultAgent`：当派生未指定显式目标时，ACP 的后备目标智能体 id。 +- `allowedAgents`：允许用于 ACP 运行时会话的智能体 id 列表；空值表示无额外限制。 +- `maxConcurrentSessions`：同时活跃的 ACP 会话最大数量。 +- `stream.coalesceIdleMs`：流式文本的空闲合并刷新窗口（毫秒）。 +- `stream.maxChunkChars`：流式块投影在拆分前允许的最大 chunk 大小。 +- `stream.repeatSuppression`：按轮次抑制重复的状态/工具行（默认：`true`）。 +- `stream.deliveryMode`：`"live"` 表示增量流式传输；`"final_only"` 表示缓冲到轮次终止事件后再输出。 +- `stream.hiddenBoundarySeparator`：在隐藏工具事件后的可见文本前插入的分隔符（默认：`"paragraph"`）。 +- `stream.maxOutputChars`：每个 ACP 轮次投影的 assistant 输出最大字符数。 +- `stream.maxSessionUpdateChars`：投影的 ACP 状态/更新行的最大字符数。 +- `stream.tagVisibility`：记录标签名到布尔可见性覆盖的映射，用于流式事件。 +- `runtime.ttlMinutes`：ACP 会话 worker 的空闲 TTL（分钟），超过后可被清理。 +- `runtime.installCommand`：在引导 ACP 运行时环境时执行的可选安装命令。 --- @@ -3518,11 +3531,11 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- `cli.banner.taglineMode` 控制 banner 标语风格： +- `cli.banner.taglineMode` 控制 banner 标语样式： - `"random"`（默认）：轮换的有趣/季节性标语。 - - `"default"`：固定的中性标语（`All your chats, one OpenClaw.`）。 + - `"default"`：固定中性标语（`All your chats, one OpenClaw.`）。 - `"off"`：不显示标语文本（仍显示 banner 标题/版本）。 -- 若要隐藏整个 banner（而不仅是标语），请设置环境变量 `OPENCLAW_HIDE_BANNER=1`。 +- 如需隐藏整个 banner（而不仅是标语），请设置环境变量 `OPENCLAW_HIDE_BANNER=1`。 --- @@ -3544,15 +3557,15 @@ SecretRef 是增量能力：明文值依然可用。 --- -## 身份 +## Identity -请参见 [Agent defaults](#agent-defaults) 下 `agents.list` 的身份字段。 +参见 [Agent defaults](#agent-defaults) 下 `agents.list` 的 identity 字段。 --- -## Bridge protocol（旧版节点，历史参考，已移除） +## Bridge（旧版，已移除） -当前构建已不再包含 TCP bridge。节点通过 Gateway 网关 WebSocket 连接。`bridge.*` 键已不再属于配置 schema 的一部分（在移除前，验证会失败；`openclaw doctor --fix` 可去除未知键）。 +当前构建已不再包含 TCP bridge。节点通过 Gateway 网关 WebSocket 连接。`bridge.*` 键已不再属于配置 schema 的一部分（必须移除后验证才会通过；`openclaw doctor --fix` 可剥离未知键）。 @@ -3581,8 +3594,8 @@ SecretRef 是增量能力：明文值依然可用。 cron: { enabled: true, maxConcurrentRuns: 2, - webhook: "https://example.invalid/legacy", // 已弃用：存量 notify:true 作业的回退 - webhookToken: "replace-with-dedicated-token", // 出站 webhook 认证的可选 bearer token + webhook: "https://example.invalid/legacy", // 已弃用：用于已存储 notify:true 作业的回退 + webhookToken: "replace-with-dedicated-token", // 可选：用于出站 webhook 认证的 bearer token sessionRetention: "24h", // 时长字符串或 false runLog: { maxBytes: "2mb", // 默认 2_000_000 字节 @@ -3592,11 +3605,11 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- `sessionRetention`：从 `sessions.json` 中裁剪前，已完成的隔离 cron 运行会话会保留多久。也控制已归档的已删除 cron 转录的清理。默认值：`24h`；设为 `false` 可禁用。 -- `runLog.maxBytes`：每个运行日志文件（`cron/runs/.jsonl`）在触发裁剪前的最大大小。默认值：`2_000_000` 字节。 -- `runLog.keepLines`：触发运行日志裁剪时保留的最新行数。默认值：`2000`。 -- `webhookToken`：用于 cron webhook `POST` 投递（`delivery.mode = "webhook"`）的 bearer token；若省略则不会发送认证 header。 -- `webhook`：已弃用的旧版回退 webhook URL（http/https），仅用于仍保留 `notify: true` 的存量作业。 +- `sessionRetention`：在从 `sessions.json` 中修剪前，已完成的隔离 cron 运行会话保留多久。也控制已归档的已删除 cron 转录的清理。默认值：`24h`；设为 `false` 可禁用。 +- `runLog.maxBytes`：每个运行日志文件（`cron/runs/.jsonl`）在修剪前的最大大小。默认值：`2_000_000` 字节。 +- `runLog.keepLines`：触发运行日志修剪时保留的最新行数。默认值：`2000`。 +- `webhookToken`：用于 cron webhook POST 交付（`delivery.mode = "webhook"`）的 bearer token；若省略，则不会发送认证 header。 +- `webhook`：已弃用的旧版回退 webhook URL（http/https），仅用于仍设置 `notify: true` 的已存储作业。 ### `cron.retry` @@ -3612,11 +3625,11 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- `maxAttempts`：一次性作业在瞬态错误下的最大重试次数（默认：`3`；范围：`0`–`10`）。 -- `backoffMs`：每次重试尝试对应的回退延迟数组（毫秒）（默认：`[30000, 60000, 300000]`；1–10 个条目）。 -- `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 作业。周期性作业使用独立的失败处理逻辑。 +仅适用于一次性 cron 作业。周期性作业使用单独的失败处理方式。 ### `cron.failureAlert` @@ -3635,10 +3648,10 @@ SecretRef 是增量能力：明文值依然可用。 ``` - `enabled`：启用 cron 作业失败告警（默认：`false`）。 -- `after`：连续失败达到多少次后触发告警（正整数，最小值：`1`）。 -- `cooldownMs`：同一作业重复告警之间的最小间隔（毫秒）（非负整数）。 -- `mode`：投递模式——`"announce"` 通过渠道消息发送；`"webhook"` 向已配置的 webhook 发送 `POST`。 -- `accountId`：用于限定告警投递范围的可选账号或渠道 id。 +- `after`：连续失败多少次后触发告警（正整数，最小值：`1`）。 +- `cooldownMs`：同一作业重复告警之间的最短间隔（毫秒，非负整数）。 +- `mode`：交付模式 —— `"announce"` 通过渠道消息发送；`"webhook"` 则 POST 到已配置的 webhook。 +- `accountId`：用于限定告警交付范围的可选账号或渠道 id。 ### `cron.failureDestination` @@ -3655,16 +3668,16 @@ SecretRef 是增量能力：明文值依然可用。 } ``` -- 所有作业共享的默认 cron 失败通知目标。 -- `mode`：`"announce"` 或 `"webhook"`；当存在足够目标数据时，默认使用 `"announce"`。 -- `channel`：用于 announce 投递的渠道覆盖。`"last"` 会复用最近一次已知投递渠道。 -- `to`：显式的 announce 目标或 webhook URL。webhook 模式下为必填。 -- `accountId`：可选的投递账号覆盖。 +- 所有作业的默认 cron 失败通知目标。 +- `mode`：`"announce"` 或 `"webhook"`；当存在足够的目标数据时，默认值为 `"announce"`。 +- `channel`：用于 announce 交付的渠道覆盖。`"last"` 会复用最后已知的交付渠道。 +- `to`：显式的 announce 目标或 webhook URL。webhook 模式下必填。 +- `accountId`：可选的交付账号覆盖。 - 按作业的 `delivery.failureDestination` 会覆盖该全局默认值。 -- 当全局和按作业失败目标都未设置时，已经通过 `announce` 投递的作业在失败时会回退到该主 announce 目标。 -- 除非作业的主 `delivery.mode` 为 `"webhook"`，否则 `delivery.failureDestination` 仅支持 `sessionTarget="isolated"` 的作业。 +- 如果既未设置全局失败目标，也未设置按作业失败目标，则已通过 `announce` 交付的作业在失败时会回退到其主 announce 目标。 +- `delivery.failureDestination` 仅支持 `sessionTarget="isolated"` 的作业，除非该作业的主 `delivery.mode` 是 `"webhook"`。 -参见 [Cron Jobs](/zh-CN/automation/cron-jobs)。隔离的 cron 执行会作为 [background tasks](/zh-CN/automation/tasks) 进行跟踪。 +参见 [Cron Jobs](/zh-CN/automation/cron-jobs)。隔离的 cron 执行会被跟踪为 [background tasks](/zh-CN/automation/tasks)。 --- @@ -3672,32 +3685,32 @@ SecretRef 是增量能力：明文值依然可用。 在 `tools.media.models[].args` 中展开的模板占位符： -| 变量 | 说明 | -| ------------------ | ------------------------------------- | -| `{{Body}}` | 完整入站消息正文 | -| `{{RawBody}}` | 原始正文（无历史/发送者包装） | -| `{{BodyStripped}}` | 去除了群组提及的正文 | -| `{{From}}` | 发送者标识符 | -| `{{To}}` | 目标标识符 | -| `{{MessageSid}}` | 渠道消息 id | -| `{{SessionId}}` | 当前会话 UUID | -| `{{IsNewSession}}` | 当新会话已创建时为 `"true"` | -| `{{MediaUrl}}` | 入站媒体伪 URL | -| `{{MediaPath}}` | 本地媒体路径 | -| `{{MediaType}}` | 媒体类型（image/audio/document/…） | -| `{{Transcript}}` | 音频转录 | -| `{{Prompt}}` | 为 CLI 条目解析出的媒体提示 | -| `{{MaxChars}}` | 为 CLI 条目解析出的最大输出字符数 | -| `{{ChatType}}` | `"direct"` 或 `"group"` | -| `{{GroupSubject}}` | 群组主题（尽力而为） | -| `{{GroupMembers}}` | 群组成员预览（尽力而为） | -| `{{SenderName}}` | 发送者显示名（尽力而为） | -| `{{SenderE164}}` | 发送者电话号码（尽力而为） | +| 变量 | 说明 | +| ------------------ | ----------------------------------------- | +| `{{Body}}` | 完整入站消息正文 | +| `{{RawBody}}` | 原始正文（无历史/发送者包装） | +| `{{BodyStripped}}` | 去除群组提及后的正文 | +| `{{From}}` | 发送者标识符 | +| `{{To}}` | 目标标识符 | +| `{{MessageSid}}` | 渠道消息 id | +| `{{SessionId}}` | 当前会话 UUID | +| `{{IsNewSession}}` | 新建会话时为 `"true"` | +| `{{MediaUrl}}` | 入站媒体伪 URL | +| `{{MediaPath}}` | 本地媒体路径 | +| `{{MediaType}}` | 媒体类型（image/audio/document/…） | +| `{{Transcript}}` | 音频转录 | +| `{{Prompt}}` | 为 CLI 条目解析后的媒体提示 | +| `{{MaxChars}}` | 为 CLI 条目解析后的最大输出字符数 | +| `{{ChatType}}` | `"direct"` 或 `"group"` | +| `{{GroupSubject}}` | 群组主题（尽力而为） | +| `{{GroupMembers}}` | 群组成员预览（尽力而为） | +| `{{SenderName}}` | 发送者显示名称（尽力而为） | +| `{{SenderE164}}` | 发送者电话号码（尽力而为） | | `{{Provider}}` | 提供商提示（whatsapp、telegram、discord 等） | --- -## 配置包含（`$include`） +## 配置 include（`$include`） 将配置拆分为多个文件： @@ -3714,12 +3727,12 @@ SecretRef 是增量能力：明文值依然可用。 **合并行为：** -- 单文件：替换其所在的包含对象。 +- 单文件：替换包含它的对象。 - 文件数组：按顺序深度合并（后者覆盖前者）。 -- 同级键：在 includes 之后合并（覆盖被包含的值）。 -- 嵌套 includes：最多 10 层。 -- 路径：相对于包含它的文件解析，但必须保持在顶层配置目录（`openclaw.json` 的 `dirname`）之内。仅当绝对路径/`../` 形式最终仍解析到该边界内时才允许。 -- 错误：会为缺失文件、解析错误和循环包含提供清晰消息。 +- 同级键：在 includes 之后合并（覆盖 include 中的值）。 +- 嵌套 includes：最多 10 层深度。 +- 路径：相对于包含它的文件解析，但必须保持在顶层配置目录（`openclaw.json` 的 `dirname`）内部。绝对路径/`../` 形式仅在最终仍解析到该边界内时才允许。 +- 错误：对缺失文件、解析错误和循环 include 提供清晰的错误消息。 --- diff --git a/docs/zh-CN/reference/rich-output-protocol.md b/docs/zh-CN/reference/rich-output-protocol.md new file mode 100644 index 000000000..94ea59937 --- /dev/null +++ b/docs/zh-CN/reference/rich-output-protocol.md @@ -0,0 +1,60 @@ +--- +x-i18n: + generated_at: "2026-04-11T12:34:16Z" + model: gpt-5.4 + provider: openai + source_hash: 2a8884fc2c304bf96d4675f0c1d1ff781d6dc1ae8c49d92ce08040c9c7709035 + source_path: reference/rich-output-protocol.md + workflow: 15 +--- + +# 富输出协议 + +助手输出可以携带一小组传递/渲染指令： + +- `MEDIA:` 用于附件传递 +- `[[audio_as_voice]]` 用于音频呈现提示 +- `[[reply_to_current]]` / `[[reply_to:]]` 用于回复元数据 +- `[embed ...]` 用于 Control UI 富渲染 + +这些指令彼此独立。`MEDIA:` 以及回复/语音标签仍然是传递元数据；`[embed ...]` 是仅限 Web 的富渲染路径。 + +## `[embed ...]` + +`[embed ...]` 是面向智能体的、用于 Control UI 的唯一富渲染语法。 + +自闭合示例： + +```text +[embed ref="cv_123" title="状态" /] +``` + +规则： + +- `[view ...]` 不再对新输出有效。 +- Embed 短代码只会在助手消息界面中渲染。 +- 只有基于 URL 的 embed 会被渲染。使用 `ref="..."` 或 `url="..."`。 +- 块级内联 HTML embed 短代码不会被渲染。 +- Web UI 会从可见文本中移除该短代码，并以内联方式渲染 embed。 +- `MEDIA:` 不是 embed 的别名，不应被用于富 embed 渲染。 + +## 存储渲染形状 + +规范化/存储后的助手内容块是一个结构化的 `canvas` 项： + +```json +{ + "type": "canvas", + "preview": { + "kind": "canvas", + "surface": "assistant_message", + "render": "url", + "viewId": "cv_123", + "url": "/__openclaw__/canvas/documents/cv_123/index.html", + "title": "Status", + "preferredHeight": 320 + } +} +``` + +存储/渲染后的富内容块直接使用这个 `canvas` 形状。`present_view` 不会被识别。