diff --git a/docs/zh-CN/channels/slack.md b/docs/zh-CN/channels/slack.md index f49c0000d..03415e0f3 100644 --- a/docs/zh-CN/channels/slack.md +++ b/docs/zh-CN/channels/slack.md @@ -1,30 +1,30 @@ --- read_when: - - 设置 Slack 或调试 Slack socket/HTTP 模式 + - 设置 Slack 或调试 Slack Socket/HTTP 模式 summary: Slack 设置与运行时行为（Socket Mode + HTTP Events API） title: Slack x-i18n: - generated_at: "2026-04-05T08:18:58Z" + generated_at: "2026-04-05T20:43:22Z" model: gpt-5.4 provider: openai - source_hash: efb37e1f04e1ac8ac3786c36ffc20013dacdc654bfa61e7f6e8df89c4902d2ab + source_hash: 7e4ff2ce7d92276d62f4f3d3693ddb56ca163d5fdc2f1082ff7ba3421fada69c source_path: channels/slack.md workflow: 15 --- # Slack -状态：已达到生产可用，可通过 Slack 应用集成支持私信和渠道。默认模式为 Socket Mode，也支持 HTTP Events API 模式。 +状态：已可用于生产环境，支持通过 Slack 应用集成进行私信和渠道通信。默认模式为 Socket Mode；也支持 HTTP Events API 模式。 - + Slack 私信默认使用配对模式。 - + 原生命令行为与命令目录。 - - 跨渠道诊断与修复手册。 + + 跨渠道诊断与修复操作手册。 @@ -66,7 +66,7 @@ SLACK_BOT_TOKEN=xoxb-... - 为以下事件订阅 bot 事件： + 为以下事件订阅机器人事件： - `app_mention` - `message.channels`, `message.groups`, `message.im`, `message.mpim` @@ -75,7 +75,7 @@ SLACK_BOT_TOKEN=xoxb-... - `channel_rename` - `pin_added`, `pin_removed` - 同时为私信启用 App Home 的 **Messages Tab**。 + 另外，为私信启用 App Home **Messages Tab**。 @@ -93,9 +93,9 @@ openclaw gateway - - 将模式设置为 HTTP（`channels.slack.mode="http"`） + - 将模式设为 HTTP（`channels.slack.mode="http"`） - 复制 Slack **Signing Secret** - - 将 Event Subscriptions、Interactivity 和 Slash command 的 Request URL 都设置为相同的 webhook 路径（默认 `/slack/events`） + - 将 Event Subscriptions、Interactivity 和 Slash command 的 Request URL 都设为同一个 webhook 路径（默认 `/slack/events`） @@ -118,19 +118,19 @@ openclaw gateway - 支持按账户分别配置 HTTP 模式。 + 支持按账户配置 HTTP 模式。 - 为每个账户提供不同的 `webhookPath`，以避免注册冲突。 + 为每个账户指定不同的 `webhookPath`，避免注册冲突。 -## Manifest 和 scope 检查清单 +## 清单与作用域检查清单 - + ```json { @@ -207,8 +207,8 @@ openclaw gateway - - 如果你配置了 `channels.slack.userToken`，常见的读取 scope 包括： + + 如果你配置了 `channels.slack.userToken`，典型的读取作用域包括： - `channels:history`, `groups:history`, `im:history`, `mpim:history` - `channels:read`, `groups:read`, `im:read`, `mpim:read` @@ -225,28 +225,33 @@ openclaw gateway - Socket Mode 需要 `botToken` + `appToken`。 - HTTP 模式需要 `botToken` + `signingSecret`。 -- `botToken`、`appToken`、`signingSecret` 和 `userToken` 接受纯文本字符串或 SecretRef 对象。 +- `botToken`、`appToken`、`signingSecret` 和 `userToken` 接受明文 + 字符串或 SecretRef 对象。 - 配置中的令牌会覆盖环境变量回退。 - `SLACK_BOT_TOKEN` / `SLACK_APP_TOKEN` 环境变量回退仅适用于默认账户。 -- `userToken`（`xoxp-...`）仅支持通过配置提供（无环境变量回退），并默认启用只读行为（`userTokenReadOnly: true`）。 -- 可选：如果你希望出站消息使用当前智能体身份（自定义 `username` 和图标），可添加 `chat:write.customize`。`icon_emoji` 使用 `:emoji_name:` 语法。 +- `userToken`（`xoxp-...`）仅支持通过配置提供（无环境变量回退），并默认采用只读行为（`userTokenReadOnly: true`）。 +- 可选：如果你希望发送消息使用当前智能体身份（自定义 `username` 和图标），可添加 `chat:write.customize`。`icon_emoji` 使用 `:emoji_name:` 语法。 状态快照行为： -- Slack 账户检查会跟踪每个凭证的 `*Source` 和 `*Status` 字段（`botToken`、`appToken`、`signingSecret`、`userToken`）。 -- 状态值为 `available`、`configured_unavailable` 或 `missing`。 -- `configured_unavailable` 表示该账户通过 SecretRef 或其他非内联密钥来源完成了配置，但当前命令/运行时路径无法解析实际值。 -- 在 HTTP 模式下，会包含 `signingSecretStatus`；在 Socket Mode 下，必需的配对是 `botTokenStatus` + `appTokenStatus`。 +- Slack 账户检查会跟踪每项凭证对应的 `*Source` 和 `*Status` + 字段（`botToken`、`appToken`、`signingSecret`、`userToken`）。 +- 状态可能为 `available`、`configured_unavailable` 或 `missing`。 +- `configured_unavailable` 表示该账户通过 SecretRef + 或其他非内联密钥来源完成了配置，但当前命令/运行时路径 + 无法解析出实际值。 +- 在 HTTP 模式下，会包含 `signingSecretStatus`；在 Socket Mode 下， + 必需的配对是 `botTokenStatus` + `appTokenStatus`。 -对于操作/目录读取，如果已配置用户令牌，则可优先使用用户令牌。对于写入操作，仍优先使用 bot 令牌；只有当 `userTokenReadOnly: false` 且 bot 令牌不可用时，才允许使用用户令牌进行写入。 +对于操作/目录读取，如果已配置用户令牌，则可以优先使用用户令牌。对于写入，仍优先使用机器人令牌；只有当 `userTokenReadOnly: false` 且机器人令牌不可用时，才允许使用用户令牌执行写入。 ## 操作与门控 Slack 操作由 `channels.slack.actions.*` 控制。 -当前 Slack 工具中可用的操作组： +当前 Slack 工具中的可用操作组： | 组 | 默认值 | | ---------- | ------- | @@ -280,10 +285,10 @@ Slack 操作由 `channels.slack.actions.*` 控制。 多账户优先级： - `channels.slack.accounts.default.allowFrom` 仅适用于 `default` 账户。 - - 命名账户在自身 `allowFrom` 未设置时，会继承 `channels.slack.allowFrom`。 + - 命名账户在其自身 `allowFrom` 未设置时，会继承 `channels.slack.allowFrom`。 - 命名账户不会继承 `channels.slack.accounts.default.allowFrom`。 - 在私信中配对使用 `openclaw pairing approve slack `。 + 在私信中进行配对时，使用 `openclaw pairing approve slack `。 @@ -296,13 +301,13 @@ Slack 操作由 `channels.slack.actions.*` 控制。 渠道允许列表位于 `channels.slack.channels` 下，应使用稳定的渠道 ID。 - 运行时说明：如果完全缺少 `channels.slack`（仅使用环境变量设置），运行时会回退为 `groupPolicy="allowlist"` 并记录警告（即使设置了 `channels.defaults.groupPolicy` 也是如此）。 + 运行时说明：如果 `channels.slack` 完全缺失（仅环境变量设置），运行时将回退到 `groupPolicy="allowlist"` 并记录警告（即使设置了 `channels.defaults.groupPolicy` 也是如此）。 名称/ID 解析： - 当令牌访问允许时，渠道允许列表条目和私信允许列表条目会在启动时解析 - - 无法解析的渠道名称条目会按配置保留，但默认会在路由中被忽略 - - 入站授权和渠道路由默认优先使用 ID；只有设置 `channels.slack.dangerouslyAllowNameMatching: true` 时，才会直接按用户名/slug 匹配 + - 无法解析的渠道名称条目会按配置保留，但默认不会用于路由 + - 入站授权和渠道路由默认优先使用 ID；若要直接按用户名/slug 匹配，需要设置 `channels.slack.dangerouslyAllowNameMatching: true` @@ -312,10 +317,10 @@ Slack 操作由 `channels.slack.actions.*` 控制。 提及来源： - 显式应用提及（`<@botId>`） - - 提及正则模式（`agents.list[].groupChat.mentionPatterns`，回退到 `messages.groupChat.mentionPatterns`） + - 提及正则模式（`agents.list[].groupChat.mentionPatterns`，回退为 `messages.groupChat.mentionPatterns`） - 隐式回复机器人线程行为 - 按渠道的控制项（`channels.slack.channels.`；名称仅通过启动时解析或 `dangerouslyAllowNameMatching` 支持）： + 按渠道控制（`channels.slack.channels.`；名称仅通过启动解析或 `dangerouslyAllowNameMatching` 支持）： - `requireMention` - `users`（允许列表） @@ -323,25 +328,25 @@ Slack 操作由 `channels.slack.actions.*` 控制。 - `skills` - `systemPrompt` - `tools`, `toolsBySender` - - `toolsBySender` 键格式：`id:`、`e164:`、`username:`、`name:` 或 `"*"` 通配符 - （旧版无前缀键仍只映射为 `id:`） + - `toolsBySender` 键格式：`id:`、`e164:`、`username:`、`name:`，或 `"*"` 通配符 + （旧版无前缀键仍只映射到 `id:`） -## 线程、会话和回复标签 +## 线程、会话与回复标签 - 私信路由为 `direct`；渠道为 `channel`；MPIM 为 `group`。 -- 使用默认 `session.dmScope=main` 时，Slack 私信会合并到智能体主会话。 +- 使用默认 `session.dmScope=main` 时，Slack 私信会折叠到智能体主会话。 - 渠道会话：`agent::slack:channel:`。 -- 在线程回复适用时，线程回复可创建线程会话后缀（`:thread:`）。 +- 在线程回复适用时，可创建线程会话后缀（`:thread:`）。 - `channels.slack.thread.historyScope` 默认值为 `thread`；`thread.inheritParent` 默认值为 `false`。 -- `channels.slack.thread.initialHistoryLimit` 控制新线程会话启动时抓取多少现有线程消息（默认 `20`；设置为 `0` 可禁用）。 +- `channels.slack.thread.initialHistoryLimit` 控制新线程会话启动时会抓取多少现有线程消息（默认 `20`；设为 `0` 可禁用）。 回复线程控制： -- `channels.slack.replyToMode`：`off|first|all`（默认 `off`） -- `channels.slack.replyToModeByChatType`：按 `direct|group|channel` 分别设置 +- `channels.slack.replyToMode`：`off|first|all|batched`（默认 `off`） +- `channels.slack.replyToModeByChatType`：按 `direct|group|channel` 分别配置 - 私聊的旧版回退：`channels.slack.dm.replyToMode` 支持手动回复标签： @@ -349,11 +354,11 @@ Slack 操作由 `channels.slack.actions.*` 控制。 - `[[reply_to_current]]` - `[[reply_to:]]` -注意：`replyToMode="off"` 会禁用 Slack 中的**所有**回复线程功能，包括显式 `[[reply_to_*]]` 标签。这与 Telegram 不同：在 `"off"` 模式下，Telegram 仍会遵循显式标签。这个差异反映了平台的线程模型：Slack 线程会将消息隐藏在渠道之外，而 Telegram 回复仍会显示在主聊天流中。 +注意：`replyToMode="off"` 会禁用 Slack 中的**所有**回复线程行为，包括显式 `[[reply_to_*]]` 标签。这与 Telegram 不同，在 Telegram 中，即使在 `"off"` 模式下也仍会遵循显式标签。之所以不同，是因为平台线程模型不同：Slack 线程会将消息隐藏在渠道主流之外，而 Telegram 回复仍会显示在主聊天流中。 -## 确认反应 +## 确认表情回应 -`ackReaction` 会在 OpenClaw 处理入站消息时发送一个确认 emoji。 +`ackReaction` 会在 OpenClaw 处理入站消息期间发送一个确认表情。 解析顺序： @@ -364,8 +369,8 @@ Slack 操作由 `channels.slack.actions.*` 控制。 说明： -- Slack 需要使用 shortcode（例如 `"eyes"`）。 -- 使用 `""` 可为某个 Slack 账户或全局禁用该反应。 +- Slack 需要使用短代码（例如 `"eyes"`）。 +- 使用 `""` 可为某个 Slack 账户或全局禁用该表情回应。 ## 文本流式传输 @@ -379,10 +384,10 @@ Slack 操作由 `channels.slack.actions.*` 控制。 当 `streaming` 为 `partial` 时，`channels.slack.nativeStreaming` 控制 Slack 原生文本流式传输（默认：`true`）。 - 必须有可用的回复线程，原生文本流式传输才会显示。线程选择仍遵循 `replyToMode`。如果没有，则使用普通草稿预览。 -- 媒体和非文本负载会回退为普通投递。 -- 如果流式传输在回复中途失败，OpenClaw 会对剩余负载回退为普通投递。 +- 媒体和非文本负载会回退到普通投递。 +- 如果流式传输在回复中途失败，OpenClaw 会将剩余负载回退为普通投递。 -使用草稿预览而不是 Slack 原生文本流式传输： +如果要使用草稿预览而不是 Slack 原生文本流式传输： ```json5 { @@ -398,11 +403,11 @@ Slack 操作由 `channels.slack.actions.*` 控制。 旧版键： - `channels.slack.streamMode`（`replace | status_final | append`）会自动迁移到 `channels.slack.streaming`。 -- 布尔值 `channels.slack.streaming` 会自动迁移到 `channels.slack.nativeStreaming`。 +- 布尔型 `channels.slack.streaming` 会自动迁移到 `channels.slack.nativeStreaming`。 -## 输入中反应回退 +## 输入中表情回应回退 -`typingReaction` 会在 OpenClaw 处理回复期间，向入站 Slack 消息添加一个临时反应，并在运行结束时将其移除。这在非线程回复场景下最有用，因为线程回复会使用默认的“正在输入...”状态指示器。 +`typingReaction` 会在 OpenClaw 处理回复期间，为入站 Slack 消息添加一个临时表情回应，并在运行结束后移除。在非线程回复场景中，这最有用，因为线程回复会使用默认的“正在输入...”状态指示器。 解析顺序： @@ -411,33 +416,33 @@ Slack 操作由 `channels.slack.actions.*` 控制。 说明： -- Slack 需要使用 shortcode（例如 `"hourglass_flowing_sand"`）。 -- 该反应为尽力而为，系统会在回复完成或失败路径结束后自动尝试清理。 +- Slack 需要使用短代码（例如 `"hourglass_flowing_sand"`）。 +- 该表情回应为尽力而为，回复完成或失败路径结束后会自动尝试清理。 ## 媒体、分块与投递 - Slack 文件附件会从 Slack 托管的私有 URL 下载（基于令牌认证的请求流程），并在抓取成功且大小限制允许时写入媒体存储。 + Slack 文件附件会从 Slack 托管的私有 URL 下载（基于令牌认证的请求流程），并在抓取成功且尺寸限制允许时写入媒体存储。 - 运行时入站大小上限默认是 `20MB`，除非通过 `channels.slack.mediaMaxMb` 覆盖。 + 运行时入站大小上限默认是 `20MB`，除非由 `channels.slack.mediaMaxMb` 覆盖。 - + - 文本分块使用 `channels.slack.textChunkLimit`（默认 4000） - `channels.slack.chunkMode="newline"` 启用优先按段落拆分 - 文件发送使用 Slack 上传 API，并可包含线程回复（`thread_ts`） - - 配置了 `channels.slack.mediaMaxMb` 时，出站媒体上限遵循该值；否则渠道发送使用媒体流水线中的 MIME 类型默认值 + - 如果配置了 `channels.slack.mediaMaxMb`，则出站媒体上限遵循该值；否则渠道发送会使用媒体流水线中的 MIME 类型默认值 - 首选的显式目标： + 推荐使用显式目标： - - 私信用 `user:` - - 渠道用 `channel:` + - `user:` 用于私信 + - `channel:` 用于渠道 - 向用户目标发送时，Slack 私信会通过 Slack 会话 API 打开。 + 发送到用户目标时，Slack 私信会通过 Slack conversation API 打开。 @@ -445,16 +450,16 @@ Slack 操作由 `channels.slack.actions.*` 控制。 ## 命令与斜杠行为 - Slack 的原生命令自动模式默认**关闭**（`commands.native: "auto"` 不会启用 Slack 原生命令）。 -- 使用 `channels.slack.commands.native: true`（或全局 `commands.native: true`）启用原生 Slack 命令处理器。 -- 启用原生命令后，在 Slack 中注册匹配的斜杠命令（`/` 名称），但有一个例外： - - 状态命令应注册为 `/agentstatus`（Slack 保留了 `/status`） +- 使用 `channels.slack.commands.native: true`（或全局 `commands.native: true`）启用 Slack 原生命令处理器。 +- 启用原生命令后，需要在 Slack 中注册对应的斜杠命令（`/` 名称），但有一个例外： + - 状态命令请注册 `/agentstatus`（Slack 保留了 `/status`） - 如果未启用原生命令，你可以通过 `channels.slack.slashCommand` 运行单个已配置的斜杠命令。 - 原生参数菜单现在会自适应其渲染策略： - 最多 5 个选项：按钮块 - 6-100 个选项：静态选择菜单 - - 超过 100 个选项：当提供交互选项处理器时，使用带异步选项过滤的外部选择 + - 超过 100 个选项：当可用交互选项处理器时，使用带异步选项过滤的外部选择 - 如果编码后的选项值超出 Slack 限制，流程会回退为按钮 -- 对于较长的选项负载，斜杠命令参数菜单会在分发所选值之前显示确认对话框。 +- 对于较长的选项负载，斜杠命令参数菜单会在分发所选值之前使用确认对话框。 默认斜杠命令设置： @@ -467,13 +472,13 @@ Slack 操作由 `channels.slack.actions.*` 控制。 - `agent::slack:slash:` -并且仍会针对目标会话路由命令执行（`CommandTargetSessionKey`）。 +并且仍会针对目标对话会话（`CommandTargetSessionKey`）路由命令执行。 ## 交互式回复 Slack 可以渲染由智能体生成的交互式回复控件，但此功能默认禁用。 -全局启用方式： +全局启用： ```json5 { @@ -487,7 +492,7 @@ Slack 可以渲染由智能体生成的交互式回复控件，但此功能默 } ``` -或仅为一个 Slack 账户启用： +或仅为某个 Slack 账户启用： ```json5 { @@ -505,38 +510,40 @@ Slack 可以渲染由智能体生成的交互式回复控件，但此功能默 } ``` -启用后，智能体可以输出 Slack 专用的回复指令： +启用后，智能体可以发出仅适用于 Slack 的回复指令： - `[[slack_buttons: Approve:approve, Reject:reject]]` - `[[slack_select: Choose a target | Canary:canary, Production:production]]` -这些指令会编译为 Slack Block Kit，并将点击或选择通过现有的 Slack 交互事件路径路由回去。 +这些指令会编译为 Slack Block Kit，并将点击或选择通过现有 Slack 交互事件路径路由回来。 说明： -- 这是 Slack 专用 UI。其他渠道不会将 Slack Block Kit 指令转换为它们自己的按钮系统。 -- 交互回调值是 OpenClaw 生成的不透明令牌，不是智能体原始编写的值。 -- 如果生成的交互块超出 Slack Block Kit 限制，OpenClaw 会回退为原始文本回复，而不是发送无效的 blocks 负载。 +- 这是 Slack 专用 UI。其他渠道不会将 Slack Block Kit 指令翻译为它们自己的按钮系统。 +- 交互回调值是 OpenClaw 生成的不透明令牌，而不是智能体原始编写的值。 +- 如果生成的交互块会超出 Slack Block Kit 限制，OpenClaw 会回退为原始文本回复，而不是发送无效的块负载。 -## Slack 中的 exec 审批 +## Slack 中的 Exec 审批 Slack 可以作为原生审批客户端，使用交互按钮和交互事件，而不是回退到 Web UI 或终端。 - Exec 审批使用 `channels.slack.execApprovals.*` 进行原生私信/渠道路由。 -- 如果请求已经落在 Slack 中且审批 ID 类型为 `plugin:`，插件审批仍可通过同一个 Slack 原生按钮界面处理。 -- 审批人授权仍然会被强制执行：只有被识别为审批人的用户，才能通过 Slack 批准或拒绝请求。 +- 当请求已经落在 Slack 中且审批 ID 类型为 `plugin:` 时，插件审批仍可通过同一个 Slack 原生按钮界面进行处理。 +- 审批人授权仍会被强制执行：只有被识别为审批人的用户才能通过 Slack 批准或拒绝请求。 -这使用与其他渠道相同的共享审批按钮界面。当你在 Slack 应用设置中启用了 `interactivity` 时，审批提示会直接在会话中渲染为 Block Kit 按钮。 -当这些按钮存在时，它们就是主要审批 UX；只有当工具结果表明聊天审批不可用，或手动审批是唯一途径时，OpenClaw 才应包含手动 `/approve` 命令。 +这使用与其他渠道相同的共享审批按钮界面。当你在 Slack 应用设置中启用了 `interactivity` 后，审批提示会直接在对话中渲染为 Block Kit 按钮。 +当这些按钮存在时，它们就是主要的审批 UX；只有当工具结果表明聊天审批不可用或手动审批是唯一途径时，OpenClaw +才应包含手动 `/approve` 命令。 配置路径： - `channels.slack.execApprovals.enabled` -- `channels.slack.execApprovals.approvers`（可选；尽可能回退到 `commands.ownerAllowFrom`） +- `channels.slack.execApprovals.approvers`（可选；在可能时回退为 `commands.ownerAllowFrom`） - `channels.slack.execApprovals.target`（`dm` | `channel` | `both`，默认：`dm`） - `agentFilter`、`sessionFilter` -当 `enabled` 未设置或为 `"auto"`，且至少解析出一位审批人时，Slack 会自动启用原生 exec 审批。设置 `enabled: false` 可显式禁用 Slack 作为原生审批客户端。 +当 `enabled` 未设置或为 `"auto"` 且至少解析出一名 +审批人时，Slack 会自动启用原生 exec 审批。设置 `enabled: false` 可显式禁用 Slack 作为原生审批客户端。 设置 `enabled: true` 可在审批人解析成功时强制启用原生审批。 在没有显式 Slack exec 审批配置时的默认行为： @@ -549,7 +556,8 @@ Slack 可以作为原生审批客户端，使用交互按钮和交互事件， } ``` -只有当你想覆盖审批人、添加过滤器或选择向来源聊天投递时，才需要显式 Slack 原生配置： +只有当你想覆盖审批人、添加过滤器或 +选择源聊天投递时，才需要显式 Slack 原生配置： ```json5 { @@ -565,27 +573,30 @@ Slack 可以作为原生审批客户端，使用交互按钮和交互事件， } ``` -共享的 `approvals.exec` 转发是独立的。仅当 exec 审批提示还必须路由到其他聊天或显式带外目标时才使用它。共享的 `approvals.plugin` 转发也是独立的；当这些请求已经落在 Slack 中时，Slack 原生按钮仍可处理插件审批。 +共享 `approvals.exec` 转发是独立功能。只有当 exec 审批提示还必须 +路由到其他聊天或显式的带外目标时，才使用它。共享 `approvals.plugin` 转发也 +是独立功能；当这些请求已经落在 Slack +中时，Slack 原生按钮仍可处理插件审批。 -同一聊天中的 `/approve` 也可在已支持命令的 Slack 渠道和私信中使用。有关完整的审批转发模型，请参阅 [Exec approvals](/tools/exec-approvals)。 +同一聊天中的 `/approve` 也可在已支持命令的 Slack 渠道和私信中使用。完整的审批转发模型，请参见 [Exec approvals](/zh-CN/tools/exec-approvals)。 ## 事件与运行行为 - 消息编辑/删除/线程广播会映射为系统事件。 -- 添加/移除反应事件会映射为系统事件。 -- 成员加入/离开、渠道创建/重命名以及添加/移除置顶事件会映射为系统事件。 +- 添加/移除表情回应事件会映射为系统事件。 +- 成员加入/离开、渠道创建/重命名，以及添加/移除置顶事件都会映射为系统事件。 - 当启用 `configWrites` 时，`channel_id_changed` 可以迁移渠道配置键。 -- 渠道 topic/purpose 元数据被视为不可信上下文，并可注入到路由上下文中。 -- 在线程发起者和初始线程历史上下文植入时，会在适用情况下按配置的发送者允许列表进行过滤。 -- Block action 和 modal 交互会发出结构化的 `Slack interaction: ...` 系统事件，并携带丰富的负载字段： - - block action：选定值、标签、picker 值以及 `workflow_*` 元数据 - - modal `view_submission` 和 `view_closed` 事件，包含已路由的渠道元数据和表单输入 +- 渠道 topic/purpose 元数据被视为不可信上下文，可注入到路由上下文中。 +- 线程发起者和初始线程历史上下文播种会在适用时按配置的发送者允许列表进行过滤。 +- 块操作和模态交互会发出结构化的 `Slack interaction: ...` 系统事件，并带有丰富的负载字段： + - 块操作：所选值、标签、选择器值以及 `workflow_*` 元数据 + - 模态 `view_submission` 和 `view_closed` 事件，带有路由后的渠道元数据和表单输入 -## 配置参考指引 +## 配置参考指针 主要参考： -- [配置参考 - Slack](/gateway/configuration-reference#slack) +- [配置参考 - Slack](/zh-CN/gateway/configuration-reference#slack) 高信号 Slack 字段： - mode/auth：`mode`、`botToken`、`appToken`、`signingSecret`、`webhookPath`、`accounts.*` @@ -600,12 +611,12 @@ Slack 可以作为原生审批客户端，使用交互按钮和交互事件， - 请按顺序检查： + 按顺序检查： - `groupPolicy` - 渠道允许列表（`channels.slack.channels`） - `requireMention` - - 按渠道的 `users` 允许列表 + - 按渠道配置的 `users` 允许列表 有用的命令： @@ -631,17 +642,17 @@ openclaw pairing list slack - 请在 Slack 应用设置中验证 bot + app 令牌以及 Socket Mode 是否已启用。 + 验证机器人令牌、应用令牌以及 Slack 应用设置中的 Socket Mode 是否已启用。 如果 `openclaw channels status --probe --json` 显示 `botTokenStatus` 或 - `appTokenStatus: "configured_unavailable"`，则表示该 Slack 账户 - 已完成配置，但当前运行时无法解析由 SecretRef 支持的 - 实际值。 + `appTokenStatus: "configured_unavailable"`，说明 Slack 账户已完成 + 配置，但当前运行时无法解析由 SecretRef 支持的 + 值。 - 请验证： + 验证： - signing secret - webhook 路径 @@ -649,28 +660,28 @@ openclaw pairing list slack - 每个 HTTP 账户使用唯一的 `webhookPath` 如果账户快照中出现 `signingSecretStatus: "configured_unavailable"`， - 则表示该 HTTP 账户已完成配置，但当前运行时无法 + 说明该 HTTP 账户已完成配置，但当前运行时无法 解析由 SecretRef 支持的 signing secret。 - - 请确认你的预期是： + + 确认你原本是想使用： - - 原生命令模式（`channels.slack.commands.native: true`），并已在 Slack 中注册匹配的斜杠命令 + - 原生命令模式（`channels.slack.commands.native: true`），并在 Slack 中注册匹配的斜杠命令 - 或单一斜杠命令模式（`channels.slack.slashCommand.enabled: true`） - 同时检查 `commands.useAccessGroups` 以及渠道/用户允许列表。 + 还要检查 `commands.useAccessGroups` 以及渠道/用户允许列表。 ## 相关内容 -- [配对](/channels/pairing) -- [群组](/channels/groups) -- [安全](/gateway/security) -- [渠道路由](/channels/channel-routing) -- [故障排除](/channels/troubleshooting) -- [配置](/gateway/configuration) -- [斜杠命令](/tools/slash-commands) +- [配对](/zh-CN/channels/pairing) +- [群组](/zh-CN/channels/groups) +- [安全](/zh-CN/gateway/security) +- [渠道路由](/zh-CN/channels/channel-routing) +- [故障排除](/zh-CN/channels/troubleshooting) +- [配置](/zh-CN/gateway/configuration) +- [斜杠命令](/zh-CN/tools/slash-commands) diff --git a/docs/zh-CN/gateway/configuration-reference.md b/docs/zh-CN/gateway/configuration-reference.md index 3a189adca..f0780972b 100644 --- a/docs/zh-CN/gateway/configuration-reference.md +++ b/docs/zh-CN/gateway/configuration-reference.md @@ -5,17 +5,17 @@ read_when: summary: 每个 OpenClaw 配置键、默认值和渠道设置的完整参考 title: 配置参考 x-i18n: - generated_at: "2026-04-05T19:23:49Z" + generated_at: "2026-04-05T20:47:34Z" model: gpt-5.4 provider: openai - source_hash: b2ac0b26762d642cd3667b3f18b11938947968e79d9cd363e86e31312ce7e981 + source_hash: 46c05fdae14b9cb5a4baadd6d906145c3d875356ec5d728b483e85ee12c04b44 source_path: gateway/configuration-reference.md workflow: 15 --- # 配置参考 -`~/.openclaw/openclaw.json` 中提供的每个字段。若要查看面向任务的概览，请参见 [Configuration](/zh-CN/gateway/configuration)。 +`~/.openclaw/openclaw.json` 中可用的每个字段。若要查看面向任务的概览，请参见 [Configuration](/zh-CN/gateway/configuration)。 配置格式为 **JSON5**（允许注释和尾随逗号）。所有字段都是可选的——省略时，OpenClaw 会使用安全的默认值。 @@ -23,34 +23,34 @@ x-i18n: ## 渠道 -每个渠道只要存在其配置段，就会自动启动（除非设置了 `enabled: false`）。 +只要渠道配置部分存在，每个渠道都会自动启动（除非设置了 `enabled: false`）。 ### 私信和群组访问 所有渠道都支持私信策略和群组策略： -| 私信策略 | 行为 | -| --------------------- | ------------------------------------- | -| `pairing`（默认） | 未知发送者会收到一次性配对码；所有者必须批准 | -| `allowlist` | 仅允许 `allowFrom` 中的发送者（或已配对允许存储中的发送者） | -| `open` | 允许所有传入私信（需要 `allowFrom: ["*"]`） | -| `disabled` | 忽略所有传入私信 | +| 私信策略 | 行为 | +| ------------------- | ---------------------------------------------------- | +| `pairing`（默认） | 未知发送者会收到一次性配对码；需要所有者批准 | +| `allowlist` | 仅允许 `allowFrom` 中的发送者（或已配对允许存储中） | +| `open` | 允许所有传入私信（需要 `allowFrom: ["*"]`） | +| `disabled` | 忽略所有传入私信 | -| 群组策略 | 行为 | -| ----------------------- | ----------------------------------------- | -| `allowlist`（默认） | 仅允许与已配置允许列表匹配的群组 | -| `open` | 绕过群组允许列表（仍会应用提及门控） | -| `disabled` | 阻止所有群组/房间消息 | +| 群组策略 | 行为 | +| --------------------- | ---------------------------------------------------- | +| `allowlist`（默认） | 仅允许与已配置允许列表匹配的群组 | +| `open` | 绕过群组允许列表（仍会应用提及门控） | +| `disabled` | 屏蔽所有群组/房间消息 | -`channels.defaults.groupPolicy` 会在提供商的 `groupPolicy` 未设置时作为默认值。 -配对码会在 1 小时后过期。待处理的私信配对请求每个渠道上限为 **3 个**。 -如果某个提供商块完全缺失（不存在 `channels.`），运行时群组策略会回退为 `allowlist`（默认拒绝）并在启动时发出警告。 +`channels.defaults.groupPolicy` 会在 provider 的 `groupPolicy` 未设置时作为默认值。 +配对码会在 1 小时后过期。待处理的私信配对请求每个渠道最多 **3 个**。 +如果某个 provider 配置块完全缺失（`channels.` 不存在），运行时群组策略会回退为 `allowlist`（失败关闭），并在启动时给出警告。 ### 渠道模型覆盖 -使用 `channels.modelByChannel` 将特定渠道 ID 固定到某个模型。值接受 `provider/model` 或已配置的模型别名。当某个会话尚未有模型覆盖时（例如通过 `/model` 设置），才会应用该渠道映射。 +使用 `channels.modelByChannel` 将特定渠道 ID 固定到某个模型。值接受 `provider/model` 或已配置的模型别名。当会话尚未有模型覆盖时（例如通过 `/model` 设置），会应用该渠道映射。 ```json5 { @@ -73,7 +73,7 @@ x-i18n: ### 渠道默认值和心跳 -使用 `channels.defaults` 为各提供商共享群组策略和心跳行为： +使用 `channels.defaults` 为各个 provider 共享群组策略和心跳行为： ```json5 { @@ -91,15 +91,15 @@ x-i18n: } ``` -- `channels.defaults.groupPolicy`：当提供商级 `groupPolicy` 未设置时使用的回退群组策略。 -- `channels.defaults.contextVisibility`：所有渠道的默认补充上下文可见性模式。取值：`all`（默认，包含所有引用/线程/历史上下文）、`allowlist`（仅包含来自允许列表发送者的上下文）、`allowlist_quote`（与 allowlist 相同，但保留显式引用/回复上下文）。每渠道覆盖：`channels..contextVisibility`。 +- `channels.defaults.groupPolicy`：当 provider 级别的 `groupPolicy` 未设置时使用的回退群组策略。 +- `channels.defaults.contextVisibility`：所有渠道的默认补充上下文可见性模式。取值：`all`（默认，包含所有引用/线程/历史上下文）、`allowlist`（仅包含来自允许列表发送者的上下文）、`allowlist_quote`（与 allowlist 相同，但保留显式引用/回复上下文）。每个渠道可通过 `channels..contextVisibility` 覆盖。 - `channels.defaults.heartbeat.showOk`：在心跳输出中包含健康渠道状态。 - `channels.defaults.heartbeat.showAlerts`：在心跳输出中包含降级/错误状态。 -- `channels.defaults.heartbeat.useIndicator`：渲染紧凑的指示器样式心跳输出。 +- `channels.defaults.heartbeat.useIndicator`：渲染紧凑的指示器式心跳输出。 ### WhatsApp -WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已关联的会话时会自动启动。 +WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已关联会话时会自动启动。 ```json5 { @@ -110,7 +110,7 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 textChunkLimit: 4000, chunkMode: "length", // length | newline mediaMaxMb: 50, - sendReadReceipts: true, // 蓝色对勾（自聊模式下为 false） + sendReadReceipts: true, // 蓝色对勾（self-chat 模式下为 false） groups: { "*": { requireMention: true }, }, @@ -150,8 +150,8 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 } ``` -- 出站命令默认使用账号 `default`（如果存在）；否则使用第一个已配置的账号 ID（排序后）。 -- 可选的 `channels.whatsapp.defaultAccount` 会在其匹配已配置账号 ID 时覆盖该默认账号选择。 +- 出站命令默认使用 `default` 账号（如果存在）；否则使用第一个已配置的账号 ID（按排序）。 +- 可选的 `channels.whatsapp.defaultAccount` 可在其匹配某个已配置账号 ID 时覆盖该默认账号选择逻辑。 - 旧版单账号 Baileys 认证目录会由 `openclaw doctor` 迁移到 `whatsapp/default`。 - 每账号覆盖：`channels.whatsapp.accounts..sendReadReceipts`、`channels.whatsapp.accounts..dmPolicy`、`channels.whatsapp.accounts..allowFrom`。 @@ -182,13 +182,13 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 }, }, customCommands: [ - { command: "backup", description: "Git 备份" }, - { command: "generate", description: "创建图像" }, + { command: "backup", description: "Git backup" }, + { command: "generate", description: "Create an image" }, ], historyLimit: 50, - replyToMode: "first", // off | first | all + 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, @@ -212,11 +212,11 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 ``` - Bot token：`channels.telegram.botToken` 或 `channels.telegram.tokenFile`（仅允许常规文件；拒绝符号链接），默认账号还可回退到 `TELEGRAM_BOT_TOKEN`。 -- 可选的 `channels.telegram.defaultAccount` 会在其匹配已配置账号 ID 时覆盖默认账号选择。 +- 可选的 `channels.telegram.defaultAccount` 可在其匹配某个已配置账号 ID 时覆盖默认账号选择。 - 在多账号设置（2 个及以上账号 ID）中，设置显式默认值（`channels.telegram.defaultAccount` 或 `channels.telegram.accounts.default`）以避免回退路由；若缺失或无效，`openclaw doctor` 会发出警告。 - `configWrites: false` 会阻止由 Telegram 发起的配置写入（超级群组 ID 迁移、`/config set|unset`）。 -- 顶层 `bindings[]` 中 `type: "acp"` 的条目可为论坛话题配置持久 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 @@ -246,7 +246,7 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 events: true, moderation: false, }, - replyToMode: "off", // off | first | all + replyToMode: "off", // off | first | all | batched dmPolicy: "pairing", allowFrom: ["1234567890", "123456789012345678"], dm: { enabled: true, groupEnabled: false, groupChannels: ["openclaw-dm"] }, @@ -264,7 +264,7 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 requireMention: true, users: ["987654321098765432"], skills: ["docs"], - systemPrompt: "只给出简短回答。", + systemPrompt: "Short answers only.", }, }, }, @@ -283,7 +283,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, @@ -320,35 +320,35 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 ``` - Token：`channels.discord.token`，默认账号可回退到 `DISCORD_BOT_TOKEN`。 -- 直接出站调用如果显式提供 Discord `token`，该次调用会使用该 token；账号重试/策略设置仍来自活动运行时快照中的已选账号。 -- 可选的 `channels.discord.defaultAccount` 会在其匹配已配置账号 ID 时覆盖默认账号选择。 -- 使用 `user:`（私信）或 `channel:`（服务器频道）作为投递目标；裸数字 ID 会被拒绝。 -- 服务器 slug 会转为小写并将空格替换为 `-`；频道键使用 slug 化名称（不带 `#`）。优先使用服务器 ID。 -- 默认会忽略机器人发送的消息。`allowBots: true` 会启用它们；使用 `allowBots: "mentions"` 可仅接受提及机器人的机器人消息（机器人自己发的消息仍会被过滤）。 -- `channels.discord.guilds..ignoreOtherMentions`（以及频道级覆盖）会丢弃那些提及了其他用户或角色但未提及机器人的消息（不包括 @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` 表示禁用） - - `spawnSubagentSessions`：为 `sessions_spawn({ thread: true })` 自动创建/绑定线程的选择性开关 -- 顶层 `bindings[]` 中 `type: "acp"` 的条目可为频道和线程配置持久 ACP 绑定（在 `match.peer.id` 中使用频道/线程 ID）。字段语义与 [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings) 共享。 +- 直接出站调用若显式提供 Discord `token`，该调用会使用该 token；但账号重试/策略设置仍来自活动运行时快照中选定的账号。 +- 可选的 `channels.discord.defaultAccount` 可在其匹配某个已配置账号 ID 时覆盖默认账号选择。 +- 传递目标请使用 `user:`（私信）或 `channel:`（服务器频道）；纯数字 ID 会被拒绝。 +- 服务器 slug 使用小写，并将空格替换为 `-`；频道键使用 slug 化后的名称（不带 `#`）。优先使用服务器 ID。 +- 默认会忽略由机器人自己发出的消息。`allowBots: true` 可启用；使用 `allowBots: "mentions"` 可仅接受提及该机器人的机器人消息（仍会过滤自身消息）。 +- `channels.discord.guilds..ignoreOtherMentions`（及其频道覆盖）会丢弃提及了其他用户或角色但未提及机器人的消息（不包括 @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` 表示禁用） + - `spawnSubagentSessions`：为 `sessions_spawn({ thread: true })` 自动创建/绑定线程的选择启用开关 +- 顶层 `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.autoPresence` 会将运行时可用性映射为机器人在线状态（healthy => online，degraded => idle，exhausted => dnd），并允许可选的状态文本覆盖。 -- `channels.discord.dangerouslyAllowNameMatching` 会重新启用可变名称/tag 匹配（破窗兼容模式）。 -- `channels.discord.execApprovals`：Discord 原生 exec 审批投递与审批人授权。 - - `enabled`：`true`、`false` 或 `"auto"`（默认）。在自动模式下，当能从 `approvers` 或 `commands.ownerAllowFrom` 解析出审批人时，会激活 exec 审批。 +- `channels.discord.voice.daveEncryption` 和 `channels.discord.voice.decryptionFailureTolerance` 会直接透传给 `@discordjs/voice` 的 DAVE 选项（默认分别为 `true` 和 `24`）。 +- OpenClaw 在重复解密失败后还会尝试通过离开/重新加入语音会话来恢复语音接收。 +- `channels.discord.streaming` 是规范的流式模式键。旧版 `streamMode` 和布尔型 `streaming` 值会自动迁移。 +- `channels.discord.autoPresence` 将运行时可用性映射为机器人在线状态（healthy => online，degraded => idle，exhausted => dnd），并允许可选的状态文本覆盖。 +- `channels.discord.dangerouslyAllowNameMatching` 会重新启用可变名称/标签匹配（紧急兼容模式）。 +- `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"` 时，按钮仅对已解析出的审批人可用。 + - `agentFilter`：可选智能体 ID 允许列表。省略则转发所有智能体的审批。 + - `sessionFilter`：可选会话键模式（子串或正则表达式）。 + - `target`：审批提示发送位置。`"dm"`（默认）发送到审批人私信，`"channel"` 发送到原始频道，`"both"` 两者都发送。当目标包含 `"channel"` 时，按钮仅对已解析出的审批人可用。 - `cleanupAfterResolve`：为 `true` 时，在批准、拒绝或超时后删除审批私信。 -**反应通知模式：** `off`（无）、`own`（机器人的消息，默认）、`all`（所有消息）、`allowlist`（来自 `guilds..users`，作用于所有消息）。 +**反应通知模式：** `off`（无）、`own`（机器人自己的消息，默认）、`all`（所有消息）、`allowlist`（来自 `guilds..users` 的所有消息）。 ### Google Chat @@ -379,11 +379,11 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 } ``` -- 服务账号 JSON：支持内联（`serviceAccount`）或基于文件（`serviceAccountFile`）。 +- 服务账号 JSON：内联（`serviceAccount`）或基于文件（`serviceAccountFile`）。 - 也支持服务账号 SecretRef（`serviceAccountRef`）。 - 环境变量回退：`GOOGLE_CHAT_SERVICE_ACCOUNT` 或 `GOOGLE_CHAT_SERVICE_ACCOUNT_FILE`。 -- 使用 `spaces/` 或 `users/` 作为投递目标。 -- `channels.googlechat.dangerouslyAllowNameMatching` 会重新启用可变邮箱主体匹配（破窗兼容模式）。 +- 传递目标请使用 `spaces/` 或 `users/`。 +- `channels.googlechat.dangerouslyAllowNameMatching` 会重新启用可变电子邮件主体匹配（紧急兼容模式）。 ### Slack @@ -405,14 +405,14 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。存在已 allowBots: false, users: ["U123"], skills: ["docs"], - systemPrompt: "只给出简短回答。", + systemPrompt: "Short answers only.", }, }, historyLimit: 50, allowBots: false, reactionNotifications: "own", reactionAllowlist: ["U123"], - replyToMode: "off", // off | first | all + replyToMode: "off", // off | first | all | batched thread: { historyScope: "thread", // thread | channel inheritParent: false, @@ -448,33 +448,33 @@ 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 配置，但当前命令/运行时路径无法解析密钥值。 +- **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 值。 - `configWrites: false` 会阻止由 Slack 发起的配置写入。 -- 可选的 `channels.slack.defaultAccount` 会在其匹配已配置账号 ID 时覆盖默认账号选择。 -- `channels.slack.streaming` 是规范的流模式键。旧版 `streamMode` 和布尔型 `streaming` 值会自动迁移。 -- 使用 `user:`（私信）或 `channel:` 作为投递目标。 +- 可选的 `channels.slack.defaultAccount` 可在其匹配某个已配置账号 ID 时覆盖默认账号选择。 +- `channels.slack.streaming` 是规范的流式模式键。旧版 `streamMode` 和布尔型 `streaming` 值会自动迁移。 +- 传递目标请使用 `user:`（私信）或 `channel:`。 **反应通知模式：** `off`、`own`（默认）、`all`、`allowlist`（来自 `reactionAllowlist`）。 -**线程会话隔离：** `thread.historyScope` 可设为按线程（默认）或跨频道共享。`thread.inheritParent` 会将父频道转录复制到新线程中。 +**线程会话隔离：** `thread.historyScope` 为每线程（默认）或跨频道共享。`thread.inheritParent` 会将父频道的转录复制到新线程。 -- `typingReaction` 会在回复运行期间为入站 Slack 消息添加一个临时反应，并在完成后移除。使用 Slack emoji 简码，例如 `"hourglass_flowing_sand"`。 -- `channels.slack.execApprovals`：Slack 原生 exec 审批投递与审批人授权。其 schema 与 Discord 相同：`enabled`（`true`/`false`/`"auto"`）、`approvers`（Slack 用户 ID）、`agentFilter`、`sessionFilter` 和 `target`（`"dm"`、`"channel"` 或 `"both"`）。 +- `typingReaction` 会在回复运行期间向传入的 Slack 消息添加临时反应，并在完成后移除。请使用 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"`）。 -| 操作组 | 默认值 | 说明 | -| ------------ | ------- | --------------------- | -| reactions | 启用 | 添加反应并列出反应 | -| messages | 启用 | 读取/发送/编辑/删除 | -| pins | 启用 | 固定/取消固定/列出 | -| memberInfo | 启用 | 成员信息 | -| emojiList | 启用 | 自定义 emoji 列表 | +| 动作组 | 默认值 | 说明 | +| ------------ | ------- | ---------------------- | +| reactions | 启用 | 反应 + 列出反应 | +| messages | 启用 | 读取/发送/编辑/删除 | +| pins | 启用 | 置顶/取消置顶/列出 | +| memberInfo | 启用 | 成员信息 | +| emojiList | 启用 | 自定义 emoji 列表 | ### Mattermost -Mattermost 作为插件提供：`openclaw plugins install @openclaw/mattermost`。 +Mattermost 以插件形式提供：`openclaw plugins install @openclaw/mattermost`。 ```json5 { @@ -491,10 +491,10 @@ Mattermost 作为插件提供：`openclaw plugins install @openclaw/mattermost` "team-channel-id": { requireMention: false }, }, commands: { - native: true, // 选择性启用 + native: true, // 选择启用 nativeSkills: true, callbackPath: "/api/channels/mattermost/command", - // 反向代理/公共部署时可选的显式 URL + // 面向反向代理/公共部署的可选显式 URL callbackUrl: "https://gateway.example.com/api/channels/mattermost/command", }, textChunkLimit: 4000, @@ -504,19 +504,18 @@ Mattermost 作为插件提供：`openclaw plugins install @openclaw/mattermost` } ``` -聊天模式：`oncall`（在 @ 提及时响应，默认）、`onmessage`（每条消息都响应）、`onchar`（响应以触发前缀开头的消息）。 +聊天模式：`oncall`（在 @ 提及时响应，默认）、`onmessage`（每条消息都响应）、`onchar`（以触发前缀开头的消息）。 -当启用 Mattermost 原生命令时： +启用 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 服务器必须能访问。 +- 原生斜杠命令回调使用 Mattermost 在斜杠命令注册期间返回的每命令 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.groups..requireMention`：每频道提及门控覆盖（`"*"` 表示默认值）。 +- 可选的 `channels.mattermost.defaultAccount` 可在其匹配某个已配置账号 ID 时覆盖默认账号选择。 ### Signal @@ -539,13 +538,13 @@ Mattermost 作为插件提供：`openclaw plugins install @openclaw/mattermost` **反应通知模式：** `off`、`own`（默认）、`all`、`allowlist`（来自 `reactionAllowlist`）。 -- `channels.signal.account`：将渠道启动固定到特定 Signal 账号身份。 +- `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 { @@ -561,13 +560,13 @@ BlueBubbles 是推荐的 iMessage 路径（插件支持，在 `channels.bluebubb ``` - 此处涵盖的核心键路径：`channels.bluebubbles`、`channels.bluebubbles.dmPolicy`。 -- 可选的 `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)。 +- 可选的 `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）。不需要守护进程或端口。 ```json5 { @@ -591,15 +590,15 @@ OpenClaw 会启动 `imsg rpc`（通过 stdio 的 JSON-RPC）。无需守护进 } ``` -- 可选的 `channels.imessage.defaultAccount` 会在其匹配已配置账号 ID 时覆盖默认账号选择。 +- 可选的 `channels.imessage.defaultAccount` 可在其匹配某个已配置账号 ID 时覆盖默认账号选择。 -- 需要对 Messages 数据库授予“完全磁盘访问”权限。 +- 需要对 Messages 数据库授予 Full Disk Access。 - 优先使用 `chat_id:` 目标。可用 `imsg chats --limit 20` 列出聊天。 -- `cliPath` 可以指向 SSH 包装器；设置 `remoteHost`（`host` 或 `user@host`）以便使用 SCP 获取附件。 -- `attachmentRoots` 和 `remoteAttachmentRoots` 会限制入站附件路径（默认：`/Users/*/Library/Messages/Attachments`）。 -- SCP 使用严格主机密钥检查，因此请确保中继主机密钥已存在于 `~/.ssh/known_hosts`。 +- `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)。 @@ -612,7 +611,7 @@ exec ssh -T gateway-host imsg "$@" ### Matrix -Matrix 由扩展提供支持，配置在 `channels.matrix` 下。 +Matrix 由扩展支持，配置位于 `channels.matrix` 下。 ```json5 { @@ -643,23 +642,23 @@ Matrix 由扩展提供支持，配置在 `channels.matrix` 下。 ``` - Token 认证使用 `accessToken`；密码认证使用 `userId` + `password`。 -- `channels.matrix.proxy` 通过显式 HTTP(S) 代理路由 Matrix HTTP 流量。命名账号可通过 `channels.matrix.accounts..proxy` 覆盖它。 -- `channels.matrix.allowPrivateNetwork` 允许私有/内部 homeserver。`proxy` 和 `allowPrivateNetwork` 是相互独立的控制项。 +- `channels.matrix.proxy` 会通过显式 HTTP(S) 代理转发 Matrix HTTP 流量。命名账号可通过 `channels.matrix.accounts..proxy` 覆盖。 +- `channels.matrix.allowPrivateNetwork` 允许私有/内部 homeserver。`proxy` 与 `allowPrivateNetwork` 是相互独立的控制项。 - `channels.matrix.defaultAccount` 在多账号设置中选择首选账号。 -- `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.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.dm.sessionScope` 控制 Matrix 私信如何聚合到会话中：`per-user`（默认）按路由对等方共享，`per-room` 则隔离每个私信房间。 +- Matrix 状态探测和实时目录查找使用与运行时流量相同的代理策略。 +- 完整 Matrix 配置、目标规则和设置示例请参见 [Matrix](/zh-CN/channels/matrix)。 ### Microsoft Teams -Microsoft Teams 由扩展提供支持，配置在 `channels.msteams` 下。 +Microsoft Teams 由扩展支持，配置位于 `channels.msteams` 下。 ```json5 { @@ -675,11 +674,11 @@ 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 -IRC 由扩展提供支持，配置在 `channels.irc` 下。 +IRC 由扩展支持，配置位于 `channels.irc` 下。 ```json5 { @@ -701,12 +700,12 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ``` - 此处涵盖的核心键路径：`channels.irc`、`channels.irc.dmPolicy`、`channels.irc.configWrites`、`channels.irc.nickserv.*`。 -- 可选的 `channels.irc.defaultAccount` 会在其匹配已配置账号 ID 时覆盖默认账号选择。 -- 完整的 IRC 渠道配置（主机/端口/TLS/频道/允许列表/提及门控）请参见 [IRC](/zh-CN/channels/irc)。 +- 可选的 `channels.irc.defaultAccount` 可在其匹配某个已配置账号 ID 时覆盖默认账号选择。 +- 完整 IRC 渠道配置（host/port/TLS/channels/allowlists/提及门控）请参见 [IRC](/zh-CN/channels/irc)。 ### 多账号（所有渠道） -为每个渠道运行多个账号（每个账号都有自己的 `accountId`）： +每个渠道可运行多个账号（每个都有自己的 `accountId`）： ```json5 { @@ -714,11 +713,11 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 telegram: { accounts: { default: { - name: "主 Bot", + name: "Primary bot", botToken: "123456:ABC...", }, alerts: { - name: "告警 Bot", + name: "Alerts bot", botToken: "987654:XYZ...", }, }, @@ -727,18 +726,18 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 } ``` -- 当省略 `accountId` 时会使用 `default`（CLI + 路由）。 -- 环境变量 token 只适用于 **default** 账号。 -- 基础渠道设置会应用到所有账号，除非被按账号覆盖。 +- 省略 `accountId` 时使用 `default`（CLI + 路由）。 +- 环境变量 token 仅适用于 **default** 账号。 +- 基础渠道设置适用于所有账号，除非被每账号设置覆盖。 - 使用 `bindings[].match.accountId` 将每个账号路由到不同智能体。 -- 如果你通过 `openclaw channels add`（或渠道新手引导）添加了非默认账号，而此时仍是单账号顶层渠道配置，OpenClaw 会先将按账号范围的顶层单账号值提升到渠道账号映射中，以确保原账号继续工作。大多数渠道会移动到 `channels..accounts.default`；Matrix 则可以保留现有的匹配命名/默认目标。 -- 现有的纯渠道绑定（无 `accountId`）将继续匹配默认账号；按账号范围的绑定仍然是可选的。 -- `openclaw doctor --fix` 也会修复混合形态：它会将按账号范围的顶层单账号值移动到该渠道选定的提升后账号中。大多数渠道使用 `accounts.default`；Matrix 可以保留现有的匹配命名/默认目标。 +- 如果你在仍为单账号顶层渠道配置的情况下通过 `openclaw channels add`（或渠道新手引导）添加了一个非默认账号，OpenClaw 会先将带账号作用域的顶层单账号值提升到渠道账号映射中，以保证原账号继续可用。大多数渠道会将其移动到 `channels..accounts.default`；Matrix 则可以保留现有匹配的命名/default 目标。 +- 现有仅渠道绑定（无 `accountId`）会继续匹配默认账号；账号作用域绑定仍然是可选的。 +- `openclaw doctor --fix` 也会修复混合形态：将带账号作用域的顶层单账号值移动到为该渠道选择的提升账号中。大多数渠道使用 `accounts.default`；Matrix 则可以保留现有匹配的命名/default 目标。 ### 其他扩展渠道 -许多扩展渠道都配置为 `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)。 ### 群聊提及门控 @@ -746,9 +745,9 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 **提及类型：** -- **元数据提及**：平台原生 @ 提及。在 WhatsApp 自聊模式下会被忽略。 +- **元数据提及**：平台原生 @ 提及。在 WhatsApp self-chat 模式下会被忽略。 - **文本模式**：位于 `agents.list[].groupChat.mentionPatterns` 中的安全正则模式。无效模式和不安全的嵌套重复会被忽略。 -- 仅在可检测时（原生提及或至少存在一个模式）才会强制执行提及门控。 +- 仅在可检测时（原生提及或至少一个模式）才会强制执行提及门控。 ```json5 { @@ -761,7 +760,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 } ``` -`messages.groupChat.historyLimit` 设置全局默认值。渠道可通过 `channels..historyLimit`（或按账号）覆盖。设为 `0` 可禁用。 +`messages.groupChat.historyLimit` 设置全局默认值。渠道可通过 `channels..historyLimit`（或每账号设置）覆盖。设为 `0` 可禁用。 #### 私信历史限制 @@ -778,13 +777,13 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 } ``` -解析顺序：按私信覆盖 → 提供商默认值 → 无限制（全部保留）。 +解析顺序：每私信覆盖 → provider 默认值 → 不限制（全部保留）。 支持：`telegram`、`whatsapp`、`discord`、`slack`、`signal`、`imessage`、`msteams`。 -#### 自聊模式 +#### self-chat 模式 -将你自己的号码包含在 `allowFrom` 中即可启用自聊模式（忽略原生 @ 提及，只响应文本模式）： +将你自己的号码包含在 `allowFrom` 中以启用 self-chat 模式（忽略原生 @ 提及，仅响应文本模式）： ```json5 { @@ -805,7 +804,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 } ``` -### Commands（聊天命令处理） +### 命令（聊天命令处理） ```json5 { @@ -816,7 +815,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 bashForegroundMs: 2000, config: false, // 允许 /config debug: false, // 允许 /debug - restart: false, // 允许 /restart + Gateway 网关重启工具 + restart: false, // 允许 /restart + gateway restart 工具 allowFrom: { "*": ["user1"], discord: ["user:123"], @@ -828,16 +827,16 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 -- 文本命令必须是带前导 `/` 的**独立**消息。 -- `native: "auto"` 会为 Discord/Telegram 打开原生命令，Slack 则保持关闭。 -- 可按渠道覆盖：`channels.discord.commands.native`（布尔值或 `"auto"`）。`false` 会清除之前已注册的命令。 -- `channels.telegram.customCommands` 会添加额外的 Telegram 机器人菜单项。 -- `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 客户端可用。 -- `channels..configWrites` 控制每个渠道的配置变更（默认：true）。 +- 文本命令必须是带有前导 `/` 的**独立**消息。 +- `native: "auto"` 会为 Discord/Telegram 打开原生命令，但不会为 Slack 打开。 +- 可按渠道覆盖：`channels.discord.commands.native`（布尔值或 `"auto"`）。`false` 会清除先前注册的命令。 +- `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 客户端仍然可用。 +- `channels..configWrites` 控制每个渠道上的配置变更（默认：true）。 - 对于多账号渠道，`channels..accounts..configWrites` 也会控制针对该账号的写入（例如 `/allowlist --config --account ` 或 `/config set channels..accounts....`）。 -- `allowFrom` 是按提供商划分的。设置后，它将成为**唯一**授权来源（渠道允许列表/配对及 `useAccessGroups` 都会被忽略）。 -- `useAccessGroups: false` 允许命令在 `allowFrom` 未设置时绕过访问组策略。 +- `allowFrom` 是按 provider 设置的。一旦设置，它就是**唯一**的授权来源（渠道允许列表/配对以及 `useAccessGroups` 都会被忽略）。 +- 当未设置 `allowFrom` 时，`useAccessGroups: false` 允许命令绕过访问组策略。 @@ -857,7 +856,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ### `agents.defaults.repoRoot` -可选的仓库根目录，会显示在系统提示的 Runtime 行中。未设置时，OpenClaw 会从工作区向上遍历自动检测。 +可选仓库根目录，会显示在系统提示的 Runtime 行中。如果未设置，OpenClaw 会从工作区开始向上遍历自动检测。 ```json5 { @@ -867,7 +866,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ### `agents.defaults.skills` -为未设置 `agents.list[].skills` 的智能体提供可选的默认 Skills 允许列表。 +为未设置 `agents.list[].skills` 的智能体提供可选默认 Skills 允许列表。 ```json5 { @@ -882,14 +881,14 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 } ``` -- 省略 `agents.defaults.skills`，默认表示 Skills 不受限制。 -- 省略 `agents.list[].skills` 表示继承默认值。 -- 设置 `agents.list[].skills: []` 表示不启用任何 Skills。 -- 非空的 `agents.list[].skills` 列表就是该智能体的最终集合；它不会与默认值合并。 +- 省略 `agents.defaults.skills` 可默认不限制 Skills。 +- 省略 `agents.list[].skills` 可继承默认值。 +- 设置 `agents.list[].skills: []` 表示无 Skills。 +- 非空的 `agents.list[].skills` 列表就是该智能体的最终集合；不会与默认值合并。 ### `agents.defaults.skipBootstrap` -禁用自动创建工作区引导文件（`AGENTS.md`、`SOUL.md`、`TOOLS.md`、`IDENTITY.md`、`USER.md`、`HEARTBEAT.md`、`BOOTSTRAP.md`）。 +禁用工作区 bootstrap 文件（`AGENTS.md`、`SOUL.md`、`TOOLS.md`、`IDENTITY.md`、`USER.md`、`HEARTBEAT.md`、`BOOTSTRAP.md`）的自动创建。 ```json5 { @@ -899,7 +898,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ### `agents.defaults.bootstrapMaxChars` -单个工作区引导文件在截断前允许的最大字符数。默认值：`20000`。 +每个工作区 bootstrap 文件在截断前允许的最大字符数。默认值：`20000`。 ```json5 { @@ -909,7 +908,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ### `agents.defaults.bootstrapTotalMaxChars` -所有工作区引导文件注入总字符数上限。默认值：`150000`。 +跨所有工作区 bootstrap 文件注入的总最大字符数。默认值：`150000`。 ```json5 { @@ -919,11 +918,11 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ### `agents.defaults.bootstrapPromptTruncationWarning` -控制在引导上下文被截断时，向智能体显示的警告文本。 +控制 bootstrap 上下文被截断时向智能体显示的警告文本。 默认值：`"once"`。 - `"off"`：绝不在系统提示中注入警告文本。 -- `"once"`：每种唯一截断签名仅注入一次警告（推荐）。 +- `"once"`：每个唯一截断签名仅注入一次警告（推荐）。 - `"always"`：只要存在截断，每次运行都注入警告。 ```json5 @@ -934,11 +933,11 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ### `agents.defaults.imageMaxDimensionPx` -在调用提供商前，转录/工具图像块中图像最长边的最大像素尺寸。 +在调用 provider 之前，转录/工具图像块中图像最长边的最大像素尺寸。 默认值：`1200`。 -更低的值通常能减少视觉 token 用量和请求载荷大小，适合截图较多的运行。 -更高的值能保留更多视觉细节。 +较低的值通常会减少视觉 token 用量和请求负载大小，适合大量截图的运行。 +较高的值可保留更多视觉细节。 ```json5 { @@ -948,7 +947,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ### `agents.defaults.userTimezone` -系统提示上下文使用的时区（不影响消息时间戳）。默认回退到主机时区。 +用于系统提示上下文的时区（不影响消息时间戳）。会回退到主机时区。 ```json5 { @@ -958,7 +957,7 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 ### `agents.defaults.timeFormat` -系统提示中的时间格式。默认值：`auto`（跟随操作系统偏好）。 +系统提示中的时间格式。默认值：`auto`（操作系统偏好）。 ```json5 { @@ -1011,36 +1010,36 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 } ``` -- `model`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 字符串形式只设置主模型。 - - 对象形式设置主模型以及有序故障转移模型。 -- `imageModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 由 `image` 工具路径作为其视觉模型配置使用。 - - 当所选/默认模型不能接受图像输入时，也会用作回退路由。 -- `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）。 - - 如果你直接选择某个 provider/model，也要配置相应的提供商认证/API key（例如 `google/*` 需要 `GEMINI_API_KEY` 或 `GOOGLE_API_KEY`，`openai/*` 需要 `OPENAI_API_KEY`，`fal/*` 需要 `FAL_KEY`）。 - - 如果省略，`image_generate` 仍可推断基于认证的提供商默认值。它会先尝试当前默认提供商，然后按提供商 ID 顺序尝试其余已注册的图像生成提供商。 -- `videoGenerationModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 由共享视频生成能力和内置 `video_generate` 工具使用。 +- `model`：可接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 + - 字符串形式仅设置主模型。 + - 对象形式设置主模型以及按顺序排列的故障转移模型。 +- `imageModel`：可接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 + - 由 `image` 工具路径用作其视觉模型配置。 + - 当所选/默认模型无法接受图像输入时，也会作为回退路由使用。 +- `imageGenerationModel`：可接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 + - 用于共享的图像生成能力，以及未来任何用于生成图像的工具/插件接口。 + - 典型值：原生 Gemini 图像生成使用 `google/gemini-3.1-flash-image-preview`，fal 使用 `fal/fal-ai/flux/dev`，OpenAI Images 使用 `openai/gpt-image-1`。 + - 如果你直接选择 provider/model，也需要配置匹配的 provider 认证/API key（例如 `google/*` 对应 `GEMINI_API_KEY` 或 `GOOGLE_API_KEY`，`openai/*` 对应 `OPENAI_API_KEY`，`fal/*` 对应 `FAL_KEY`）。 + - 如果省略，`image_generate` 仍可推断一个带认证的 provider 默认值。它会先尝试当前默认 provider，然后按 provider-id 顺序尝试其余已注册的图像生成 provider。 +- `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 顺序尝试其余已注册的视频生成提供商。 - - 如果你直接选择某个 provider/model，也要配置相应的提供商认证/API key。 - - 内置的 Qwen 视频生成提供商目前最多支持 1 个输出视频、1 张输入图像、4 个输入视频、10 秒时长，以及提供商级的 `size`、`aspectRatio`、`resolution`、`audio` 和 `watermark` 选项。 -- `pdfModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 由 `pdf` 工具用于模型路由。 + - 如果省略，`video_generate` 仍可推断一个带认证的 provider 默认值。它会先尝试当前默认 provider，然后按 provider-id 顺序尝试其余已注册的视频生成 provider。 + - 如果你直接选择 provider/model，也需要配置匹配的 provider 认证/API key。 + - 内置的 Qwen 视频生成 provider 当前最多支持 1 个输出视频、1 张输入图像、4 个输入视频、10 秒时长，以及 provider 级别的 `size`、`aspectRatio`、`resolution`、`audio` 和 `watermark` 选项。 +- `pdfModel`：可接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 + - 用于 `pdf` 工具的模型路由。 - 如果省略，PDF 工具会回退到 `imageModel`，再回退到已解析的会话/默认模型。 -- `pdfMaxBytesMb`：当调用时未传 `maxBytesMb` 时，`pdf` 工具的默认 PDF 大小限制。 +- `pdfMaxBytesMb`：当调用时未传入 `maxBytesMb`，`pdf` 工具使用的默认 PDF 大小限制。 - `pdfMaxPages`：`pdf` 工具在提取回退模式下考虑的默认最大页数。 -- `verboseDefault`：智能体的默认 verbose 级别。取值：`"off"`、`"on"`、`"full"`。默认：`"off"`。 -- `elevatedDefault`：智能体的默认 elevated-output 级别。取值：`"off"`、`"on"`、`"ask"`、`"full"`。默认：`"on"`。 -- `model.primary`：格式为 `provider/model`（例如 `openai/gpt-5.4`）。如果省略 provider，OpenClaw 会先尝试别名，然后尝试与该确切模型 ID 唯一匹配的已配置 provider，最后才回退到已配置的默认 provider（已弃用的兼容行为，因此建议使用显式 `provider/model`）。如果该 provider 不再暴露已配置的默认模型，OpenClaw 会回退到第一个已配置 provider/model，而不是暴露一个过时的已删除 provider 默认值。 -- `models`：已配置的模型目录以及 `/model` 的允许列表。每个条目都可以包含 `alias`（快捷方式）和 `params`（provider 特定参数，例如 `temperature`、`maxTokens`、`cacheRetention`、`context1m`）。 -- `params`：应用于所有模型的全局默认 provider 参数。设置在 `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)。 -- 会修改这些字段的配置写入器（例如 `/models set`、`/models set-image` 和回退添加/删除命令）会保存为规范对象形式，并尽可能保留现有回退列表。 -- `maxConcurrent`：跨会话的智能体最大并行运行数（每个会话仍会串行化）。默认值：4。 +- `verboseDefault`：智能体的默认 verbose 级别。取值：`"off"`、`"on"`、`"full"`。默认值：`"off"`。 +- `elevatedDefault`：智能体的默认 elevated-output 级别。取值：`"off"`、`"on"`、`"ask"`、`"full"`。默认值：`"on"`。 +- `model.primary`：格式为 `provider/model`（例如 `openai/gpt-5.4`）。如果省略 provider，OpenClaw 会先尝试别名，然后尝试某个已配置 provider 中唯一精确匹配该模型 ID 的项，最后才回退到已配置默认 provider（此兼容行为已弃用，因此推荐使用显式 `provider/model`）。如果该 provider 不再暴露已配置的默认模型，OpenClaw 会回退到第一个已配置的 provider/model，而不是暴露一个过时的、已移除 provider 的默认项。 +- `models`：为 `/model` 配置的模型目录和允许列表。每个条目可以包含 `alias`（快捷方式）和 `params`（provider 专用，例如 `temperature`、`maxTokens`、`cacheRetention`、`context1m`）。 +- `params`：适用于所有模型的全局默认 provider 参数。设置位置为 `agents.defaults.params`（例如 `{ cacheRetention: "long" }`）。 +- `params` 合并优先级（配置）：`agents.defaults.params`（全局基础）会被 `agents.defaults.models["provider/model"].params`（每模型）覆盖，然后 `agents.list[].params`（匹配 agent id）会按键覆盖。详见 [Prompt Caching](/zh-CN/reference/prompt-caching)。 +- 会修改这些字段的配置写入器（例如 `/models set`、`/models set-image` 和回退 add/remove 命令）会保存规范对象形式，并尽可能保留现有回退列表。 +- `maxConcurrent`：跨会话的最大并行智能体运行数（每个会话本身仍串行）。默认值：4。 **内置别名简写**（仅当模型位于 `agents.defaults.models` 中时适用）： @@ -1055,14 +1054,14 @@ IRC 由扩展提供支持，配置在 `channels.irc` 下。 | `gemini-flash` | `google/gemini-3-flash-preview` | | `gemini-flash-lite` | `google/gemini-3.1-flash-lite-preview` | -你自己配置的别名始终优先于默认值。 +你配置的别名始终优先于默认值。 -Z.AI GLM-4.x 模型会自动启用 thinking 模式，除非你设置 `--thinking off` 或自行定义 `agents.defaults.models["zai/"].params.thinking`。 +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。 +Anthropic Claude 4.6 模型在未显式设置 thinking 级别时，默认使用 `adaptive` thinking。 - 设置了 `sessionArg` 时支持会话。 -- 当 `imageArg` 接受文件路径时支持图像透传。 +- 当 `imageArg` 接受文件路径时支持图像直通。 ### `agents.defaults.heartbeat` @@ -1073,11 +1072,11 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad agents: { defaults: { heartbeat: { - every: "30m", // 0m 表示禁用 + every: "30m", // 0m 禁用 model: "openai/gpt-5.4-mini", includeReasoning: false, - lightContext: false, // 默认：false；true 时仅保留工作区引导文件中的 HEARTBEAT.md - isolatedSession: false, // 默认：false；true 时每次心跳都在全新会话中运行（无历史对话） + lightContext: false, // 默认：false；true 时仅从工作区 bootstrap 文件中保留 HEARTBEAT.md + isolatedSession: false, // 默认：false；true 时每次心跳都在全新会话中运行（无对话历史） session: "main", to: "+15555550123", directPolicy: "allow", // allow（默认）| block @@ -1091,13 +1090,13 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad } ``` -- `every`：时长字符串（ms/s/m/h）。默认值：`30m`（API-key 认证）或 `1h`（OAuth 认证）。设置为 `0m` 可禁用。 -- `suppressToolErrorWarnings`：为 true 时，在心跳运行中抑制工具错误警告载荷。 -- `directPolicy`：直接/私信投递策略。`allow`（默认）允许直接目标投递。`block` 会抑制直接目标投递并发出 `reason=dm-blocked`。 -- `lightContext`：为 true 时，心跳运行使用轻量级引导上下文，并只保留工作区引导文件中的 `HEARTBEAT.md`。 -- `isolatedSession`：为 true 时，每次心跳都在没有历史对话的全新会话中运行。与 cron 的 `sessionTarget: "isolated"` 使用相同隔离模式。可将每次心跳的 token 成本从约 100K 降低到约 2-5K。 -- 每智能体：设置 `agents.list[].heartbeat`。当任意智能体定义了 `heartbeat` 时，**只有这些智能体**会运行心跳。 -- 心跳会运行完整的智能体轮次——间隔越短，消耗的 token 越多。 +- `every`：时长字符串（ms/s/m/h）。默认值：`30m`（API-key 认证）或 `1h`（OAuth 认证）。设为 `0m` 可禁用。 +- `suppressToolErrorWarnings`：为 true 时，在心跳运行期间抑制工具错误警告负载。 +- `directPolicy`：直接/私信投递策略。`allow`（默认）允许直接目标投递。`block` 会抑制直接目标投递，并发出 `reason=dm-blocked`。 +- `lightContext`：为 true 时，心跳运行使用轻量 bootstrap 上下文，并且只保留工作区 bootstrap 文件中的 `HEARTBEAT.md`。 +- `isolatedSession`：为 true 时，每次心跳运行都会在一个没有任何先前对话历史的全新会话中执行。与 cron 的 `sessionTarget: "isolated"` 使用相同的隔离模式。可将每次心跳的 token 成本从约 100K 降到约 2-5K。 +- 每智能体：设置 `agents.list[].heartbeat`。当任一智能体定义了 `heartbeat` 时，**只有这些智能体**会运行心跳。 +- 心跳会运行完整的智能体轮次——更短的间隔会消耗更多 token。 ### `agents.defaults.compaction` @@ -1110,10 +1109,10 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad timeoutSeconds: 900, reserveTokensFloor: 24000, identifierPolicy: "strict", // strict | off | 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） + 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） memoryFlush: { enabled: true, softThresholdTokens: 6000, @@ -1126,18 +1125,18 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad } ``` -- `mode`：`default` 或 `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 开始时向用户发送简短通知（例如 “Compacting context...”）。默认禁用，以保持 compaction 静默。 -- `memoryFlush`：在自动 compaction 前进行的静默智能体轮次，用于存储持久记忆。工作区为只读时会跳过。 +- `mode`：`default` 或 `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 开始时向用户发送简短通知（例如“Compacting context...”）。默认禁用，以保持 compaction 静默。 +- `memoryFlush`：在自动 compaction 之前执行的静默智能体轮次，用于存储持久记忆。工作区为只读时会跳过。 ### `agents.defaults.contextPruning` -在发送给 LLM 前，从内存上下文中裁剪**旧的工具结果**。**不会**修改磁盘上的会话历史。 +在发送给 LLM 之前，从内存上下文中修剪**旧工具结果**。**不会**修改磁盘上的会话历史。 ```json5 { @@ -1161,23 +1160,23 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad -- `mode: "cache-ttl"` 启用裁剪流程。 -- `ttl` 控制多长时间后才允许再次运行裁剪（以上次缓存触碰为起点）。 -- 裁剪会先对过大的工具结果进行软裁剪，然后在需要时硬清除更旧的工具结果。 +- `mode: "cache-ttl"` 启用修剪流程。 +- `ttl` 控制何时允许再次运行修剪（自上次缓存触碰后）。 +- 修剪会先对过大的工具结果执行软裁剪，如仍有需要，再对更旧的工具结果执行硬清除。 -**软裁剪** 会保留开头和结尾，并在中间插入 `...`。 +**软裁剪**会保留开头和结尾，并在中间插入 `...`。 -**硬清除** 会用占位符替换整个工具结果。 +**硬清除**会用占位文本替换整个工具结果。 -注意： +说明： - 图像块永远不会被裁剪/清除。 - 比例基于字符数（近似），不是精确 token 数。 -- 如果 assistant 消息少于 `keepLastAssistants` 条，则会跳过裁剪。 +- 如果 assistant 消息少于 `keepLastAssistants`，则跳过修剪。 -行为细节参见 [Session Pruning](/zh-CN/concepts/session-pruning)。 +行为详情请参见 [Session Pruning](/zh-CN/concepts/session-pruning)。 ### 分块流式传输 @@ -1195,13 +1194,13 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad } ``` -- 非 Telegram 渠道需要显式设置 `*.blockStreaming: true` 才会启用分块回复。 -- 渠道覆盖：`channels..blockStreamingCoalesce`（及按账号变体）。Signal/Slack/Discord/Google Chat 默认 `minChars: 1500`。 -- `humanDelay`：分块回复之间的随机停顿。`natural` = 800–2500ms。每智能体覆盖：`agents.list[].humanDelay`。 +- 非 Telegram 渠道需要显式设置 `*.blockStreaming: true` 才能启用分块回复。 +- 渠道覆盖：`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 { @@ -1214,7 +1213,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad } ``` -- 默认值：私聊/被提及时使用 `instant`，未被提及的群聊使用 `message`。 +- 默认值：私聊/被提及时为 `instant`，未被提及的群组聊天为 `message`。 - 每会话覆盖：`session.typingMode`、`session.typingIntervalSeconds`。 参见 [Typing Indicators](/zh-CN/concepts/typing-indicators)。 @@ -1223,7 +1222,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad ### `agents.defaults.sandbox` -嵌入式智能体的可选沙箱隔离。完整指南参见 [Sandboxing](/zh-CN/gateway/sandboxing)。 +为嵌入式智能体启用可选沙箱隔离。完整指南请参见 [Sandboxing](/zh-CN/gateway/sandboxing)。 ```json5 { @@ -1269,7 +1268,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad identityFile: "~/.ssh/id_ed25519", certificateFile: "~/.ssh/id_ed25519-cert.pub", knownHostsFile: "~/.ssh/known_hosts", - // 也支持 SecretRef / 内联内容： + // 也支持 SecretRefs / 内联内容： // identityData: { source: "env", provider: "default", id: "SSH_IDENTITY" }, // certificateData: { source: "env", provider: "default", id: "SSH_CERTIFICATE" }, // knownHostsData: { source: "env", provider: "default", id: "SSH_KNOWN_HOSTS" }, @@ -1323,19 +1322,19 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad **后端：** - `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`：用于按 scope 划分工作区的远程绝对根目录 +- `workspaceRoot`：用于按作用域划分工作区的远程绝对根路径 - `identityFile` / `certificateFile` / `knownHostsFile`：传递给 OpenSSH 的现有本地文件 -- `identityData` / `certificateData` / `knownHostsData`：内联内容或 SecretRef，OpenClaw 会在运行时将其实体化为临时文件 +- `identityData` / `certificateData` / `knownHostsData`：OpenClaw 在运行时物化为临时文件的内联内容或 SecretRef - `strictHostKeyChecking` / `updateHostKeys`：OpenSSH 主机密钥策略开关 **SSH 认证优先级：** @@ -1343,20 +1342,20 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad - `identityData` 优先于 `identityFile` - `certificateData` 优先于 `certificateFile` - `knownHostsData` 优先于 `knownHostsFile` -- 由 SecretRef 支持的 `*Data` 值会在沙箱会话开始前从活动 secrets 运行时快照中解析 +- 基于 SecretRef 的 `*Data` 值会在沙箱会话启动前从活动 secrets 运行时快照中解析 **SSH 后端行为：** -- 创建或重建后，会为远程工作区执行一次初始播种 -- 然后保持远程 SSH 工作区为规范副本 +- 创建或重建后仅在首次为远程工作区植入内容 +- 之后保持远程 SSH 工作区为规范副本 - 通过 SSH 路由 `exec`、文件工具和媒体路径 -- 不会自动将远程变更同步回主机 +- 不会自动将远程更改同步回主机 - 不支持沙箱浏览器容器 **工作区访问：** -- `none`：位于 `~/.openclaw/sandboxes` 下、按 scope 划分的沙箱工作区 -- `ro`：沙箱工作区位于 `/workspace`，智能体工作区以只读方式挂载到 `/agent` +- `none`：在 `~/.openclaw/sandboxes` 下创建按作用域划分的沙箱工作区 +- `ro`：沙箱工作区位于 `/workspace`，智能体工作区只读挂载到 `/agent` - `rw`：智能体工作区以读写方式挂载到 `/workspace` **作用域：** @@ -1380,7 +1379,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad remoteAgentWorkspaceDir: "/agent", gateway: "lab", // 可选 gatewayEndpoint: "https://lab.example", // 可选 - policy: "strict", // 可选 OpenShell 策略 ID + policy: "strict", // 可选 OpenShell policy id providers: ["openai"], // 可选 autoProviders: true, timeoutSeconds: 120, @@ -1393,30 +1392,30 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时默认使用 `ad **OpenShell 模式：** -- `mirror`：执行前从本地播种到远端，执行后同步回本地；本地工作区保持为规范副本 -- `remote`：创建沙箱时只向远端播种一次，然后保持远程工作区为规范副本 +- `mirror`：在 exec 前从本地植入到远程，exec 后同步回来；本地工作区保持为规范副本 +- `remote`：在创建沙箱时仅向远程植入一次，之后保持远程工作区为规范副本 -在 `remote` 模式下，在播种步骤之后，于 OpenClaw 外部对主机本地所做的编辑不会自动同步进沙箱。 -传输使用 SSH 连接到 OpenShell 沙箱，但插件负责沙箱生命周期以及可选的 mirror 同步。 +在 `remote` 模式下，OpenClaw 外部对主机本地所做的编辑在植入步骤之后不会自动同步到沙箱中。 +传输使用通过 SSH 连接到 OpenShell 沙箱，但插件负责沙箱生命周期和可选的镜像同步。 -**`setupCommand`** 在容器创建后运行一次（通过 `sh -lc`）。需要网络出口、可写根文件系统和 root 用户。 +**`setupCommand`** 会在容器创建后运行一次（通过 `sh -lc`）。需要网络出口、可写根文件系统和 root 用户。 **容器默认使用 `network: "none"`**——如果智能体需要出站访问，请设置为 `"bridge"`（或自定义 bridge 网络）。 -默认会阻止 `"host"`。默认也会阻止 `"container:"`，除非你显式设置 -`sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true`（破窗模式）。 +默认情况下会阻止 `"host"`。默认也会阻止 `"container:"`，除非你显式设置 +`sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true`（紧急开关）。 -**入站附件** 会暂存到活动工作区中的 `media/inbound/*`。 +**传入附件** 会暂存到活动工作区中的 `media/inbound/*`。 -**`docker.binds`** 会挂载额外的主机目录；全局和按智能体的 binds 会合并。 +**`docker.binds`** 可挂载额外的主机目录；全局和每智能体的 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` 中，并针对容器主机进行了调优： +- `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` @@ -1434,15 +1433,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。 @@ -1455,7 +1450,7 @@ scripts/sandbox-setup.sh # 主沙箱镜像 scripts/sandbox-browser-setup.sh # 可选浏览器镜像 ``` -### `agents.list`（按智能体覆盖） +### `agents.list`（每智能体覆盖） ```json5 { @@ -1464,15 +1459,15 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 { id: "main", default: true, - name: "主智能体", + name: "Main Agent", 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 - params: { cacheRetention: "none" }, // 按键覆盖匹配 defaults.models 的参数 - skills: ["docs-search"], // 设置时会替换 agents.defaults.skills + thinkingDefault: "high", // 每智能体 thinking 级别覆盖 + reasoningDefault: "on", // 每智能体 reasoning 可见性覆盖 + fastModeDefault: false, // 每智能体 fast mode 覆盖 + params: { cacheRetention: "none" }, // 按键覆盖匹配 defaults.models params + skills: ["docs-search"], // 设置后替换 agents.defaults.skills identity: { name: "Samantha", theme: "helpful sloth", @@ -1503,26 +1498,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 允许列表。若省略，智能体会在 `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 覆盖时生效。 -- `runtime`：可选的按智能体运行时描述符。当智能体应默认使用 ACP harness 会话时，使用 `type: "acp"` 配合 `runtime.acp` 默认值（`agent`、`backend`、`mode`、`cwd`）。 -- `identity.avatar`：相对于工作区的路径、`http(s)` URL 或 `data:` URI。 +- `id`：稳定的智能体 ID（必填）。 +- `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 覆盖时生效。 +- `runtime`：可选的每智能体运行时描述符。当智能体应默认使用 ACP harness 会话时，使用 `type: "acp"` 和 `runtime.acp` 默认值（`agent`、`backend`、`mode`、`cwd`）。 +- `identity.avatar`：工作区相对路径、`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 { @@ -1541,27 +1536,27 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 ### 绑定匹配字段 -- `type`（可选）：普通路由使用 `route`（缺失时默认为 route），持久 ACP 会话绑定使用 `acp`。 -- `match.channel`（必需） +- `type`（可选）：普通路由使用 `route`（缺失时默认为 route），持久 ACP 对话绑定使用 `acp` +- `match.channel`（必填） - `match.accountId`（可选；`*` = 任意账号；省略 = 默认账号） - `match.peer`（可选；`{ kind: direct|group|channel, id }`） -- `match.guildId` / `match.teamId`（可选；渠道特定） -- `acp`（可选；仅对 `type: "acp"` 生效）：`{ mode, label, cwd, backend }` +- `match.guildId` / `match.teamId`（可选；渠道专用） +- `acp`（可选；仅适用于 `type: "acp"`）：`{ mode, label, cwd, backend }` **确定性匹配顺序：** 1. `match.peer` 2. `match.guildId` 3. `match.teamId` -4. `match.accountId`（精确匹配，无 peer/guild/team） -5. `match.accountId: "*"`（全渠道） +4. `match.accountId`（精确，无 peer/guild/team） +5. `match.accountId: "*"`（渠道级） 6. 默认智能体 -在每一层内，第一条匹配的 `bindings` 会生效。 +在每一层中，首个匹配的 `bindings` 条目获胜。 -对于 `type: "acp"` 条目，OpenClaw 会按精确会话身份（`match.channel` + account + `match.peer.id`）解析，不使用上述 route 绑定分层顺序。 +对于 `type: "acp"` 条目，OpenClaw 会按精确对话身份（`match.channel` + account + `match.peer.id`）解析，不使用上面的 route 绑定层级顺序。 -### 按智能体的访问配置 +### 每智能体访问配置 @@ -1656,7 +1651,7 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 -优先级细节参见 [Multi-Agent 沙箱隔离与工具](/zh-CN/tools/multi-agent-sandbox-tools)。 +优先级细节请参见 [Multi-Agent Sandbox & Tools](/zh-CN/tools/multi-agent-sandbox-tools)。 --- @@ -1682,7 +1677,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", @@ -1694,10 +1689,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" } }], @@ -1710,34 +1705,34 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 - **`scope`**：群聊上下文的基础会话分组策略。 - - `per-sender`（默认）：在某个渠道上下文中，每个发送者都有独立会话。 - - `global`：渠道上下文中的所有参与者共享一个会话（仅当确实需要共享上下文时使用）。 + - `per-sender`（默认）：在渠道上下文中，每个发送者使用独立会话。 + - `global`：渠道上下文中的所有参与者共享单一会话（仅在确实需要共享上下文时使用）。 - **`dmScope`**：私信的分组方式。 - `main`：所有私信共享主会话。 - - `per-peer`：按跨渠道的发送者 ID 隔离。 + - `per-peer`：按跨渠道发送者 ID 隔离。 - `per-channel-peer`：按渠道 + 发送者隔离（推荐用于多用户收件箱）。 - `per-account-channel-peer`：按账号 + 渠道 + 发送者隔离（推荐用于多账号）。 -- **`identityLinks`**：将规范 ID 映射到带 provider 前缀的 peer，用于跨渠道共享会话。 -- **`reset`**：主重置策略。`daily` 会在本地时间 `atHour` 重置；`idle` 会在 `idleMinutes` 后重置。当两者都配置时，以先到期者为准。 -- **`resetByType`**：按类型覆盖（`direct`、`group`、`thread`）。旧版 `dm` 仍接受为 `direct` 的别名。 -- **`parentForkMaxTokens`**：创建分叉线程会话时，允许的父会话 `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 生效。 -- **`maintenance`**：会话存储清理与保留控制。 - - `mode`：`warn` 仅发出警告；`enforce` 会执行清理。 - - `pruneAfter`：过期条目的年龄阈值（默认 `30d`）。 +- **`identityLinks`**：将规范 ID 映射到带 provider 前缀的对等方，以用于跨渠道共享会话。 +- **`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 生效。 +- **`maintenance`**：会话存储清理 + 保留控制。 + - `mode`：`warn` 仅发出警告；`enforce` 会应用清理。 + - `pruneAfter`：过期条目的年龄截止（默认 `30d`）。 - `maxEntries`：`sessions.json` 中的最大条目数（默认 `500`）。 - `rotateBytes`：当 `sessions.json` 超过该大小时轮转（默认 `10mb`）。 - - `resetArchiveRetention`：`*.reset.` 转录归档的保留时长。默认与 `pruneAfter` 相同；设为 `false` 可禁用。 - - `maxDiskBytes`：可选的 sessions 目录磁盘预算。在 `warn` 模式下会记录警告；在 `enforce` 模式下会优先移除最旧的制品/会话。 - - `highWaterBytes`：预算清理后的可选目标值。默认是 `maxDiskBytes` 的 `80%`。 + - `resetArchiveRetention`：`*.reset.` 转录归档的保留期。默认与 `pruneAfter` 相同；设为 `false` 可禁用。 + - `maxDiskBytes`：可选的会话目录磁盘预算。在 `warn` 模式下会记录警告；在 `enforce` 模式下会优先删除最旧的产物/会话。 + - `highWaterBytes`：预算清理后的可选目标。默认是 `maxDiskBytes` 的 `80%`。 - **`threadBindings`**：线程绑定会话功能的全局默认值。 - `enabled`：主默认开关（provider 可覆盖；Discord 使用 `channels.discord.threadBindings.enabled`） - - `idleHours`：默认按小时计算的非活动自动取消聚焦（`0` 表示禁用；provider 可覆盖） - - `maxAgeHours`：默认按小时计算的硬性最大存活期（`0` 表示禁用；provider 可覆盖） + - `idleHours`：按小时计算的默认无活动自动取消聚焦（`0` 可禁用；provider 可覆盖） + - `maxAgeHours`：按小时计算的默认硬最大年龄（`0` 可禁用；provider 可覆盖） @@ -1763,7 +1758,7 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 }, }, inbound: { - debounceMs: 2000, // 0 表示禁用 + debounceMs: 2000, // 0 可禁用 byChannel: { whatsapp: 5000, slack: 1500, @@ -1773,38 +1768,38 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 } ``` -### 回复前缀 +### 响应前缀 -按渠道/账号覆盖：`channels..responsePrefix`、`channels..accounts..responsePrefix`。 +每渠道/每账号覆盖：`channels..responsePrefix`、`channels..accounts..responsePrefix`。 -解析顺序（越具体越优先）：账号 → 渠道 → 全局。`""` 会禁用并停止级联。`"auto"` 会推导为 `[{identity.name}]`。 +解析顺序（越具体越优先）：账号 → 渠道 → 全局。`""` 会禁用并停止级联。`"auto"` 会派生为 `[{identity.name}]`。 **模板变量：** -| 变量 | 描述 | 示例 | -| ----------------- | ------------------ | --------------------------- | -| `{model}` | 简短模型名 | `claude-opus-4-6` | -| `{modelFull}` | 完整模型标识符 | `anthropic/claude-opus-4-6` | -| `{provider}` | 提供商名称 | `anthropic` | -| `{thinkingLevel}` | 当前 thinking 级别 | `high`、`low`、`off` | -| `{identity.name}` | 智能体身份名称 | （与 `"auto"` 相同） | +| 变量 | 说明 | 示例 | +| ----------------- | ---------------- | --------------------------- | +| `{model}` | 短模型名 | `claude-opus-4-6` | +| `{modelFull}` | 完整模型标识符 | `anthropic/claude-opus-4-6` | +| `{provider}` | 提供商名称 | `anthropic` | +| `{thinkingLevel}` | 当前 thinking 级别 | `high`、`low`、`off` | +| `{identity.name}` | 智能体 identity 名称 |（与 `"auto"` 相同） | 变量不区分大小写。`{think}` 是 `{thinkingLevel}` 的别名。 ### 确认反应 -- 默认使用活动智能体的 `identity.emoji`，否则为 `"👀"`。设为 `""` 可禁用。 -- 按渠道覆盖：`channels..ackReaction`、`channels..accounts..ackReaction`。 +- 默认取活动智能体的 `identity.emoji`，否则为 `"👀"`。设为 `""` 可禁用。 +- 每渠道覆盖：`channels..ackReaction`、`channels..accounts..ackReaction`。 - 解析顺序：账号 → 渠道 → `messages.ackReaction` → identity 回退。 -- 作用范围：`group-mentions`（默认）、`group-all`、`direct`、`all`。 +- 作用域：`group-mentions`（默认）、`group-all`、`direct`、`all`。 - `removeAckAfterReply`：在 Slack、Discord 和 Telegram 上回复后移除确认反应。 - `messages.statusReactions.enabled`：在 Slack、Discord 和 Telegram 上启用生命周期状态反应。 - 在 Slack 和 Discord 上，未设置时如果确认反应处于启用状态，则保持状态反应启用。 - 在 Telegram 上，需要显式设置为 `true` 才会启用生命周期状态反应。 + 在 Slack 和 Discord 上，未设置时若确认反应处于活动状态，则状态反应保持启用。 + 在 Telegram 上，需显式设为 `true` 才会启用生命周期状态反应。 -### 入站防抖 +### 入站去抖 -将来自同一发送者的快速文本消息批量合并为一次智能体轮次。媒体/附件会立即刷新。控制命令会绕过防抖。 +将来自同一发送者的快速文本消息合并为一次智能体轮次。媒体/附件会立即冲刷。控制命令会绕过去抖。 ### TTS（文本转语音） @@ -1847,18 +1842,18 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 } ``` -- `auto` 控制自动 TTS。`/tts off|always|inbound|tagged` 会按会话覆盖。 -- `summaryModel` 会覆盖 `agents.defaults.model.primary` 用于自动摘要。 -- `modelOverrides` 默认启用；`modelOverrides.allowProvider` 默认是 `false`（选择性启用）。 +- `auto` 控制自动 TTS。每会话可用 `/tts off|always|inbound|tagged` 覆盖。 +- `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 TTS 端点。解析顺序为配置，然后是 `OPENAI_TTS_BASE_URL`，再然后是 `https://api.openai.com/v1`。 +- 当 `openai.baseUrl` 指向非 OpenAI 端点时，OpenClaw 会将其视为 OpenAI 兼容的 TTS 服务器，并放宽模型/声音校验。 --- ## Talk -Talk 模式（macOS/iOS/Android）的默认值。 +Talk 模式的默认值（macOS/iOS/Android）。 ```json5 { @@ -1882,51 +1877,51 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -- 当配置了多个 Talk 提供商时，`talk.provider` 必须匹配 `talk.providers` 中的一个键。 -- 旧版扁平 Talk 键（`talk.voiceId`、`talk.voiceAliases`、`talk.modelId`、`talk.outputFormat`、`talk.apiKey`）仅用于兼容，会自动迁移到 `talk.providers.`。 -- 语音 ID 会回退到 `ELEVENLABS_VOICE_ID` 或 `SAG_VOICE_ID`。 -- `providers.*.apiKey` 支持明文字符串或 SecretRef 对象。 -- 仅当未配置 Talk API key 时，才会使用 `ELEVENLABS_API_KEY` 回退。 +- 当配置了多个 Talk provider 时，`talk.provider` 必须匹配 `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` 回退。 - `providers.*.voiceAliases` 允许 Talk 指令使用友好名称。 -- `silenceTimeoutMs` 控制 Talk 模式在用户静音后等待多久才发送转录。未设置时保持平台默认暂停窗口（macOS 和 Android 为 `700 ms`，iOS 为 `900 ms`）。 +- `silenceTimeoutMs` 控制 Talk 模式在用户静默后等待多长时间再发送转录。未设置时保留平台默认暂停窗口（`macOS 和 Android 为 700 ms，iOS 为 900 ms`）。 --- ## 工具 -### 工具配置文件 +### 工具配置 `tools.profile` 会在 `tools.allow`/`tools.deny` 之前设置基础允许列表： -本地新手引导会在未设置时将新的本地配置默认设为 `tools.profile: "coding"`（现有的显式配置文件会被保留）。 +本地新手引导会在未设置时，将新的本地配置默认为 `tools.profile: "coding"`（已有显式 profile 会被保留）。 -| 配置文件 | 包含内容 | -| ----------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `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: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: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` | 所有内置工具（不包括 provider 插件） | ### `tools.allow` / `tools.deny` -全局工具允许/拒绝策略（deny 优先）。不区分大小写，支持 `*` 通配符。即使 Docker 沙箱关闭也会应用。 +全局工具 allow/deny 策略（deny 优先）。大小写不敏感，支持 `*` 通配符。即使 Docker 沙箱已关闭也会应用。 ```json5 { @@ -1936,7 +1931,7 @@ Talk 模式（macOS/iOS/Android）的默认值。 ### `tools.byProvider` -进一步限制特定提供商或模型的工具。顺序：基础配置文件 → 提供商配置文件 → allow/deny。 +进一步限制特定 provider 或模型的工具。顺序：基础 profile → provider profile → allow/deny。 ```json5 { @@ -1952,7 +1947,7 @@ Talk 模式（macOS/iOS/Android）的默认值。 ### `tools.elevated` -控制沙箱外的高权限 exec 访问： +控制沙箱外的 elevated exec 访问： ```json5 { @@ -1968,9 +1963,9 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -- 按智能体覆盖（`agents.list[].tools.elevated`）只能进一步收紧限制。 +- 每智能体覆盖（`agents.list[].tools.elevated`）只能进一步收紧。 - `/elevated on|off|ask|full` 会按会话存储状态；内联指令仅应用于单条消息。 -- 高权限 `exec` 会绕过沙箱隔离，并使用已配置的逃逸路径（默认 `gateway`，当 exec 目标是 `node` 时则使用 `node`）。 +- Elevated `exec` 会绕过沙箱隔离，并使用已配置的逃逸路径（默认为 `gateway`；当 exec 目标为 `node` 时则为 `node`）。 ### `tools.exec` @@ -1995,7 +1990,7 @@ Talk 模式（macOS/iOS/Android）的默认值。 ### `tools.loopDetection` 工具循环安全检查**默认禁用**。设置 `enabled: true` 可启用检测。 -设置可以定义在全局 `tools.loopDetection` 中，也可以在每智能体 `agents.list[].tools.loopDetection` 中覆盖。 +设置可在全局 `tools.loopDetection` 中定义，并在每智能体的 `agents.list[].tools.loopDetection` 中覆盖。 ```json5 { @@ -2017,13 +2012,13 @@ Talk 模式（macOS/iOS/Android）的默认值。 ``` - `historySize`：为循环分析保留的最大工具调用历史。 -- `warningThreshold`：重复无进展模式的警告阈值。 -- `criticalThreshold`：阻止关键循环的更高重复阈值。 -- `globalCircuitBreakerThreshold`：任意无进展运行的硬停止阈值。 -- `detectors.genericRepeat`：对重复的同工具/同参数调用发出警告。 +- `warningThreshold`：用于发出警告的重复无进展模式阈值。 +- `criticalThreshold`：用于阻止严重循环的更高重复阈值。 +- `globalCircuitBreakerThreshold`：任何无进展运行的硬停止阈值。 +- `detectors.genericRepeat`：对重复的相同工具/相同参数调用发出警告。 - `detectors.knownPollNoProgress`：对已知轮询工具（`process.poll`、`command_status` 等）的无进展情况发出警告/阻止。 - `detectors.pingPong`：对交替出现的无进展成对模式发出警告/阻止。 -- 如果 `warningThreshold >= criticalThreshold` 或 `criticalThreshold >= globalCircuitBreakerThreshold`，验证将失败。 +- 如果 `warningThreshold >= criticalThreshold` 或 `criticalThreshold >= globalCircuitBreakerThreshold`，验证会失败。 ### `tools.web` @@ -2040,7 +2035,7 @@ Talk 模式（macOS/iOS/Android）的默认值。 }, fetch: { enabled: true, - provider: "firecrawl", // 可选；省略则自动检测 + provider: "firecrawl", // 可选；省略表示自动检测 maxChars: 50000, maxCharsCap: 50000, maxResponseBytes: 2000000, @@ -2057,7 +2052,7 @@ Talk 模式（macOS/iOS/Android）的默认值。 ### `tools.media` -配置入站媒体理解（图像/音频/视频）： +配置传入媒体理解（图像/音频/视频）： ```json5 { @@ -2088,11 +2083,11 @@ Talk 模式（macOS/iOS/Android）的默认值。 -**提供商条目**（`type: "provider"` 或省略）： +**Provider 条目**（`type: "provider"` 或省略）： - `provider`：API provider ID（`openai`、`anthropic`、`google`/`gemini`、`groq` 等） - `model`：模型 ID 覆盖 -- `profile` / `preferredProfile`：`auth-profiles.json` 配置文件选择 +- `profile` / `preferredProfile`：`auth-profiles.json` 配置选择 **CLI 条目**（`type: "cli"`）： @@ -2101,11 +2096,11 @@ Talk 模式（macOS/iOS/Android）的默认值。 **公共字段：** -- `capabilities`：可选列表（`image`、`audio`、`video`）。默认：`openai`/`anthropic`/`minimax` → image，`google` → image+audio+video，`groq` → audio。 -- `prompt`、`maxChars`、`maxBytes`、`timeoutSeconds`、`language`：按条目的覆盖。 -- 失败时会回退到下一条目。 +- `capabilities`：可选列表（`image`、`audio`、`video`）。默认值：`openai`/`anthropic`/`minimax` → image，`google` → image+audio+video，`groq` → audio。 +- `prompt`、`maxChars`、`maxBytes`、`timeoutSeconds`、`language`：每条目覆盖。 +- 失败时会回退到下一个条目。 -提供商认证遵循标准顺序：`auth-profiles.json` → 环境变量 → `models.providers.*.apiKey`。 +Provider 认证遵循标准顺序：`auth-profiles.json` → 环境变量 → `models.providers.*.apiKey`。 @@ -2124,9 +2119,9 @@ Talk 模式（macOS/iOS/Android）的默认值。 ### `tools.sessions` -控制会话工具（`sessions_list`、`sessions_history`、`sessions_send`）可定位哪些会话。 +控制会话工具（`sessions_list`、`sessions_history`、`sessions_send`）可以定位哪些会话。 -默认值：`tree`（当前会话 + 由其派生的会话，例如 subagents）。 +默认值：`tree`（当前会话 + 由其生成的会话，例如子智能体）。 ```json5 { @@ -2139,13 +2134,13 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -注意： +说明： - `self`：仅当前会话键。 -- `tree`：当前会话 + 由当前会话派生的会话（subagents）。 -- `agent`：属于当前智能体 ID 的任意会话（如果你在同一智能体 ID 下运行按发送者划分的会话，可能包含其他用户）。 +- `tree`：当前会话 + 由当前会话生成的会话（子智能体）。 +- `agent`：当前智能体 ID 所属的任意会话（如果你在同一智能体 ID 下运行每发送者会话，可能包含其他用户）。 - `all`：任意会话。跨智能体定位仍需要 `tools.agentToAgent`。 -- 沙箱限制：当当前会话处于沙箱隔离中，且 `agents.defaults.sandbox.sessionToolsVisibility="spawned"` 时，即便 `tools.sessions.visibility="all"`，可见性也会被强制为 `tree`。 +- 沙箱收紧：当当前会话处于沙箱隔离中且 `agents.defaults.sandbox.sessionToolsVisibility="spawned"` 时，即使 `tools.sessions.visibility="all"`，可见性也会被强制为 `tree`。 ### `tools.sessions_spawn` @@ -2156,8 +2151,8 @@ Talk 模式（macOS/iOS/Android）的默认值。 tools: { sessions_spawn: { attachments: { - enabled: false, // 选择性启用：设为 true 以允许内联文件附件 - maxTotalBytes: 5242880, // 所有文件合计 5 MB + enabled: false, // 选择启用：设为 true 以允许内联文件附件 + maxTotalBytes: 5242880, // 所有文件总计 5 MB maxFiles: 50, maxFileBytes: 1048576, // 每个文件 1 MB retainOnSessionKeep: false, // 当 cleanup="keep" 时保留附件 @@ -2167,18 +2162,18 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -注意： +说明： -- 仅 `runtime: "subagent"` 支持附件。ACP 运行时会拒绝它们。 -- 文件会被实体化到子工作区的 `.openclaw/attachments//` 中，并包含 `.manifest.json`。 +- 附件仅支持 `runtime: "subagent"`。ACP runtime 会拒绝它们。 +- 文件会物化到子工作区的 `.openclaw/attachments//` 中，并带有 `.manifest.json`。 - 附件内容会自动从转录持久化中脱敏。 -- Base64 输入会进行严格的字母表/填充校验，并在解码前进行大小保护。 -- 文件权限为目录 `0700`、文件 `0600`。 -- 清理由 `cleanup` 策略决定：`delete` 总会删除附件；`keep` 仅在 `retainOnSessionKeep: true` 时保留。 +- Base64 输入会使用严格的字符表/填充检查，并在解码前执行大小保护。 +- 目录权限为 `0700`，文件权限为 `0600`。 +- 清理遵循 `cleanup` 策略：`delete` 总会移除附件；`keep` 仅在 `retainOnSessionKeep: true` 时保留附件。 ### `tools.experimental` -实验性内置工具开关。默认关闭，除非某条运行时特定的自动启用规则适用。 +实验性内置工具标志。除非运行时专用的自动启用规则适用，否则默认关闭。 ```json5 { @@ -2190,11 +2185,11 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -注意： +说明： -- `planTool`：为非平凡的多步骤工作跟踪启用结构化 `update_plan` 工具。 -- 默认值：对于非 OpenAI 提供商为 `false`。OpenAI 和 OpenAI Codex 运行会自动启用它。 -- 启用后，系统提示也会添加使用指导，使模型仅在实质性工作中使用它，并始终保持最多一个步骤为 `in_progress`。 +- `planTool`：为非平凡的多步工作跟踪启用结构化 `update_plan` 工具。 +- 默认值：对非 OpenAI provider 为 `false`。OpenAI 和 OpenAI Codex 运行会自动启用它。 +- 启用后，系统提示还会加入使用指导，以便模型只在较大工作中使用它，并且最多仅保留一个 `in_progress` 步骤。 ### `agents.defaults.subagents` @@ -2214,16 +2209,16 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -- `model`：派生子智能体的默认模型。省略时，子智能体会继承调用者模型。 -- `allowAgents`：当请求方智能体未设置自己的 `subagents.allowAgents` 时，供 `sessions_spawn` 使用的默认目标智能体 ID 允许列表（`["*"]` = 任意；默认：仅同一智能体）。 +- `model`：生成子智能体时的默认模型。如果省略，子智能体会继承调用方模型。 +- `allowAgents`：当请求方智能体未设置自己的 `subagents.allowAgents` 时，用于 `sessions_spawn` 的默认目标智能体 ID 允许列表（`["*"]` = 任意；默认：仅同一智能体）。 - `runTimeoutSeconds`：当工具调用省略 `runTimeoutSeconds` 时，`sessions_spawn` 使用的默认超时（秒）。`0` 表示无超时。 - 每子智能体工具策略：`tools.subagents.tools.allow` / `tools.subagents.tools.deny`。 --- -## 自定义提供商和 base URL +## 自定义 provider 和基础 URL -OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~/.openclaw/agents//agent/models.json` 添加自定义提供商。 +OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~/.openclaw/agents//agent/models.json` 添加自定义 provider。 ```json5 { @@ -2252,39 +2247,39 @@ OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~ } ``` -- 对于自定义认证需求，使用 `authHeader: true` + `headers`。 -- 使用 `OPENCLAW_AGENT_DIR`（或旧版环境变量别名 `PI_CODING_AGENT_DIR`）覆盖智能体配置根目录。 -- 对于匹配 provider ID 的合并优先级： +- 对于自定义认证需求，请使用 `authHeader: true` + `headers`。 +- 使用 `OPENCLAW_AGENT_DIR` 覆盖智能体配置根目录（或旧版环境变量别名 `PI_CODING_AGENT_DIR`）。 +- 匹配 provider ID 的合并优先级： - 非空的智能体 `models.json` `baseUrl` 值优先。 - - 非空的智能体 `apiKey` 值仅在该提供商当前配置/auth-profile 上下文中不由 SecretRef 管理时优先。 - - 由 SecretRef 管理的 provider `apiKey` 值会从源标记刷新（环境变量引用为 `ENV_VAR_NAME`，file/exec 引用为 `secretref-managed`），而不是持久化已解析的密钥。 - - 由 SecretRef 管理的 provider header 值会从源标记刷新（环境变量引用为 `secretref-env:ENV_VAR_NAME`，file/exec 引用为 `secretref-managed`）。 + - 非空的智能体 `apiKey` 值仅在当前配置/auth-profile 上下文中该 provider 不是由 SecretRef 管理时优先。 + - 由 SecretRef 管理的 provider `apiKey` 值会从源标记刷新（环境变量引用使用 `ENV_VAR_NAME`，file/exec 引用使用 `secretref-managed`），而不是持久化已解析的 secret。 + - 由 SecretRef 管理的 provider header 值会从源标记刷新（环境变量引用使用 `secretref-env:ENV_VAR_NAME`，file/exec 引用使用 `secretref-managed`）。 - 为空或缺失的智能体 `apiKey`/`baseUrl` 会回退到配置中的 `models.providers`。 - - 匹配模型的 `contextWindow`/`maxTokens` 会取显式配置值与隐式目录值中更高者。 - - 匹配模型的 `contextTokens` 在显式存在运行时上限时会保留；用它可以在不改变原生模型元数据的情况下限制有效上下文。 + - 匹配模型的 `contextWindow`/`maxTokens` 会在显式配置值与隐式目录值之间取较高者。 + - 匹配模型的 `contextTokens` 在存在时会保留显式运行时上限；可用它限制有效上下文，而不改变模型原生元数据。 - 当你希望配置完全重写 `models.json` 时，使用 `models.mode: "replace"`。 - - 标记持久化以源为权威：标记来自活动源配置快照（解析前）而非已解析的运行时 secret 值。 + - 标记持久化以源为准：标记从活动源配置快照（解析前）写入，而不是从已解析的运行时 secret 值写入。 -### 提供商字段详情 +### Provider 字段详情 - `models.mode`：provider 目录行为（`merge` 或 `replace`）。 -- `models.providers`：按 provider ID 为键的自定义 provider 映射。 +- `models.providers`：按 provider ID 键控的自定义 provider 映射。 - `models.providers.*.api`：请求适配器（`openai-completions`、`openai-responses`、`anthropic-messages`、`google-generative-ai` 等）。 -- `models.providers.*.apiKey`：provider 凭证（优先使用 SecretRef/环境变量替换）。 +- `models.providers.*.apiKey`：provider 凭据（优先使用 SecretRef/环境变量替换）。 - `models.providers.*.auth`：认证策略（`api-key`、`token`、`oauth`、`aws-sdk`）。 -- `models.providers.*.injectNumCtxForOpenAICompat`：对于 Ollama + `openai-completions`，将 `options.num_ctx` 注入请求（默认：`true`）。 -- `models.providers.*.authHeader`：当需要时，强制在 `Authorization` header 中传输凭证。 -- `models.providers.*.baseUrl`：上游 API base URL。 -- `models.providers.*.headers`：用于代理/租户路由的额外静态 header。 -- `models.providers.*.request`：模型提供商 HTTP 请求的传输覆盖。 - - `request.headers`：额外 header（与 provider 默认值合并）。值支持 SecretRef。 - - `request.auth`：认证策略覆盖。模式：`"provider-default"`（使用 provider 内建认证）、`"authorization-bearer"`（配合 `token`）、`"header"`（配合 `headerName`、`value` 和可选 `prefix`）。 +- `models.providers.*.injectNumCtxForOpenAICompat`：用于 Ollama + `openai-completions`，向请求中注入 `options.num_ctx`（默认：`true`）。 +- `models.providers.*.authHeader`：需要时强制通过 `Authorization` header 传递凭据。 +- `models.providers.*.baseUrl`：上游 API 基础 URL。 +- `models.providers.*.headers`：用于代理/租户路由的额外静态 headers。 +- `models.providers.*.request`：模型 provider HTTP 请求的传输覆盖。 + - `request.headers`：额外 headers（与 provider 默认值合并）。值接受 SecretRef。 + - `request.auth`：认证策略覆盖。模式：`"provider-default"`（使用 provider 内建认证）、`"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.tls`：直连时的 TLS 覆盖。字段：`ca`、`cert`、`key`、`passphrase`（都接受 SecretRef）、`serverName`、`insecureSkipVerify`。 - `models.providers.*.models`：显式 provider 模型目录条目。 -- `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.*.contextWindow`：模型原生上下文窗口元数据。 +- `models.providers.*.models.*.contextTokens`：可选的运行时上下文上限。当你希望有效上下文预算小于模型原生 `contextWindow` 时使用。 +- `models.providers.*.models.*.compat.supportsDeveloperRole`：可选兼容性提示。对于 `api: "openai-completions"` 且使用非空、非原生 `baseUrl`（主机不是 `api.openai.com`）的情况，OpenClaw 会在运行时强制将其设为 `false`。空或省略 `baseUrl` 时保留默认 OpenAI 行为。 - `plugins.entries.amazon-bedrock.config.discovery`：Bedrock 自动发现设置根路径。 - `plugins.entries.amazon-bedrock.config.discovery.enabled`：开启/关闭隐式发现。 - `plugins.entries.amazon-bedrock.config.discovery.region`：用于发现的 AWS 区域。 @@ -2293,7 +2288,7 @@ OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~ - `plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow`：已发现模型的回退上下文窗口。 - `plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens`：已发现模型的回退最大输出 token。 -### 提供商示例 +### Provider 示例 @@ -2307,8 +2302,8 @@ OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~ fallbacks: ["cerebras/zai-glm-4.6"], }, models: { - "cerebras/zai-glm-4.7": { alias: "GLM 4.7（Cerebras）" }, - "cerebras/zai-glm-4.6": { alias: "GLM 4.6（Cerebras）" }, + "cerebras/zai-glm-4.7": { alias: "GLM 4.7 (Cerebras)" }, + "cerebras/zai-glm-4.6": { alias: "GLM 4.6 (Cerebras)" }, }, }, }, @@ -2320,8 +2315,8 @@ OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~ apiKey: "${CEREBRAS_API_KEY}", api: "openai-completions", models: [ - { id: "zai-glm-4.7", name: "GLM 4.7（Cerebras）" }, - { id: "zai-glm-4.6", name: "GLM 4.6（Cerebras）" }, + { id: "zai-glm-4.7", name: "GLM 4.7 (Cerebras)" }, + { id: "zai-glm-4.6", name: "GLM 4.6 (Cerebras)" }, ], }, }, @@ -2329,7 +2324,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`。 @@ -2346,7 +2341,7 @@ OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~ } ``` -设置 `OPENCODE_API_KEY`（或 `OPENCODE_ZEN_API_KEY`）。对 Zen 目录使用 `opencode/...` 引用，对 Go 目录使用 `opencode-go/...` 引用。快捷方式：`openclaw onboard --auth-choice opencode-zen` 或 `openclaw onboard --auth-choice opencode-go`。 +设置 `OPENCODE_API_KEY`（或 `OPENCODE_ZEN_API_KEY`）。Zen 目录使用 `opencode/...` 引用，Go 目录使用 `opencode-go/...` 引用。快捷方式：`openclaw onboard --auth-choice opencode-zen` 或 `openclaw onboard --auth-choice opencode-go`。 @@ -2366,8 +2361,8 @@ OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~ 设置 `ZAI_API_KEY`。`z.ai/*` 和 `z-ai/*` 都是可接受的别名。快捷方式：`openclaw onboard --auth-choice zai-api-key`。 - 通用端点：`https://api.z.ai/api/paas/v4` -- Coding 端点（默认）：`https://api.z.ai/api/coding/paas/v4` -- 对于通用端点，定义带 base URL 覆盖的自定义 provider。 +- 编码端点（默认）：`https://api.z.ai/api/coding/paas/v4` +- 对于通用端点，请定义带 base URL 覆盖的自定义 provider。 @@ -2406,11 +2401,10 @@ 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 现在根据端点 -能力而不是仅根据内置 provider ID 来决定这一点。 +`openai-completions` 传输上声明流式使用兼容性，而 OpenClaw 现在会根据端点能力而不是仅根据内置 provider ID 来判定这一点。 @@ -2428,11 +2422,11 @@ OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~ } ``` -兼容 Anthropic 的内置 provider。快捷方式：`openclaw onboard --auth-choice kimi-code-api-key`。 +Anthropic 兼容，内置 provider。快捷方式：`openclaw onboard --auth-choice kimi-code-api-key`。 - + ```json5 { @@ -2510,8 +2504,8 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 设置 `MINIMAX_API_KEY`。快捷方式： `openclaw onboard --auth-choice minimax-global-api` 或 `openclaw onboard --auth-choice minimax-cn-api`。 -模型目录现在默认仅使用 M2.7。 -在兼容 Anthropic 的流式路径上，除非你显式设置 `thinking`，否则 OpenClaw 默认会禁用 MiniMax thinking。 +模型目录现在默认仅包含 M2.7。 +在 Anthropic 兼容的流式路径上，除非你显式设置 `thinking`，否则 OpenClaw 默认会禁用 MiniMax thinking。 `/fast on` 或 `params.fastMode: true` 会将 `MiniMax-M2.7` 重写为 `MiniMax-M2.7-highspeed`。 @@ -2519,7 +2513,7 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 -参见 [Local Models](/zh-CN/gateway/local-models)。简而言之：在性能充足的硬件上通过 LM Studio Responses API 运行大型本地模型；保留已合并的托管模型用于回退。 +参见 [Local Models](/zh-CN/gateway/local-models)。简而言之：在高性能硬件上通过 LM Studio Responses API 运行大型本地模型，并保留已合并的托管模型作为回退。 @@ -2550,13 +2544,12 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 } ``` -- `allowBundled`：仅针对内置 Skills 的可选允许列表（托管/工作区 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 提供的便捷 API key 字段（明文字符串或 SecretRef 对象）。 +- `allowBundled`：仅针对内置 Skills 的可选允许列表（不影响受管/工作区 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 提供便捷 API key 配置（明文字符串或 SecretRef 对象）。 --- @@ -2585,41 +2578,41 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 ``` - 从 `~/.openclaw/extensions`、`/.openclaw/extensions` 以及 `plugins.load.paths` 加载。 -- 设备发现支持原生 OpenClaw 插件，以及兼容的 Codex bundle 和 Claude bundle，包括无 manifest 的 Claude 默认布局 bundle。 -- **配置变更需要重启 Gateway 网关。** +- 设备发现支持原生 OpenClaw 插件，以及兼容的 Codex bundle 和 Claude bundle，包括无清单的 Claude 默认布局 bundle。 +- **配置更改需要重启 Gateway 网关。** - `allow`：可选允许列表（仅加载列出的插件）。`deny` 优先。 - `plugins.entries..apiKey`：插件级 API key 便捷字段（当插件支持时）。 - `plugins.entries..env`：插件作用域环境变量映射。 -- `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 provider 设置。 - - `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`）。 +- `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 抓取 provider 设置。 + - `apiKey`：Firecrawl API key（接受 SecretRef）。会回退到 `plugins.entries.firecrawl.config.webSearch.apiKey`、旧版 `tools.web.fetch.firecrawl.apiKey` 或 `FIRECRAWL_API_KEY` 环境变量。 + - `baseUrl`：Firecrawl API 基础 URL（默认：`https://api.firecrawl.dev`）。 - `onlyMainContent`：仅提取页面主体内容（默认：`true`）。 - - `maxAgeMs`：最大缓存年龄，单位毫秒（默认：`172800000` / 2 天）。 - - `timeoutSeconds`：抓取请求超时，单位秒（默认：`60`）。 + - `maxAgeMs`：最大缓存年龄（毫秒）（默认：`172800000` / 2 天）。 + - `timeoutSeconds`：抓取请求超时（秒）（默认：`60`）。 - `plugins.entries.xai.config.xSearch`：xAI X Search（Grok Web 搜索）设置。 - `enabled`：启用 X Search provider。 - `model`：用于搜索的 Grok 模型（例如 `"grok-4-1-fast"`）。 -- `plugins.entries.memory-core.config.dreaming`：记忆 dreaming（实验性）设置。模式和阈值参见 [Dreaming](/zh-CN/concepts/dreaming)。 - - `mode`：dreaming 频率预设（`"off"`、`"core"`、`"rem"`、`"deep"`）。默认：`"off"`。 - - `cron`：可选的 dreaming 调度 cron 表达式覆盖。 - - `timezone`：调度评估使用的时区（回退到 `agents.defaults.userTimezone`）。 - - `limit`：每个周期最多提升的候选数。 +- `plugins.entries.memory-core.config.dreaming`：memory dreaming（实验性）设置。关于模式和阈值，请参见 [Dreaming](/zh-CN/concepts/dreaming)。 + - `mode`：dreaming 节奏预设（`"off"`、`"core"`、`"rem"`、`"deep"`）。默认值：`"off"`。 + - `cron`：可选 cron 表达式覆盖，用于 dreaming 调度。 + - `timezone`：用于调度计算的时区（回退到 `agents.defaults.userTimezone`）。 + - `limit`：每个周期可提升的候选项最大数量。 - `minScore`：提升所需的最小加权分数阈值。 - - `minRecallCount`：最小回忆计数阈值。 - - `minUniqueQueries`：最小不同查询数阈值。 - - `recencyHalfLifeDays`：近期性分数衰减到一半所需的天数。默认：`14`。 - - `maxAgeDays`：可选的最大日记年龄（按天），超出则不允许提升。 - - `verboseLogging`：将详细的每次 dreaming 日志输出到常规 Gateway 网关日志流。 -- 已启用的 Claude bundle 插件也可提供来自 `settings.json` 的嵌入式 Pi 默认值；OpenClaw 会将其作为净化后的智能体设置应用，而不是原始 OpenClaw 配置补丁。 -- `plugins.slots.memory`：选择活动记忆插件 ID，或设置为 `"none"` 以禁用记忆插件。 -- `plugins.slots.contextEngine`：选择活动上下文引擎插件 ID；默认是 `"legacy"`，除非你安装并选用了其他引擎。 -- `plugins.installs`：供 `openclaw plugins update` 使用的 CLI 管理安装元数据。 + - `minRecallCount`：最小回忆次数阈值。 + - `minUniqueQueries`：最少不同查询数阈值。 + - `recencyHalfLifeDays`：新近度分数衰减一半所需的天数。默认：`14`。 + - `maxAgeDays`：允许提升的每日笔记最大年龄（天），可选。 + - `verboseLogging`：将详细的每次 dreaming 运行日志输出到常规 Gateway 网关日志流中。 +- 已启用的 Claude bundle 插件也可以贡献内嵌 Pi 默认值，OpenClaw 会将其作为清理后的智能体设置应用，而不是原始 OpenClaw 配置补丁。 +- `plugins.slots.memory`：选择活动 memory 插件 ID，或使用 `"none"` 禁用 memory 插件。 +- `plugins.slots.contextEngine`：选择活动 context engine 插件 ID；默认是 `"legacy"`，除非你安装并选择了其他引擎。 +- `plugins.installs`：`openclaw plugins update` 使用的 CLI 托管安装元数据。 - 包括 `source`、`spec`、`sourcePath`、`installPath`、`version`、`resolvedName`、`resolvedVersion`、`resolvedSpec`、`integrity`、`shasum`、`resolvedAt`、`installedAt`。 - - 将 `plugins.installs.*` 视为托管状态；优先使用 CLI 命令，而不是手动编辑。 + - 将 `plugins.installs.*` 视为托管状态；优先使用 CLI 命令而不是手动编辑。 参见 [Plugins](/zh-CN/tools/plugin)。 @@ -2635,7 +2628,7 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 defaultProfile: "user", ssrfPolicy: { dangerouslyAllowPrivateNetwork: true, // 默认可信网络模式 - // allowPrivateNetwork: true, // 旧别名 + // allowPrivateNetwork: true, // 旧版别名 // hostnameAllowlist: ["*.example.com", "example.com"], // allowedHostnames: ["localhost"], }, @@ -2662,21 +2655,25 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 ``` - `evaluateEnabled: false` 会禁用 `act:evaluate` 和 `wait --fn`。 -- 当未设置时，`ssrfPolicy.dangerouslyAllowPrivateNetwork` 默认是 `true`（可信网络模型）。 -- 如需严格的仅公共网络浏览导航，请设置 `ssrfPolicy.dangerouslyAllowPrivateNetwork: false`。 -- 在严格模式下，远程 CDP 配置文件端点（`profiles.*.cdpUrl`）在可达性/设备发现检查期间也会受到同样的私有网络阻止策略约束。 -- `ssrfPolicy.allowPrivateNetwork` 仍支持作为旧版别名。 -- 在严格模式下，使用 `ssrfPolicy.hostnameAllowlist` 和 `ssrfPolicy.allowedHostnames` 添加显式例外。 -- 远程配置文件仅支持附加（禁用启动/停止/重置）。 +- `ssrfPolicy.dangerouslyAllowPrivateNetwork` 未设置时默认是 `true`（可信网络模型）。 +- 对于严格的仅公共浏览器导航，请设置 `ssrfPolicy.dangerouslyAllowPrivateNetwork: false`。 +- 在严格模式下，远程 CDP 配置端点（`profiles.*.cdpUrl`）在可达性/设备发现检查时也会受到相同的私有网络阻止。 +- `ssrfPolicy.allowPrivateNetwork` 仍作为旧版别名受到支持。 +- 在严格模式下，可使用 `ssrfPolicy.hostnameAllowlist` 和 `ssrfPolicy.allowedHostnames` 作为显式例外。 +- 远程配置是仅附加模式（不支持 start/stop/reset）。 - `profiles.*.cdpUrl` 接受 `http://`、`https://`、`ws://` 和 `wss://`。 - 当你希望 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 选择器定位、单文件上传 hook、不支持对话框超时覆盖、不支持 `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 发现 `/json/version` 时，请使用 HTTP(S)； + 当 provider 提供直接的 DevTools WebSocket URL 时，请使用 WS(S)。 +- `existing-session` 配置为仅主机可用，并使用 Chrome MCP 而不是 CDP。 +- `existing-session` 配置可设置 `userDataDir`，以定位特定的 + Chromium 内核浏览器配置，例如 Brave 或 Edge。 +- `existing-session` 配置保留当前的 Chrome MCP 路由限制： + 使用 snapshot/ref 驱动的操作而不是 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`、窗口大小设置或调试参数）。 --- @@ -2694,8 +2691,8 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 } ``` -- `seamColor`：原生应用 UI 边框的强调色（Talk Mode 气泡着色等）。 -- `assistant`：Control UI 身份覆盖。默认回退到活动智能体身份。 +- `seamColor`：原生应用 UI 外观的强调色（Talk 模式气泡色调等）。 +- `assistant`：Control UI identity 覆盖。会回退到活动智能体 identity。 --- @@ -2728,8 +2725,8 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 enabled: true, basePath: "/openclaw", // root: "dist/control-ui", - // allowedOrigins: ["https://control.example.com"], // 非 loopback Control UI 必需 - // dangerouslyAllowHostHeaderOriginFallback: false, // 危险的基于 Host header 的 origin 回退模式 + // allowedOrigins: ["https://control.example.com"], // 非 loopback Control UI 所必需 + // dangerouslyAllowHostHeaderOriginFallback: false, // 危险的 Host-header origin 回退模式 // allowInsecureAuth: false, // dangerouslyDisableDeviceAuth: false, }, @@ -2762,39 +2759,41 @@ Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 -- `mode`：`local`（运行 Gateway 网关）或 `remote`（连接远程 Gateway 网关）。除非为 `local`，否则 Gateway 网关拒绝启动。 -- `port`：WS + HTTP 复用的单端口。优先级：`--port` > `OPENCLAW_GATEWAY_PORT` > `gateway.port` > `18789`。 +- `mode`：`local`（运行网关）或 `remote`（连接远程网关）。除非为 `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 mode 值（`auto`、`loopback`、`lan`、`tailnet`、`custom`），不要使用 host 别名（`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"`（或设为 `"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` 的身份 header（参见 [Trusted Proxy Auth](/zh-CN/gateway/trusted-proxy-auth)）。此模式要求 **非 loopback** 代理源；同主机的 loopback 反向代理不满足 trusted-proxy 认证条件。 -- `gateway.auth.allowTailscale`：当为 `true` 时，Tailscale Serve 身份 header 可用于满足 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}` 的失败尝试会在失败写入之前串行化。因此来自同一客户端的并发错误尝试，可能会在第二个请求时触发限流，而不是两个都作为普通不匹配并发通过。 - - `gateway.auth.rateLimit.exemptLoopback` 默认是 `true`；若你有意让 localhost 流量也受限流约束（测试环境或严格代理部署），请设为 `false`。 -- 源自浏览器的 WS 认证尝试始终会在禁用 loopback 豁免的条件下被限流（作为针对基于浏览器的 localhost 暴力破解的纵深防御）。 -- 在 loopback 上，这些浏览器来源的锁定会按规范化后的 `Origin` - 值独立隔离，因此来自某个 localhost origin 的重复失败不会自动锁死不同的 origin。 -- `tailscale.mode`：`serve`（仅 tailnet，loopback 绑定）或 `funnel`（公开，需要认证）。 -- `controlUi.allowedOrigins`：用于 Gateway 网关 WebSocket 连接的显式浏览器 origin 允许列表。当期望浏览器客户端来自非 loopback origin 时必需。 -- `controlUi.dangerouslyAllowHostHeaderOriginFallback`：危险模式，为那些有意依赖 Host header origin 策略的部署启用基于 Host header 的 origin 回退。 +- **旧版 bind 别名**：请在 `gateway.bind` 中使用绑定模式值（`auto`、`loopback`、`lan`、`tailnet`、`custom`），不要使用主机别名（`0.0.0.0`、`127.0.0.1`、`localhost`、`::`、`::1`）。 +- **Docker 注意事项**：默认的 `loopback` 绑定会在容器内监听 `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 identity 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 暴力破解的纵深防御）。 +- 在 loopback 上，这些来自浏览器源的锁定会按规范化后的 `Origin` + 值隔离，因此一个 localhost origin 的重复失败不会自动锁定另一个 origin。 +- `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://`；默认仍只允许 loopback 使用明文。 -- `gateway.remote.token` / `.password` 是远程客户端凭证字段。它们本身不会配置 Gateway 网关认证。 -- `gateway.push.apns.relay.baseUrl`：官方/TestFlight iOS 版本在将基于 relay 的注册发布到 Gateway 网关后，供其使用的外部 APNs relay 基础 HTTPS URL。此 URL 必须与编译进 iOS 构建的 relay URL 一致。 +- `OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1`：客户端侧紧急开关覆盖，允许对受信任私有网络 IP 使用明文 `ws://`；默认情况下，明文仍然只允许用于 loopback。 +- `gateway.remote.token` / `.password` 是远程客户端凭据字段。它们本身不会配置 Gateway 网关认证。 +- `gateway.push.apns.relay.baseUrl`：官方/TestFlight iOS 构建在向 Gateway 网关发布基于 relay 的注册后，供外部 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`。 +- 基于 relay 的注册会委托给特定 Gateway 网关身份。已配对的 iOS 应用会获取 `gateway.identity.get`，在 relay 注册中包含该 identity，并向 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`：在保留全局监视器启用的前提下，按渠道选择退出健康监视器重启。 -- `channels..accounts..healthMonitor.enabled`：多账号渠道的按账号覆盖。设置时，它优先于渠道级覆盖。 -- 仅当 `gateway.auth.*` 未设置时，本地 Gateway 网关调用路径才可将 `gateway.remote.*` 用作回退。 -- 如果 `gateway.auth.token` / `gateway.auth.password` 通过 SecretRef 显式配置但无法解析，则会以默认拒绝方式失败（不会使用远程回退来掩盖）。 -- `trustedProxies`：终止 TLS 或注入转发客户端 header 的反向代理 IP。只列出你控制的代理。loopback 条目对于同主机代理/本地检测设置（例如 Tailscale Serve 或本地反向代理）仍然有效，但它们**不会**让 loopback 请求具备 `gateway.auth.mode: "trusted-proxy"` 资格。 -- `allowRealIpFallback`：为 `true` 时，如果缺少 `X-Forwarded-For`，Gateway 网关会接受 `X-Real-IP`。默认 `false` \ No newline at end of file +- `gateway.channelMaxRestartsPerHour`：滚动 1 小时内每个渠道/账号的最大健康监控重启次数。默认值：`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` 额外阻止的工具名称（扩展默认 deny 列表）。 +- `gateway \ No newline at end of file