diff --git a/docs/zh-CN/gateway/configuration-reference.md b/docs/zh-CN/gateway/configuration-reference.md
index f6aa41288..46179da11 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-07T18:03:05Z"
+ generated_at: "2026-04-08T03:52:03Z"
model: gpt-5.4
provider: openai
- source_hash: 2c7991b948cbbb7954a3e26280089ab00088e7f4878ec0b0540c3c9acf222ebb
+ source_hash: a22899b8f43a7819a2e27fae1bddbe67b29b314bce5a9844fc276482bda9156c
source_path: gateway/configuration-reference.md
workflow: 15
---
# 配置参考
-`~/.openclaw/openclaw.json` 中可用的每个字段。要查看面向任务的概览,请参阅 [配置](/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` | 阻止所有群组/房间消息 |
-当提供商的 `groupPolicy` 未设置时,`channels.defaults.groupPolicy` 会设置默认值。
+`channels.defaults.groupPolicy` 会在提供商的 `groupPolicy` 未设置时设为默认值。
配对码会在 1 小时后过期。待处理的私信配对请求上限为**每个渠道 3 个**。
-如果整个提供商块缺失(即不存在 `channels.`),运行时群组策略会回退为 `allowlist`(默认拒绝),并在启动时发出警告。
+如果整个提供商配置块缺失(即不存在 `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` 为各提供商设置共享的群组策略和心跳行为:
```json5
{
@@ -91,15 +91,15 @@ x-i18n:
}
```
-- `channels.defaults.groupPolicy`:当提供商级别的 `groupPolicy` 未设置时使用的后备群组策略。
-- `channels.defaults.contextVisibility`:所有渠道的默认补充上下文可见性模式。取值:`all`(默认,包含所有引用/线程/历史上下文)、`allowlist`(只包含来自允许列表发送者的上下文)、`allowlist_quote`(与 allowlist 相同,但保留显式引用/回复上下文)。单渠道覆盖:`channels..contextVisibility`。
+- `channels.defaults.groupPolicy`:当提供商级 `groupPolicy` 未设置时的回退群组策略。
+- `channels.defaults.contextVisibility`:所有渠道的默认补充上下文可见性模式。可选值:`all`(默认,包含所有引用/线程/历史上下文)、`allowlist`(仅包含来自允许列表发送者的上下文)、`allowlist_quote`(与 allowlist 相同,但保留显式引用/回复上下文)。按渠道覆盖:`channels..contextVisibility`。
- `channels.defaults.heartbeat.showOk`:在心跳输出中包含健康渠道状态。
- `channels.defaults.heartbeat.showAlerts`:在心跳输出中包含降级/错误状态。
-- `channels.defaults.heartbeat.useIndicator`:渲染紧凑的指示器样式心跳输出。
+- `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, // 蓝色对勾(在 self-chat 模式下为 false)
+ sendReadReceipts: true, // blue ticks (false in self-chat mode)
groups: {
"*": { requireMention: true },
},
@@ -132,7 +132,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
}
```
-
+
```json5
{
@@ -150,10 +150,10 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
}
```
-- 出站命令默认使用账户 `default`(如果存在);否则使用第一个已配置的账户 id(排序后)。
-- 可选的 `channels.whatsapp.defaultAccount` 会在其匹配某个已配置账户 id 时覆盖该后备默认账户选择。
-- 旧版单账户 Baileys 认证目录会由 `openclaw doctor` 迁移到 `whatsapp/default`。
-- 每账户覆盖:`channels.whatsapp.accounts..sendReadReceipts`、`channels.whatsapp.accounts..dmPolicy`、`channels.whatsapp.accounts..allowFrom`。
+- 出站命令默认使用 `default` 账号(如果存在);否则使用第一个已配置的账号 ID(排序后)。
+- 可选的 `channels.whatsapp.defaultAccount` 会在其匹配某个已配置账号 ID 时,覆盖该回退默认账号选择。
+- 旧版单账号 Baileys 凭证目录会由 `openclaw doctor` 迁移到 `whatsapp/default`。
+- 按账号覆盖:`channels.whatsapp.accounts..sendReadReceipts`、`channels.whatsapp.accounts..dmPolicy`、`channels.whatsapp.accounts..allowFrom`。
@@ -188,7 +188,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
historyLimit: 50,
replyToMode: "first", // off | first | all | batched
linkPreview: true,
- streaming: "partial", // off | partial | block | progress(默认:off;需显式启用以避免预览编辑速率限制)
+ streaming: "partial", // off | partial | block | progress (default: off; opt in explicitly to avoid preview-edit rate limits)
actions: { reactions: true, sendMessage: true },
reactionNotifications: "own", // off | own | all
mediaMaxMb: 100,
@@ -211,13 +211,13 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
}
```
-- Bot token:`channels.telegram.botToken` 或 `channels.telegram.tokenFile`(仅允许常规文件;拒绝符号链接),默认账户还可回退到 `TELEGRAM_BOT_TOKEN`。
-- 可选的 `channels.telegram.defaultAccount` 会在其匹配某个已配置账户 id 时覆盖默认账户选择。
-- 在多账户设置中(2 个或更多账户 id),设置显式默认值(`channels.telegram.defaultAccount` 或 `channels.telegram.accounts.default`)以避免后备路由;若缺失或无效,`openclaw doctor` 会发出警告。
-- `configWrites: false` 会阻止由 Telegram 发起的配置写入(supergroup 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`(在私聊和群聊中都有效)。
-- 重试策略:参见 [重试策略](/zh-CN/concepts/retry)。
+- Bot token:`channels.telegram.botToken` 或 `channels.telegram.tokenFile`(仅允许普通文件;拒绝符号链接),默认账号还可回退到 `TELEGRAM_BOT_TOKEN`。
+- 可选的 `channels.telegram.defaultAccount` 会在其匹配某个已配置账号 ID 时覆盖默认账号选择。
+- 在多账号设置(2 个及以上账号 ID)中,请设置显式默认值(`channels.telegram.defaultAccount` 或 `channels.telegram.accounts.default`),以避免回退路由;缺失或无效时,`openclaw doctor` 会发出警告。
+- `configWrites: false` 会阻止由 Telegram 发起的配置写入(超级群组 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`(可在私聊和群聊中工作)。
+- 重试策略:参见 [Retry policy](/zh-CN/concepts/retry)。
### Discord
@@ -272,7 +272,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
historyLimit: 20,
textChunkLimit: 2000,
chunkMode: "length", // length | newline
- streaming: "off", // off | partial | block | progress(progress 在 Discord 上会映射为 partial)
+ streaming: "off", // off | partial | block | progress (progress maps to partial on Discord)
maxLinesPerMessage: 17,
ui: {
components: {
@@ -283,7 +283,7 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
enabled: true,
idleHours: 24,
maxAgeHours: 0,
- spawnSubagentSessions: false, // 为 `sessions_spawn({ thread: true })` 显式启用
+ spawnSubagentSessions: false, // opt-in for sessions_spawn({ thread: true })
},
voice: {
enabled: true,
@@ -319,36 +319,36 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
}
```
-- Token:`channels.discord.token`,默认账户还可回退到 `DISCORD_BOT_TOKEN`。
-- 直接出站调用如果提供了显式的 Discord `token`,该调用会使用该 token;账户重试/策略设置仍来自活动运行时快照中选定的账户。
-- 可选的 `channels.discord.defaultAccount` 会在其匹配某个已配置账户 id 时覆盖默认账户选择。
-- 交付目标使用 `user:`(私信)或 `channel:`(服务器频道);纯数字 ID 会被拒绝。
-- Guild slug 使用小写,并将空格替换为 `-`;渠道键使用 slug 化名称(不带 `#`)。优先使用 guild ID。
-- 默认忽略机器人自己发送的消息。`allowBots: true` 会启用;`allowBots: "mentions"` 仅接受提及该机器人的机器人消息(机器人自己的消息仍会被过滤)。
-- `channels.discord.guilds..ignoreOtherMentions`(以及渠道级覆盖)会丢弃提及其他用户或角色但未提及机器人的消息(不包括 @everyone/@here)。
-- `maxLinesPerMessage`(默认 17)会拆分过高的消息,即使消息长度未超过 2000 个字符。
+- 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` 中使用 channel/thread id)。字段语义与 [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings) 共享。
-- `channels.discord.ui.components.accentColor` 为 Discord components v2 容器设置强调色。
+ - `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"`(默认)。在 auto 模式下,当可以从 `approvers` 或 `commands.ownerAllowFrom` 解析到审批人时,exec 审批会激活。
- - `approvers`:允许批准 exec 请求的 Discord 用户 ID。省略时回退到 `commands.ownerAllowFrom`。
- - `agentFilter`:可选智能体 ID 允许列表。省略则转发所有智能体的审批。
- - `sessionFilter`:可选会话键模式(子串或正则)。
- - `target`:发送审批提示的位置。`"dm"`(默认)发送到审批人的私信,`"channel"` 发送到发起渠道,`"both"` 同时发送到两者。当 target 包含 `"channel"` 时,按钮仅对已解析的审批人可用。
- - `cleanupAfterResolve`:为 `true` 时,在审批、拒绝或超时后删除审批私信。
+- `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 审批。
+ - `approvers`:允许审批 exec 请求的 Discord 用户 ID。省略时回退到 `commands.ownerAllowFrom`。
+ - `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,10 +379,10 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
}
```
-- 服务账户 JSON:可内联(`serviceAccount`)或基于文件(`serviceAccountFile`)。
-- 也支持服务账户 SecretRef(`serviceAccountRef`)。
+- 服务账号 JSON:内联(`serviceAccount`)或基于文件(`serviceAccountFile`)。
+- 也支持服务账号 SecretRef(`serviceAccountRef`)。
- 环境变量回退:`GOOGLE_CHAT_SERVICE_ACCOUNT` 或 `GOOGLE_CHAT_SERVICE_ACCOUNT_FILE`。
-- 交付目标使用 `spaces/` 或 `users/`。
+- 对投递目标请使用 `spaces/` 或 `users/`。
- `channels.googlechat.dangerouslyAllowNameMatching` 会重新启用可变电子邮件主体匹配(紧急兼容模式)。
### Slack
@@ -433,8 +433,8 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
typingReaction: "hourglass_flowing_sand",
textChunkLimit: 4000,
chunkMode: "length",
- streaming: "partial", // off | partial | block | progress(预览模式)
- nativeStreaming: true, // 当 streaming=partial 时使用 Slack 原生流式 API
+ streaming: "partial", // off | partial | block | progress (preview mode)
+ nativeStreaming: true, // use Slack native streaming API when streaming=partial
mediaMaxMb: 20,
execApprovals: {
enabled: "auto", // true | false | "auto"
@@ -448,33 +448,34 @@ WhatsApp 通过 Gateway 网关的 web 渠道(Baileys Web)运行。当已存
}
```
-- **Socket mode** 需要同时提供 `botToken` 和 `appToken`(默认账户环境变量回退为 `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN`)。
-- **HTTP mode** 需要 `botToken` 加 `signingSecret`(可位于根级或每账户级)。
+- **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 值。
+- Slack 账号快照会暴露每个凭证的来源/状态字段,例如
+ `botTokenSource`、`botTokenStatus`、`appTokenStatus`,以及在 HTTP mode 下的
+ `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 shortcode,例如 `"hourglass_flowing_sand"`。
-- `channels.slack.execApprovals`:Slack 原生 exec 审批交付和审批人授权。与 Discord 相同的 schema:`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
@@ -495,10 +496,10 @@ Mattermost 作为插件提供:`openclaw plugins install @openclaw/mattermost`
"team-channel-id": { requireMention: false },
},
commands: {
- native: true, // 显式启用
+ native: true, // opt-in
nativeSkills: true,
callbackPath: "/api/channels/mattermost/command",
- // 反向代理/公共部署可选显式 URL
+ // Optional explicit URL for reverse-proxy/public deployments
callbackUrl: "https://gateway.example.com/api/channels/mattermost/command",
},
textChunkLimit: 4000,
@@ -508,21 +509,21 @@ 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` 包含该回调主机/域名。
+- `commands.callbackUrl` 必须解析到 OpenClaw Gateway 网关端点,并且 Mattermost 服务器可以访问到。
+- 原生 slash 回调通过 Mattermost 在 slash 命令注册期间返回的每命令 token 进行认证。如果注册失败或没有命令被激活,OpenClaw 会拒绝回调,并返回
+ `Unauthorized: invalid command token.`。
+- 对于 private/tailnet/internal 回调主机,Mattermost 可能要求
+ `ServiceSettings.AllowedUntrustedInternalConnections` 包含回调主机/域名。
请使用主机/域名值,而不是完整 URL。
- `channels.mattermost.configWrites`:允许或拒绝由 Mattermost 发起的配置写入。
-- `channels.mattermost.requireMention`:要求在频道中回复前必须有 `@mention`。
-- `channels.mattermost.groups..requireMention`:按频道的提及门控覆盖(`"*"` 表示默认)。
-- 可选的 `channels.mattermost.defaultAccount` 会在其匹配某个已配置账户 id 时覆盖默认账户选择。
+- `channels.mattermost.requireMention`:在频道中回复前要求 `@mention`。
+- `channels.mattermost.groups..requireMention`:按频道的提及门控覆盖(`"*"` 表示默认值)。
+- 可选的 `channels.mattermost.defaultAccount` 会在其匹配某个已配置账号 ID 时覆盖默认账号选择。
### Signal
@@ -531,7 +532,7 @@ Mattermost 作为插件提供:`openclaw plugins install @openclaw/mattermost`
channels: {
signal: {
enabled: true,
- account: "+15555550123", // 可选账户绑定
+ account: "+15555550123", // optional account binding
dmPolicy: "pairing",
allowFrom: ["+15551234567", "uuid:123e4567-e89b-12d3-a456-426614174000"],
configWrites: true,
@@ -545,13 +546,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
{
@@ -559,21 +560,21 @@ BlueBubbles 是推荐的 iMessage 路径(由插件支持,在 `channels.blueb
bluebubbles: {
enabled: true,
dmPolicy: "pairing",
- // serverUrl、password、webhookPath、群组控制和高级操作:
- // 参见 /channels/bluebubbles
+ // serverUrl, password, webhookPath, group controls, and advanced actions:
+ // see /channels/bluebubbles
},
},
}
```
-- 此处涵盖的核心键路径:`channels.bluebubbles`、`channels.bluebubbles.dmPolicy`。
-- 可选的 `channels.bluebubbles.defaultAccount` 会在其匹配某个已配置账户 id 时覆盖默认账户选择。
+- 这里涵盖的核心键路径:`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)。
- 完整的 BlueBubbles 渠道配置记录在 [BlueBubbles](/zh-CN/channels/bluebubbles) 中。
### iMessage
-OpenClaw 会启动 `imsg rpc`(基于 stdio 的 JSON-RPC)。不需要守护进程或端口。
+OpenClaw 会启动 `imsg rpc`(通过 stdio 的 JSON-RPC)。不需要守护进程或端口。
```json5
{
@@ -597,11 +598,11 @@ OpenClaw 会启动 `imsg rpc`(基于 stdio 的 JSON-RPC)。不需要守护
}
```
-- 可选的 `channels.imessage.defaultAccount` 会在其匹配某个已配置账户 id 时覆盖默认账户选择。
+- 可选的 `channels.imessage.defaultAccount` 会在其匹配某个已配置账号 ID 时覆盖默认账号选择。
-- 需要对 Messages 数据库授予完整磁盘访问权限。
-- 优先使用 `chat_id:` 目标。使用 `imsg chats --limit 20` 列出聊天。
-- `cliPath` 可以指向一个 SSH 包装器;设置 `remoteHost`(`host` 或 `user@host`)用于通过 SCP 获取附件。
+- 需要对 Messages 数据库授予完全磁盘访问权限。
+- 优先使用 `chat_id:` 目标。可运行 `imsg chats --limit 20` 列出聊天。
+- `cliPath` 可指向一个 SSH 包装器;设置 `remoteHost`(`host` 或 `user@host`)即可通过 SCP 获取附件。
- `attachmentRoots` 和 `remoteAttachmentRoots` 会限制入站附件路径(默认:`/Users/*/Library/Messages/Attachments`)。
- SCP 使用严格主机密钥检查,因此请确保中继主机密钥已存在于 `~/.ssh/known_hosts` 中。
- `channels.imessage.configWrites`:允许或拒绝由 iMessage 发起的配置写入。
@@ -649,19 +650,19 @@ Matrix 由扩展支持,在 `channels.matrix` 下配置。
```
- Token 认证使用 `accessToken`;密码认证使用 `userId` + `password`。
-- `channels.matrix.proxy` 会通过显式 HTTP(S) 代理转发 Matrix HTTP 流量。命名账户可通过 `channels.matrix.accounts..proxy` 覆盖它。
-- `channels.matrix.network.dangerouslyAllowPrivateNetwork` 允许私有/内部 homeserver。`proxy` 与这个网络显式启用是独立控制项。
-- `channels.matrix.defaultAccount` 在多账户设置中选择首选账户。
-- `channels.matrix.autoJoin` 默认是 `off`,因此收到邀请的房间和新的 DM 风格邀请都会被忽略,直到你设置 `autoJoin: "allowlist"` 并配置 `autoJoinAllowlist`,或者设置 `autoJoin: "always"`。
-- `channels.matrix.execApprovals`:Matrix 原生 exec 审批交付和审批人授权。
- - `enabled`:`true`、`false` 或 `"auto"`(默认)。在 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 状态探测和实时目录查找与运行时流量使用相同的代理策略。
+- `channels.matrix.proxy` 会通过显式 HTTP(S) 代理转发 Matrix HTTP 流量。命名账号可通过 `channels.matrix.accounts..proxy` 覆盖。
+- `channels.matrix.network.dangerouslyAllowPrivateNetwork` 允许 private/internal homeserver。`proxy` 与该网络显式启用项是独立控制项。
+- `channels.matrix.defaultAccount` 在多账号设置中选择首选账号。
+- `channels.matrix.autoJoin` 默认值为 `off`,因此邀请房间和新的私信风格邀请会被忽略,直到你设置 `autoJoin: "allowlist"` 并配合 `autoJoinAllowlist`,或设置 `autoJoin: "always"`。
+- `channels.matrix.execApprovals`:Matrix 原生 exec 审批投递和审批人授权。
+ - `enabled`:`true`、`false` 或 `"auto"`(默认)。自动模式下,当可从 `approvers` 或 `commands.ownerAllowFrom` 解析出审批人时,会激活 exec 审批。
+ - `approvers`:允许审批 exec 请求的 Matrix 用户 ID(例如 `@owner:example.org`)。
+ - `agentFilter`:可选的智能体 ID 允许列表。省略则转发所有智能体的审批。
+ - `sessionFilter`:可选的会话键模式(子串或正则)。
+ - `target`:审批提示发送位置。`"dm"`(默认)、`"channel"`(来源房间)或 `"both"`。
+ - 按账号覆盖:`channels.matrix.accounts..execApprovals`。
+- `channels.matrix.dm.sessionScope` 控制 Matrix 私信如何分组为会话:`per-user`(默认)按路由对端共享,而 `per-room` 会隔离每个私信房间。
+- Matrix 状态探测和实时目录查找使用与运行时流量相同的代理策略。
- 完整的 Matrix 配置、目标规则和设置示例记录在 [Matrix](/zh-CN/channels/matrix) 中。
### Microsoft Teams
@@ -674,15 +675,15 @@ Microsoft Teams 由扩展支持,在 `channels.msteams` 下配置。
msteams: {
enabled: true,
configWrites: true,
- // appId、appPassword、tenantId、webhook、团队/频道策略:
- // 参见 /channels/msteams
+ // appId, appPassword, tenantId, webhook, team/channel policies:
+ // see /channels/msteams
},
},
}
```
-- 此处涵盖的核心键路径:`channels.msteams`、`channels.msteams.configWrites`。
-- 完整的 Teams 配置(凭据、webhook、私信/群组策略、按团队/按频道覆盖)记录在 [Microsoft Teams](/zh-CN/channels/msteams) 中。
+- 这里涵盖的核心键路径:`channels.msteams`、`channels.msteams.configWrites`。
+- 完整的 Teams 配置(凭证、webhook、私信/群组策略、按团队/按频道覆盖)记录在 [Microsoft Teams](/zh-CN/channels/msteams) 中。
### IRC
@@ -707,13 +708,13 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
}
```
-- 此处涵盖的核心键路径:`channels.irc`、`channels.irc.dmPolicy`、`channels.irc.configWrites`、`channels.irc.nickserv.*`。
-- 可选的 `channels.irc.defaultAccount` 会在其匹配某个已配置账户 id 时覆盖默认账户选择。
-- 完整的 IRC 渠道配置(host/port/TLS/频道/允许列表/提及门控)记录在 [IRC](/zh-CN/channels/irc) 中。
+- 这里涵盖的核心键路径:`channels.irc`、`channels.irc.dmPolicy`、`channels.irc.configWrites`、`channels.irc.nickserv.*`。
+- 可选的 `channels.irc.defaultAccount` 会在其匹配某个已配置账号 ID 时覆盖默认账号选择。
+- 完整的 IRC 渠道配置(主机/端口/TLS/频道/允许列表/提及门控)记录在 [IRC](/zh-CN/channels/irc) 中。
-### 多账户(所有渠道)
+### 多账号(所有渠道)
-为每个渠道运行多个账户(每个账户都有自己的 `accountId`):
+为同一渠道运行多个账号(每个账号都有自己的 `accountId`):
```json5
{
@@ -734,18 +735,18 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
}
```
-- 当省略 `accountId` 时,使用 `default`(CLI + 路由)。
-- 环境变量 token 仅适用于**默认**账户。
-- 基础渠道设置会应用到所有账户,除非被每账户配置覆盖。
-- 使用 `bindings[].match.accountId` 将每个账户路由到不同智能体。
-- 如果你通过 `openclaw channels add`(或渠道新手引导)添加了一个非默认账户,而当前仍使用单账户顶层渠道配置,OpenClaw 会先将顶层单账户值中属于账户作用域的内容提升到渠道账户映射中,以确保原始账户继续正常工作。大多数渠道会将其移到 `channels..accounts.default`;Matrix 则可以保留已有的匹配命名/默认目标。
-- 现有仅渠道绑定(无 `accountId`)仍会匹配默认账户;账户作用域绑定仍然是可选的。
-- `openclaw doctor --fix` 也会通过将账户作用域顶层单账户值移动到该渠道所选的提升账户中来修复混合结构。大多数渠道使用 `accounts.default`;Matrix 则可以保留已有的匹配命名/默认目标。
+- 省略 `accountId` 时使用 `default`(CLI + 路由)。
+- 环境变量 token 仅适用于**默认**账号。
+- 基础渠道设置适用于所有账号,除非被账号级覆盖。
+- 使用 `bindings[].match.accountId` 将每个账号路由到不同智能体。
+- 如果你通过 `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)。
-请参阅完整渠道索引:[渠道](/zh-CN/channels)。
+许多扩展渠道配置为 `channels.`,并在各自的渠道页面中记录(例如 Feishu、Matrix、LINE、Nostr、Zalo、Nextcloud Talk、Synology Chat 和 Twitch)。
+完整渠道索引请参见:[Channels](/zh-CN/channels)。
### 群聊提及门控
@@ -753,9 +754,9 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
**提及类型:**
-- **元数据提及**:平台原生 @ 提及。在 WhatsApp self-chat 模式下会被忽略。
-- **文本模式**:位于 `agents.list[].groupChat.mentionPatterns` 的安全正则模式。无效模式和不安全的嵌套重复会被忽略。
-- 只有在可以检测提及时(原生提及或至少一个模式),才会强制执行提及门控。
+- **元数据提及**:平台原生 @ 提及。在 WhatsApp 自聊模式下会被忽略。
+- **文本模式**:位于 `agents.list[].groupChat.mentionPatterns` 中的安全正则模式。无效模式和不安全的嵌套重复会被忽略。
+- 仅在可以进行检测时(原生提及或至少一个模式)才会强制执行提及门控。
```json5
{
@@ -768,7 +769,7 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
}
```
-`messages.groupChat.historyLimit` 设置全局默认值。渠道可以通过 `channels..historyLimit`(或每账户配置)覆盖。设置为 `0` 可禁用。
+`messages.groupChat.historyLimit` 设置全局默认值。渠道可通过 `channels..historyLimit`(或按账号)覆盖。设为 `0` 可禁用。
#### 私信历史限制
@@ -785,13 +786,13 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
}
```
-解析顺序:每私信覆盖 → 提供商默认值 → 不限制(全部保留)。
+解析顺序:按私信覆盖 → 提供商默认值 → 无限制(全部保留)。
支持:`telegram`、`whatsapp`、`discord`、`slack`、`signal`、`imessage`、`msteams`。
-#### self-chat 模式
+#### 自聊模式
-将你自己的号码包含在 `allowFrom` 中可启用 self-chat 模式(忽略原生 @ 提及,只响应文本模式):
+将你自己的号码包含在 `allowFrom` 中即可启用自聊模式(忽略原生 @ 提及,仅响应文本模式):
```json5
{
@@ -817,13 +818,13 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
```json5
{
commands: {
- native: "auto", // 在支持时注册原生命令
- text: true, // 在聊天消息中解析 /commands
- bash: false, // 允许 !(别名:/bash)
+ native: "auto", // register native commands when supported
+ text: true, // parse /commands in chat messages
+ bash: false, // allow ! (alias: /bash)
bashForegroundMs: 2000,
- config: false, // 允许 /config
- debug: false, // 允许 /debug
- restart: false, // 允许 /restart + Gateway 网关重启工具
+ config: false, // allow /config
+ debug: false, // allow /debug
+ restart: false, // allow /restart + gateway restart tool
allowFrom: {
"*": ["user1"],
discord: ["user:123"],
@@ -835,16 +836,16 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
-- 文本命令必须是带前导 `/` 的**独立**消息。
-- `native: "auto"` 会为 Discord/Telegram 打开原生命令,Slack 保持关闭。
-- 可按渠道覆盖:`channels.discord.commands.native`(bool 或 `"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)。
-- 对于多账户渠道,`channels..accounts..configWrites` 也会控制针对该账户的写入(例如 `/allowlist --config --account ` 或 `/config set channels..accounts....`)。
-- `allowFrom` 按提供商生效。设置后,它将成为**唯一**授权来源(渠道允许列表/配对及 `useAccessGroups` 都会被忽略)。
-- `useAccessGroups: false` 允许在未设置 `allowFrom` 时绕过访问组策略来执行命令。
+- 文本命令必须是**独立**消息,并以 `/` 开头。
+- `native: "auto"` 会为 Discord/Telegram 开启原生命令,而让 Slack 保持关闭。
+- 可按渠道覆盖:`channels.discord.commands.native`(布尔值或 `"auto"`)。`false` 会清除先前注册的命令。
+- `channels.telegram.customCommands` 可添加额外的 Telegram 机器人菜单项。
+- `bash: true` 启用主机 shell 的 `! `(别名:`/bash`)。需要 `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` 时绕过访问组策略。
@@ -864,7 +865,7 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.repoRoot`
-可选的仓库根目录,会显示在系统提示的 Runtime 行中。如果未设置,OpenClaw 会从工作区向上遍历自动检测。
+可选的仓库根目录,会显示在系统提示词的 Runtime 行中。若未设置,OpenClaw 会从工作区向上遍历自动检测。
```json5
{
@@ -874,31 +875,30 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.skills`
-为未设置
-`agents.list[].skills` 的智能体提供可选默认 Skills 允许列表。
+对未设置 `agents.list[].skills` 的智能体生效的可选默认 Skills 允许列表。
```json5
{
agents: {
defaults: { skills: ["github", "weather"] },
list: [
- { id: "writer" }, // 继承 github、weather
- { id: "docs", skills: ["docs-search"] }, // 替换默认值
- { id: "locked-down", skills: [] }, // 无 Skills
+ { id: "writer" }, // inherits github, weather
+ { id: "docs", skills: ["docs-search"] }, // replaces defaults
+ { id: "locked-down", skills: [] }, // no skills
],
},
}
```
- 省略 `agents.defaults.skills` 表示默认不限制 Skills。
-- 省略 `agents.list[].skills` 会继承默认值。
+- 省略 `agents.list[].skills` 表示继承默认值。
- 设置 `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
{
@@ -908,9 +908,9 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.contextInjection`
-控制何时将工作区引导文件注入系统提示。默认值:`"always"`。
+控制何时将工作区 bootstrap 文件注入到系统提示词中。默认值:`"always"`。
-- `"continuation-skip"`:安全续接轮次(在 assistant 完成响应之后)会跳过工作区引导的再次注入,以减少提示大小。Heartbeat 运行和压缩后重试仍会重建上下文。
+- `"continuation-skip"`:安全续写轮次(在 assistant 完成回复之后)会跳过工作区 bootstrap 的重新注入,从而减少提示词大小。心跳运行和压缩后的重试仍会重建上下文。
```json5
{
@@ -920,7 +920,7 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.bootstrapMaxChars`
-每个工作区引导文件在截断前允许的最大字符数。默认值:`20000`。
+工作区 bootstrap 文件在截断前的最大字符数。默认值:`20000`。
```json5
{
@@ -930,7 +930,7 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.bootstrapTotalMaxChars`
-所有工作区引导文件注入的总最大字符数。默认值:`150000`。
+所有工作区 bootstrap 文件注入总字符数上限。默认值:`150000`。
```json5
{
@@ -940,12 +940,12 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.bootstrapPromptTruncationWarning`
-控制当 bootstrap 上下文被截断时,向智能体显示的警告文本。
+控制 bootstrap 上下文被截断时,对智能体可见的警告文本。
默认值:`"once"`。
-- `"off"`:绝不将警告文本注入系统提示。
+- `"off"`:绝不在系统提示词中注入警告文本。
- `"once"`:对每个唯一的截断签名仅注入一次警告(推荐)。
-- `"always"`:只要存在截断,每次运行都注入警告。
+- `"always"`:只要存在截断,就在每次运行时注入警告。
```json5
{
@@ -955,10 +955,10 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.imageMaxDimensionPx`
-在调用提供商之前,会话/工具中的图像块允许的最长边最大像素值。
+在调用提供商之前,转录/工具图像块中图像最长边的最大像素尺寸。
默认值:`1200`。
-较低的值通常会减少视觉 token 使用量和请求负载大小,适合截图较多的运行。
+较低的值通常会减少视觉 token 使用量以及请求负载大小,适合截图较多的运行。
较高的值则可保留更多视觉细节。
```json5
@@ -969,7 +969,7 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.userTimezone`
-用于系统提示上下文的时区(不影响消息时间戳)。会回退到主机时区。
+系统提示词上下文使用的时区(不影响消息时间戳)。会回退到主机时区。
```json5
{
@@ -979,7 +979,7 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
### `agents.defaults.timeFormat`
-系统提示中的时间格式。默认值:`auto`(操作系统偏好)。
+系统提示词中的时间格式。默认值:`auto`(操作系统偏好)。
```json5
{
@@ -1017,7 +1017,7 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
primary: "anthropic/claude-opus-4-6",
fallbacks: ["openai/gpt-5.4-mini"],
},
- params: { cacheRetention: "long" }, // 全局默认提供商参数
+ params: { cacheRetention: "long" }, // global default provider params
pdfMaxBytesMb: 10,
pdfMaxPages: 20,
thinkingDefault: "low",
@@ -1032,43 +1032,43 @@ 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。
- - 如果你直接选择某个提供商/模型,也要配置对应的提供商认证/API key(例如 `google/*` 需要 `GEMINI_API_KEY` 或 `GOOGLE_API_KEY`,`openai/*` 需要 `OPENAI_API_KEY`,`fal/*` 需要 `FAL_KEY`)。
- - 如果省略,`image_generate` 仍可推断出一个具备认证的默认提供商。它会先尝试当前默认提供商,然后按提供商 id 顺序尝试其余已注册的图像生成提供商。
-- `musicGenerationModel`:接受字符串(`"provider/model"`)或对象(`{ primary, fallbacks }`)。
- - 由共享音乐生成能力和内置 `music_generate` 工具使用。
- - 典型值:`google/lyria-3-clip-preview`、`google/lyria-3-pro-preview` 或 `minimax/music-2.5+`。
- - 如果省略,`music_generate` 仍可推断出一个具备认证的默认提供商。它会先尝试当前默认提供商,然后按提供商 id 顺序尝试其余已注册的音乐生成提供商。
- - 如果你直接选择某个提供商/模型,也要配置对应的提供商认证/API key。
-- `videoGenerationModel`:接受字符串(`"provider/model"`)或对象(`{ primary, fallbacks }`)。
- - 由共享视频生成能力和内置 `video_generate` 工具使用。
- - 典型值:`qwen/wan2.6-t2v`、`qwen/wan2.6-i2v`、`qwen/wan2.6-r2v`、`qwen/wan2.6-r2v-flash` 或 `qwen/wan2.7-r2v`。
- - 如果省略,`video_generate` 仍可推断出一个具备认证的默认提供商。它会先尝试当前默认提供商,然后按提供商 id 顺序尝试其余已注册的视频生成提供商。
- - 如果你直接选择某个提供商/模型,也要配置对应的提供商认证/API key。
- - 内置的 Qwen 视频生成提供商目前最多支持 1 个输出视频、1 张输入图片、4 个输入视频、10 秒时长,以及提供商级别的 `size`、`aspectRatio`、`resolution`、`audio` 和 `watermark` 选项。
-- `pdfModel`:接受字符串(`"provider/model"`)或对象(`{ primary, fallbacks }`)。
- - 由 `pdf` 工具用于模型路由。
- - 如果省略,PDF 工具会回退到 `imageModel`,再回退到已解析的会话/默认模型。
-- `pdfMaxBytesMb`:当调用时未传入 `maxBytesMb`,`pdf` 工具使用的默认 PDF 大小限制。
+- `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 顺序尝试其余已注册图像生成提供商。
+- `musicGenerationModel`:既可接受字符串(`"provider/model"`),也可接受对象(`{ primary, fallbacks }`)。
+ - 用于共享的音乐生成能力和内置 `music_generate` 工具。
+ - 常见值:`google/lyria-3-clip-preview`、`google/lyria-3-pro-preview` 或 `minimax/music-2.5+`。
+ - 若省略,`music_generate` 仍可推断出一个已认证提供商默认值。它会先尝试当前默认提供商,再按提供商 ID 顺序尝试其余已注册音乐生成提供商。
+ - 如果你直接选择某个 provider/model,也请配置相应的提供商认证/API key。
+- `videoGenerationModel`:既可接受字符串(`"provider/model"`),也可接受对象(`{ primary, fallbacks }`)。
+ - 用于共享的视频生成能力和内置 `video_generate` 工具。
+ - 常见值:`qwen/wan2.6-t2v`、`qwen/wan2.6-i2v`、`qwen/wan2.6-r2v`、`qwen/wan2.6-r2v-flash` 或 `qwen/wan2.7-r2v`。
+ - 若省略,`video_generate` 仍可推断出一个已认证提供商默认值。它会先尝试当前默认提供商,再按提供商 ID 顺序尝试其余已注册视频生成提供商。
+ - 如果你直接选择某个 provider/model,也请配置相应的提供商认证/API key。
+ - 内置的 Qwen 视频生成提供商当前最多支持 1 个输出视频、1 张输入图片、4 个输入视频、10 秒时长,以及提供商级的 `size`、`aspectRatio`、`resolution`、`audio` 和 `watermark` 选项。
+- `pdfModel`:既可接受字符串(`"provider/model"`),也可接受对象(`{ primary, fallbacks }`)。
+ - 用于 `pdf` 工具的模型路由。
+ - 若省略,PDF 工具会先回退到 `imageModel`,再回退到解析后的会话/默认模型。
+- `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`)。如果你省略提供商,OpenClaw 会先尝试别名,再尝试与该精确模型 id 唯一匹配的已配置提供商,最后才回退到已配置默认提供商(这是已弃用的兼容行为,因此建议优先使用显式 `provider/model`)。如果该提供商不再公开已配置默认模型,OpenClaw 会回退到第一个已配置的提供商/模型,而不是继续暴露一个已失效、已移除提供商的默认值。
-- `models`:为 `/model` 配置的模型目录和允许列表。每个条目可包含 `alias`(快捷方式)和 `params`(提供商专用参数,例如 `temperature`、`maxTokens`、`cacheRetention`、`context1m`)。
-- `params`:应用于所有模型的全局默认提供商参数。设置在 `agents.defaults.params`(例如 `{ cacheRetention: "long" }`)。
-- `params` 合并优先级(配置):`agents.defaults.params`(全局基础)会被 `agents.defaults.models["provider/model"].params`(按模型)覆盖,然后 `agents.list[].params`(匹配 agent id)按键覆盖。详见 [Prompt Caching](/zh-CN/reference/prompt-caching)。
-- 会变更这些字段的配置写入器(例如 `/models set`、`/models set-image` 以及后备项添加/删除命令)会保存为规范对象形式,并尽可能保留现有后备列表。
-- `maxConcurrent`:跨会话并行运行的最大智能体数量(每个会话本身仍是串行的)。默认:4。
+- `verboseDefault`:智能体默认详细级别。可选值:`"off"`、`"on"`、`"full"`。默认值:`"off"`。
+- `elevatedDefault`:智能体默认 elevated 输出级别。可选值:`"off"`、`"on"`、`"ask"`、`"full"`。默认值:`"on"`。
+- `model.primary`:格式为 `provider/model`(例如 `openai/gpt-5.4`)。如果省略 provider,OpenClaw 会先尝试别名,再尝试与该精确 model id 唯一匹配的已配置 provider,最后才回退到已配置默认 provider(这是已弃用的兼容行为,因此建议显式使用 `provider/model`)。如果该 provider 不再暴露已配置的默认模型,OpenClaw 会回退到第一个已配置 provider/model,而不是继续使用陈旧的已移除 provider 默认值。
+- `models`:已配置的模型目录和 `/model` 的允许列表。每个条目都可以包含 `alias`(快捷方式)和 `params`(提供商特定参数,例如 `temperature`、`maxTokens`、`cacheRetention`、`context1m`)。
+- `params`:应用于所有模型的全局默认提供商参数。设置位置为 `agents.defaults.params`(例如 `{ cacheRetention: "long" }`)。
+- `params` 合并优先级(配置):`agents.defaults.params`(全局基础)会被 `agents.defaults.models["provider/model"].params`(按模型)覆盖,然后 `agents.list[].params`(匹配的智能体 id)再按键覆盖。详情见 [Prompt Caching](/zh-CN/reference/prompt-caching)。
+- 修改这些字段的配置写入器(例如 `/models set`、`/models set-image` 以及 fallback add/remove 命令)会保存为规范对象形式,并在可能时保留现有回退列表。
+- `maxConcurrent`:跨会话并行智能体运行的最大数量(每个会话内部仍串行)。默认值:4。
-**内置别名简写**(仅当模型位于 `agents.defaults.models` 中时适用):
+**内置别名简写**(仅当模型位于 `agents.defaults.models` 中时生效):
| 别名 | 模型 |
| ------------------- | -------------------------------------- |
@@ -1083,13 +1083,13 @@ IRC 由扩展支持,在 `channels.irc` 下配置。
你自己配置的别名始终优先于默认值。
-Z.AI GLM-4.x 模型会自动启用 thinking 模式,除非你设置了 `--thinking off` 或自行定义 `agents.defaults.models["zai/"].params.thinking`。
-Z.AI 模型默认启用 `tool_stream` 用于工具调用流式传输。将 `agents.defaults.models["zai/"].params.tool_stream` 设为 `false` 可禁用。
-Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用 `adaptive` thinking。
+Z.AI GLM-4.x 模型会自动启用 thinking mode,除非你设置 `--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 level 时,默认使用 `adaptive` thinking。
### `agents.defaults.cliBackends`
-为纯文本后备运行(无工具调用)提供可选 CLI 后端。在 API 提供商失败时可作为备份。
+用于纯文本回退运行(无工具调用)的可选 CLI 后端。当 API 提供商失败时,这可作为备份。
```json5
{
@@ -1118,27 +1118,27 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
```
- CLI 后端以文本为主;工具始终禁用。
-- 当设置了 `sessionArg` 时支持会话。
+- 设置了 `sessionArg` 时支持会话。
- 当 `imageArg` 接受文件路径时支持图像透传。
### `agents.defaults.heartbeat`
-定期心跳运行。
+周期性心跳运行。
```json5
{
agents: {
defaults: {
heartbeat: {
- every: "30m", // 0m 表示禁用
+ every: "30m", // 0m disables
model: "openai/gpt-5.4-mini",
includeReasoning: false,
- lightContext: false, // 默认:false;true 仅保留工作区引导文件中的 HEARTBEAT.md
- isolatedSession: false, // 默认:false;true 在全新会话中运行每次心跳(无对话历史)
+ lightContext: false, // default: false; true keeps only HEARTBEAT.md from workspace bootstrap files
+ isolatedSession: false, // default: false; true runs each heartbeat in a fresh session (no conversation history)
session: "main",
to: "+15555550123",
- directPolicy: "allow", // allow(默认)| block
- target: "none", // 默认:none | 可选:last | whatsapp | telegram | discord | ...
+ directPolicy: "allow", // allow (default) | block
+ target: "none", // default: none | options: last | whatsapp | telegram | discord | ...
prompt: "Read HEARTBEAT.md if it exists...",
ackMaxChars: 300,
suppressToolErrorWarnings: false,
@@ -1148,13 +1148,13 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
}
```
-- `every`:时长字符串(ms/s/m/h)。默认:`30m`(API key 认证)或 `1h`(OAuth 认证)。设为 `0m` 可禁用。
+- `every`:时长字符串(ms/s/m/h)。默认值:`30m`(API key 认证)或 `1h`(OAuth 认证)。设为 `0m` 可禁用。
- `suppressToolErrorWarnings`:为 true 时,在心跳运行期间抑制工具错误警告负载。
-- `directPolicy`:直接/私信投递策略。`allow`(默认)允许直接目标投递。`block` 会阻止直接目标投递,并发出 `reason=dm-blocked`。
-- `lightContext`:为 true 时,心跳运行使用轻量 bootstrap 上下文,并且只保留工作区引导文件中的 `HEARTBEAT.md`。
-- `isolatedSession`:为 true 时,每次心跳都在没有先前对话历史的新会话中运行。与 cron `sessionTarget: "isolated"` 使用相同的隔离模式。可将每次心跳的 token 成本从约 100K 降到约 2-5K。
-- 每智能体:设置 `agents.list[].heartbeat`。当任意智能体定义了 `heartbeat` 时,**只有这些智能体**会运行心跳。
-- 心跳会执行完整的智能体轮次——间隔越短,消耗的 token 越多。
+- `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`
@@ -1164,14 +1164,14 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
defaults: {
compaction: {
mode: "safeguard", // default | safeguard
- provider: "my-provider", // 已注册 compaction 提供商插件的 id(可选)
+ provider: "my-provider", // id of a registered compaction provider plugin (optional)
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.", // used when identifierPolicy=custom
+ postCompactionSections: ["Session Startup", "Red Lines"], // [] disables reinjection
+ model: "openrouter/anthropic/claude-sonnet-4-6", // optional compaction-only model override
+ notifyUser: true, // send a brief notice when compaction starts (default: false)
memoryFlush: {
enabled: true,
softThresholdTokens: 6000,
@@ -1184,19 +1184,19 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
}
```
-- `mode`:`default` 或 `safeguard`(对长历史执行分块摘要)。参见 [Compaction](/zh-CN/concepts/compaction)。
-- `provider`:已注册 compaction 提供商插件的 id。设置后,会调用该提供商的 `summarize()`,而不是使用内置 LLM 摘要。失败时会回退到内置实现。设置提供商会强制 `mode: "safeguard"`。参见 [Compaction](/zh-CN/concepts/compaction)。
-- `timeoutSeconds`:OpenClaw 在中止单次 compaction 操作前允许的最大秒数。默认:`900`。
-- `identifierPolicy`:`strict`(默认)、`off` 或 `custom`。`strict` 会在 compaction 摘要时预置内建的不透明标识符保留指导。
-- `identifierInstructions`:当 `identifierPolicy=custom` 时使用的可选自定义标识符保留文本。
-- `postCompactionSections`:compaction 后可选重新注入的 AGENTS.md H2/H3 章节名称。默认值为 `["Session Startup", "Red Lines"]`;设为 `[]` 可禁用重新注入。当未设置,或显式设为该默认对时,较旧的 `Every Session`/`Safety` 标题也会作为兼容回退被接受。
-- `model`:仅用于 compaction 摘要的可选 `provider/model-id` 覆盖。用于让主会话继续使用一个模型,而 compaction 摘要改用另一个模型;未设置时,compaction 使用会话的主模型。
-- `notifyUser`:为 `true` 时,在 compaction 开始时向用户发送简短通知(例如 “Compacting context...”)。默认禁用,以保持 compaction 静默。
-- `memoryFlush`:在自动 compaction 前执行静默智能体轮次,用于存储持久记忆。工作区只读时会跳过。
+- `mode`:`default` 或 `safeguard`(用于长历史的分块摘要)。见 [Compaction](/zh-CN/concepts/compaction)。
+- `provider`:已注册 compaction provider 插件的 id。设置后,将调用该提供商的 `summarize()`,而不是内置的 LLM 摘要。失败时会回退到内置实现。设置 provider 会强制 `mode: "safeguard"`。见 [Compaction](/zh-CN/concepts/compaction)。
+- `timeoutSeconds`:OpenClaw 中止单次 compaction 操作前允许的最大秒数。默认值:`900`。
+- `identifierPolicy`:`strict`(默认)、`off` 或 `custom`。`strict` 会在 compaction 摘要过程中预置内建的 opaque identifier 保留指导。
+- `identifierInstructions`:当 `identifierPolicy=custom` 时使用的可选自定义 identifier 保留说明。
+- `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
{
@@ -1204,7 +1204,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
defaults: {
contextPruning: {
mode: "cache-ttl", // off | cache-ttl
- ttl: "1h", // 时长(ms/s/m/h),默认单位:分钟
+ ttl: "1h", // duration (ms/s/m/h), default unit: minutes
keepLastAssistants: 3,
softTrimRatio: 0.3,
hardClearRatio: 0.5,
@@ -1218,25 +1218,25 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
}
```
-
+
- `mode: "cache-ttl"` 启用修剪流程。
-- `ttl` 控制多久后才能再次运行修剪(以上一次缓存触达为准)。
-- 修剪会先对过大的工具结果做软裁剪,必要时再对更旧的工具结果做硬清空。
+- `ttl` 控制下次允许再次执行修剪的时间(自上次缓存触达之后)。
+- 修剪会先对过大的工具结果做软修剪,如仍有需要,再对更旧的工具结果做硬清除。
-**软裁剪**保留开头和结尾,并在中间插入 `...`。
+**软修剪**会保留开头和结尾,并在中间插入 `...`。
-**硬清空**会用占位符替换整个工具结果。
+**硬清除**会用占位符替换整个工具结果。
说明:
-- 图像块永远不会被裁剪/清空。
-- 各种比例基于字符数(近似),不是精确 token 数。
-- 如果 assistant 消息少于 `keepLastAssistants`,会跳过修剪。
+- 图像块绝不会被修剪/清除。
+- 比例基于字符数(近似),而非精确 token 数。
+- 若 assistant 消息少于 `keepLastAssistants` 条,则跳过修剪。
-行为细节参见 [会话修剪](/zh-CN/concepts/session-pruning)。
+行为细节见 [Session Pruning](/zh-CN/concepts/session-pruning)。
### 分块流式传输
@@ -1248,17 +1248,17 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
blockStreamingBreak: "text_end", // text_end | message_end
blockStreamingChunk: { minChars: 800, maxChars: 1200 },
blockStreamingCoalesce: { idleMs: 1000 },
- humanDelay: { mode: "natural" }, // off | natural | custom(使用 minMs/maxMs)
+ humanDelay: { mode: "natural" }, // off | natural | custom (use minMs/maxMs)
},
},
}
```
-- 非 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–2500 ms。按智能体覆盖:`agents.list[].humanDelay`。
-行为和分块细节参见 [流式传输](/zh-CN/concepts/streaming)。
+有关行为和分块细节,见 [Streaming](/zh-CN/concepts/streaming)。
### 输入状态指示器
@@ -1273,16 +1273,16 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
}
```
-- 默认值:私聊/提及时为 `instant`,未提及的群聊中为 `message`。
-- 每会话覆盖:`session.typingMode`、`session.typingIntervalSeconds`。
+- 默认值:在私聊/被提及时使用 `instant`,在未被提及的群聊中使用 `message`。
+- 按会话覆盖:`session.typingMode`、`session.typingIntervalSeconds`。
-参见 [输入状态指示器](/zh-CN/concepts/typing-indicators)。
+见 [Typing Indicators](/zh-CN/concepts/typing-indicators)。
### `agents.defaults.sandbox`
-为嵌入式智能体启用可选沙箱隔离。完整指南参见 [沙箱隔离](/zh-CN/gateway/sandboxing)。
+内嵌智能体的可选沙箱隔离。完整指南见 [Sandboxing](/zh-CN/gateway/sandboxing)。
```json5
{
@@ -1328,7 +1328,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
identityFile: "~/.ssh/id_ed25519",
certificateFile: "~/.ssh/id_ed25519-cert.pub",
knownHostsFile: "~/.ssh/known_hosts",
- // 也支持 SecretRefs / 内联内容:
+ // SecretRefs / inline contents also supported:
// 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" },
@@ -1385,16 +1385,16 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
- `ssh`:通用 SSH 远程运行时
- `openshell`:OpenShell 运行时
-当选择 `backend: "openshell"` 时,运行时专用设置会移到
+选择 `backend: "openshell"` 时,运行时特定设置会移动到
`plugins.entries.openshell.config`。
**SSH 后端配置:**
-- `target`:`user@host[:port]` 形式的 SSH 目标
+- `target`:格式为 `user@host[:port]` 的 SSH 目标
- `command`:SSH 客户端命令(默认:`ssh`)
-- `workspaceRoot`:用于每作用域工作区的远程绝对根路径
+- `workspaceRoot`:用于按作用域工作区的远程绝对根目录
- `identityFile` / `certificateFile` / `knownHostsFile`:传递给 OpenSSH 的现有本地文件
-- `identityData` / `certificateData` / `knownHostsData`:内联内容或 SecretRef,OpenClaw 会在运行时将其物化为临时文件
+- `identityData` / `certificateData` / `knownHostsData`:内联内容或 SecretRef,OpenClaw 会在运行时将其实体化为临时文件
- `strictHostKeyChecking` / `updateHostKeys`:OpenSSH 主机密钥策略开关
**SSH 认证优先级:**
@@ -1402,19 +1402,19 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
- `identityData` 优先于 `identityFile`
- `certificateData` 优先于 `certificateFile`
- `knownHostsData` 优先于 `knownHostsFile`
-- 基于 SecretRef 的 `*Data` 值会在沙箱会话启动前,从活跃 secrets 运行时快照中解析
+- 由 SecretRef 支持的 `*Data` 值会在沙箱会话启动前,从活动 secrets 运行时快照中解析
**SSH 后端行为:**
-- 创建或重建后只会为远程工作区做一次初始化
-- 之后保持远程 SSH 工作区为规范副本
+- 在创建或重建后对远程工作区执行一次初始化
+- 此后保持远程 SSH 工作区为规范副本
- 通过 SSH 路由 `exec`、文件工具和媒体路径
-- 不会自动将远程变更同步回主机
+- 不会自动将远程更改同步回主机
- 不支持沙箱浏览器容器
**工作区访问:**
-- `none`:位于 `~/.openclaw/sandboxes` 下的每作用域沙箱工作区
+- `none`:在 `~/.openclaw/sandboxes` 下使用按作用域分配的沙箱工作区
- `ro`:沙箱工作区位于 `/workspace`,智能体工作区以只读方式挂载到 `/agent`
- `rw`:智能体工作区以读写方式挂载到 `/workspace`
@@ -1422,7 +1422,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
- `session`:每会话一个容器 + 工作区
- `agent`:每智能体一个容器 + 工作区(默认)
-- `shared`:共享容器和工作区(无跨会话隔离)
+- `shared`:共享容器和工作区(不提供跨会话隔离)
**OpenShell 插件配置:**
@@ -1437,10 +1437,10 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
from: "openclaw",
remoteWorkspaceDir: "/sandbox",
remoteAgentWorkspaceDir: "/agent",
- gateway: "lab", // 可选
- gatewayEndpoint: "https://lab.example", // 可选
- policy: "strict", // 可选 OpenShell policy id
- providers: ["openai"], // 可选
+ gateway: "lab", // optional
+ gatewayEndpoint: "https://lab.example", // optional
+ policy: "strict", // optional OpenShell policy id
+ providers: ["openai"], // optional
autoProviders: true,
timeoutSeconds: 120,
},
@@ -1452,30 +1452,30 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时,默认使用
**OpenShell 模式:**
-- `mirror`:在 exec 前将本地内容同步到远端,在 exec 后再同步回来;本地工作区保持为规范副本
-- `remote`:在创建沙箱时只进行一次本地到远端的初始化,之后保持远端工作区为规范副本
+- `mirror`:执行前从本地播种到远程,执行后再同步回来;本地工作区保持为规范副本
+- `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`(紧急模式)。
+**容器默认使用 `network: "none"`**——如果智能体需要出站访问,请设为 `"bridge"`(或自定义 bridge 网络)。
+`"host"` 会被阻止。默认情况下 `"container:"` 也会被阻止,除非你显式设置
+`sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true`(紧急开关)。
**入站附件** 会被暂存到活动工作区中的 `media/inbound/*`。
-**`docker.binds`** 会挂载额外的主机目录;全局和每智能体的 binds 会合并。
+**`docker.binds`** 会挂载额外的主机目录;全局和按智能体的绑定会合并。
-**沙箱隔离浏览器**(`sandbox.browser.enabled`):在容器中运行 Chromium + CDP。noVNC URL 会注入系统提示。不需要在 `openclaw.json` 中启用 `browser.enabled`。
-noVNC 观察者访问默认使用 VNC 认证,OpenClaw 会发出短期有效的 token URL(而不是在共享 URL 中公开密码)。
+**沙箱隔离浏览器**(`sandbox.browser.enabled`):在容器中运行 Chromium + CDP。noVNC URL 会注入到系统提示词中。不需要在 `openclaw.json` 中启用 `browser.enabled`。
+默认情况下,noVNC 观察者访问使用 VNC 认证,OpenClaw 会发出短时有效 token URL(而不是在共享 URL 中暴露密码)。
- `allowHostControl: false`(默认)会阻止沙箱隔离会话以主机浏览器为目标。
-- `network` 默认是 `openclaw-sandbox-browser`(专用桥接网络)。仅在你明确想要全局桥接连通性时,才设为 `bridge`。
-- `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`
@@ -1493,30 +1493,30 @@ noVNC 观察者访问默认使用 VNC 认证,OpenClaw 会发出短期有效的
- `--no-zygote`
- `--metrics-recording-only`
- `--disable-extensions`(默认启用)
- - `--disable-3d-apis`、`--disable-software-rasterizer` 和 `--disable-gpu` 默认启用;
- 如果 WebGL/3D 使用场景需要它们,可通过
+ - `--disable-3d-apis`、`--disable-software-rasterizer` 和 `--disable-gpu`
+ 默认启用;如果 WebGL/3D 使用场景需要,可通过
`OPENCLAW_BROWSER_DISABLE_GRAPHICS_FLAGS=0` 禁用。
- - `OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0` 会重新启用扩展,如果你的工作流
- 依赖扩展。
+ - `OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0` 会重新启用扩展,
+ 如果你的工作流依赖它们。
- `--renderer-process-limit=2` 可通过
- `OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=` 修改;设置为 `0` 可使用 Chromium 的
+ `OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=` 更改;设为 `0` 可使用 Chromium 的
默认进程限制。
- - 当启用 `noSandbox` 时,还会加上 `--no-sandbox` 和 `--disable-setuid-sandbox`。
- - 这些默认值是容器镜像基线;如需更改容器默认行为,请使用带自定义
+ - 当启用 `noSandbox` 时,还会附加 `--no-sandbox` 和 `--disable-setuid-sandbox`。
+ - 这些默认值是容器镜像基线;如需更改容器默认值,请使用带自定义
entrypoint 的自定义浏览器镜像。
-浏览器沙箱隔离和 `sandbox.docker.binds` 目前仅支持 Docker。
+浏览器沙箱隔离和 `sandbox.docker.binds` 当前仅支持 Docker。
构建镜像:
```bash
-scripts/sandbox-setup.sh # 主沙箱镜像
-scripts/sandbox-browser-setup.sh # 可选浏览器镜像
+scripts/sandbox-setup.sh # main sandbox image
+scripts/sandbox-browser-setup.sh # optional browser image
```
-### `agents.list`(每智能体覆盖)
+### `agents.list`(按智能体覆盖)
```json5
{
@@ -1528,12 +1528,12 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像
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, // 每智能体快速模式覆盖
- params: { cacheRetention: "none" }, // 按键覆盖匹配 defaults.models params
- skills: ["docs-search"], // 设置时会替换 agents.defaults.skills
+ model: "anthropic/claude-opus-4-6", // or { primary, fallbacks }
+ thinkingDefault: "high", // per-agent thinking level override
+ reasoningDefault: "on", // per-agent reasoning visibility override
+ fastModeDefault: false, // per-agent fast mode override
+ params: { cacheRetention: "none" }, // overrides matching defaults.models params by key
+ skills: ["docs-search"], // replaces agents.defaults.skills when set
identity: {
name: "Samantha",
theme: "helpful sloth",
@@ -1565,25 +1565,25 @@ 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`:可选的每智能体默认快速模式(`true | false`)。当未设置每消息或会话快速模式覆盖时应用。
-- `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` 会拒绝运行目标为非沙箱隔离状态的请求。
+- `default`:设置多个时,以第一个为准(会记录警告)。若都未设置,则列表第一项为默认。
+- `model`:字符串形式仅覆盖 `primary`;对象形式 `{ primary, fallbacks }` 同时覆盖二者(`[]` 会禁用全局 fallbacks)。仅覆盖 `primary` 的 cron 作业仍会继承默认 fallbacks,除非你设置 `fallbacks: []`。
+- `params`:按智能体的流参数,会合并到 `agents.defaults.models` 中选定模型条目之上。用于像 `cacheRetention`、`temperature` 或 `maxTokens` 这类智能体特定覆盖,而无需复制整个模型目录。
+- `skills`:可选的按智能体 Skills 允许列表。省略时,若设置了 `agents.defaults.skills`,该智能体将继承之;显式列表会替换默认值而非合并,`[]` 表示无 Skills。
+- `thinkingDefault`:可选的按智能体默认 thinking level(`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)。
---
## 多智能体路由
-在一个 Gateway 网关中运行多个隔离智能体。参见 [Multi-Agent](/zh-CN/concepts/multi-agent)。
+在一个 Gateway 网关内运行多个彼此隔离的智能体。见 [Multi-Agent](/zh-CN/concepts/multi-agent)。
```json5
{
@@ -1602,27 +1602,27 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像
### 绑定匹配字段
-- `type`(可选):普通路由用 `route`(缺失时默认 route),持久 ACP 对话绑定用 `acp`
+- `type`(可选):普通路由使用 `route`(缺失时默认 route),持久 ACP 对话绑定使用 `acp`
- `match.channel`(必填)
-- `match.accountId`(可选;`*` = 任意账户;省略 = 默认账户)
+- `match.accountId`(可选;`*` = 任意账号;省略 = 默认账号)
- `match.peer`(可选;`{ kind: direct|group|channel, id }`)
-- `match.guildId` / `match.teamId`(可选;渠道专用)
+- `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: "*"`(渠道级)
+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 绑定层级顺序。
-### 每智能体访问配置
+### 按智能体访问配置
@@ -1717,7 +1717,7 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像
-优先级细节参见 [多智能体沙箱隔离和工具](/zh-CN/tools/multi-agent-sandbox-tools)。
+优先级细节见 [Multi-Agent Sandbox & Tools](/zh-CN/tools/multi-agent-sandbox-tools)。
---
@@ -1743,22 +1743,22 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像
},
resetTriggers: ["/new", "/reset"],
store: "~/.openclaw/agents/{agentId}/sessions/sessions.json",
- parentForkMaxTokens: 100000, // 超过该 token 数则跳过父线程 fork(0 表示禁用)
+ parentForkMaxTokens: 100000, // skip parent-thread fork above this token count (0 disables)
maintenance: {
mode: "warn", // warn | enforce
pruneAfter: "30d",
maxEntries: 500,
rotateBytes: "10mb",
- resetArchiveRetention: "30d", // 时长或 false
- maxDiskBytes: "500mb", // 可选硬预算
- highWaterBytes: "400mb", // 可选清理目标
+ resetArchiveRetention: "30d", // duration or false
+ maxDiskBytes: "500mb", // optional hard budget
+ highWaterBytes: "400mb", // optional cleanup target
},
threadBindings: {
enabled: true,
- idleHours: 24, // 默认无活动自动取消聚焦时长(小时,`0` 表示禁用)
- maxAgeHours: 0, // 默认硬性最大生命周期(小时,`0` 表示禁用)
+ idleHours: 24, // default inactivity auto-unfocus in hours (`0` disables)
+ maxAgeHours: 0, // default hard max age in hours (`0` disables)
},
- mainKey: "main", // 旧版(运行时始终使用 "main")
+ mainKey: "main", // legacy (runtime always uses "main")
agentToAgent: { maxPingPongTurns: 5 },
sendPolicy: {
rules: [{ action: "deny", match: { channel: "discord", chatType: "group" } }],
@@ -1771,34 +1771,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 映射到带提供商前缀的 peer,用于跨渠道共享会话。
-- **`reset`**:主重置策略。`daily` 在本地时间 `atHour` 重置;`idle` 在 `idleMinutes` 后重置。当两者都配置时,哪个先到期就先触发。
-- **`resetByType`**:按类型覆盖(`direct`、`group`、`thread`)。旧版 `dm` 接受为 `direct` 的别名。
-- **`parentForkMaxTokens`**:创建分叉线程会话时允许的父会话 `totalTokens` 最大值(默认 `100000`)。
- - 如果父会话 `totalTokens` 高于此值,OpenClaw 会启动一个新的线程会话,而不是继承父会话历史记录。
- - 设为 `0` 可禁用此保护,并始终允许父会话分叉。
-- **`mainKey`**:旧字段。运行时现在始终使用 `"main"` 作为主私聊桶。
-- **`agentToAgent.maxPingPongTurns`**:智能体到智能体交换期间,智能体之间允许的最大往返回复轮次(整数,范围:`0`–`5`)。`0` 会禁用 ping-pong 链式交互。
-- **`sendPolicy`**:按 `channel`、`chatType`(`direct|group|channel`,旧版 `dm` 为别名)、`keyPrefix` 或 `rawKeyPrefix` 匹配。第一个 deny 生效。
+ - `per-account-channel-peer`:按账号 + 渠道 + 发送者隔离(推荐用于多账号)。
+- **`identityLinks`**:将规范 id 映射到带 provider 前缀的对端,用于跨渠道共享会话。
+- **`reset`**:主重置策略。`daily` 会在本地时间 `atHour` 重置;`idle` 会在 `idleMinutes` 后重置。若两者都配置,谁先到期就以谁为准。
+- **`resetByType`**:按类型覆盖(`direct`、`group`、`thread`)。旧版 `dm` 可作为 `direct` 的别名。
+- **`parentForkMaxTokens`**:创建分叉线程会话时,允许父会话使用的最大 `totalTokens`(默认 `100000`)。
+ - 如果父会话的 `totalTokens` 高于此值,OpenClaw 会启动全新的线程会话,而不是继承父级转录历史。
+ - 设为 `0` 可禁用此保护,并始终允许父级分叉。
+- **`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`)。
+ - `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`:主默认开关(提供商可覆盖;Discord 使用 `channels.discord.threadBindings.enabled`)
- - `idleHours`:默认按小时计算的无活动自动取消聚焦时长(`0` 表示禁用;提供商可覆盖)
- - `maxAgeHours`:默认按小时计算的硬性最大生命周期(`0` 表示禁用;提供商可覆盖)
+ - `enabled`:总开关默认值(提供商可覆盖;Discord 使用 `channels.discord.threadBindings.enabled`)
+ - `idleHours`:按小时的默认无活动自动取消聚焦时间(`0` 表示禁用;提供商可覆盖)
+ - `maxAgeHours`:按小时的默认硬性最大时长(`0` 表示禁用;提供商可覆盖)
@@ -1809,7 +1809,7 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像
```json5
{
messages: {
- responsePrefix: "🦞", // 或 "auto"
+ responsePrefix: "🦞", // or "auto"
ackReaction: "👀",
ackReactionScope: "group-mentions", // group-mentions | group-all | direct | all
removeAckAfterReply: false,
@@ -1824,7 +1824,7 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像
},
},
inbound: {
- debounceMs: 2000, // 0 表示禁用
+ debounceMs: 2000, // 0 disables
byChannel: {
whatsapp: 5000,
slack: 1500,
@@ -1836,36 +1836,36 @@ 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}` | 智能体身份名称 | (与 `"auto"` 相同) |
变量不区分大小写。`{think}` 是 `{thinkingLevel}` 的别名。
### 确认反应
-- 默认为当前活跃智能体的 `identity.emoji`,否则为 `"👀"`。设置 `""` 可禁用。
-- 每渠道覆盖:`channels..ackReaction`、`channels..accounts..ackReaction`。
-- 解析顺序:账户 → 渠道 → `messages.ackReaction` → identity 后备。
+- 默认为活动智能体的 `identity.emoji`,否则为 `"👀"`。设为 `""` 可禁用。
+- 按渠道覆盖:`channels..ackReaction`、`channels..accounts..ackReaction`。
+- 解析顺序:账号 → 渠道 → `messages.ackReaction` → identity 回退。
- 作用域:`group-mentions`(默认)、`group-all`、`direct`、`all`。
-- `removeAckAfterReply`:在 Slack、Discord 和 Telegram 上回复后移除确认反应。
-- `messages.statusReactions.enabled`:在 Slack、Discord 和 Telegram 上启用生命周期状态反应。
- 在 Slack 和 Discord 上,未设置时,只要确认反应处于激活状态,就会保持状态反应启用。
+- `removeAckAfterReply`:在 Slack、Discord 和 Telegram 中,回复后移除确认反应。
+- `messages.statusReactions.enabled`:在 Slack、Discord 和 Telegram 中启用生命周期状态反应。
+ 在 Slack 和 Discord 上,未设置时,如果确认反应处于活动状态,则状态反应保持启用。
在 Telegram 上,需要显式设为 `true` 才会启用生命周期状态反应。
-### 入站防抖
+### 入站去抖
-将同一发送者快速发送的纯文本消息批处理为一次智能体轮次。媒体/附件会立即刷新。控制命令会绕过防抖。
+将来自同一发送者的快速连续纯文本消息批处理为单个智能体轮次。媒体/附件会立即触发。控制命令会绕过去抖。
### TTS(文本转语音)
@@ -1909,17 +1909,17 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像
```
- `auto` 控制自动 TTS。`/tts off|always|inbound|tagged` 会按会话覆盖。
-- `summaryModel` 会覆盖 `agents.defaults.model.primary` 用于自动摘要。
-- `modelOverrides` 默认启用;`modelOverrides.allowProvider` 默认为 `false`(需要显式启用)。
+- `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-compatible TTS 服务器,并放宽 model/voice 校验。
+- `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 mode 的默认值(macOS/iOS/Android)。
```json5
{
@@ -1944,12 +1944,12 @@ Talk 模式(macOS/iOS/Android)的默认值。
```
- 当配置了多个 Talk 提供商时,`talk.provider` 必须匹配 `talk.providers` 中的某个键。
-- 旧版扁平 Talk 键(`talk.voiceId`、`talk.voiceAliases`、`talk.modelId`、`talk.outputFormat`、`talk.apiKey`)仅用于兼容,会自动迁移到 `talk.providers.`。
+- 旧版扁平 Talk 键(`talk.voiceId`、`talk.voiceAliases`、`talk.modelId`、`talk.outputFormat`、`talk.apiKey`)仅用于兼容,并会自动迁移到 `talk.providers.`。
- Voice ID 会回退到 `ELEVENLABS_VOICE_ID` 或 `SAG_VOICE_ID`。
- `providers.*.apiKey` 接受明文字符串或 SecretRef 对象。
-- 只有在未配置 Talk API key 时,才会使用 `ELEVENLABS_API_KEY` 回退。
-- `providers.*.voiceAliases` 让 Talk 指令可以使用友好的名称。
-- `silenceTimeoutMs` 控制 Talk 模式在用户静默后等待多久才发送转录文本。未设置时将保留平台默认暂停窗口(`macOS 和 Android 为 700 ms,iOS 为 900 ms`)。
+- 仅当未配置 Talk API key 时,才会回退到 `ELEVENLABS_API_KEY`。
+- `providers.*.voiceAliases` 允许 Talk 指令使用友好名称。
+- `silenceTimeoutMs` 控制 Talk mode 在用户静音后等待多久才发送转录。未设置时保留平台默认暂停窗口(`macOS 和 Android 为 700 ms,iOS 为 900 ms`)。
---
@@ -1957,37 +1957,37 @@ Talk 模式(macOS/iOS/Android)的默认值。
### 工具配置
-`tools.profile` 会先设置一个基础允许列表,然后再应用 `tools.allow`/`tools.deny`:
+`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 沙箱已关闭也会应用。
+全局工具允许/拒绝策略(拒绝优先)。不区分大小写,支持 `*` 通配符。即使 Docker 沙箱关闭也会生效。
```json5
{
@@ -1997,7 +1997,7 @@ Talk 模式(macOS/iOS/Android)的默认值。
### `tools.byProvider`
-进一步限制特定提供商或模型可用的工具。顺序:基础配置 → 提供商配置 → allow/deny。
+进一步针对特定 provider 或 model 限制工具。顺序:基础 profile → provider profile → allow/deny。
```json5
{
@@ -2029,9 +2029,9 @@ Talk 模式(macOS/iOS/Android)的默认值。
}
```
-- 每智能体覆盖(`agents.list[].tools.elevated`)只能进一步收紧限制。
+- 按智能体覆盖(`agents.list[].tools.elevated`)只能进一步收紧。
- `/elevated on|off|ask|full` 会按会话存储状态;内联指令仅作用于单条消息。
-- Elevated `exec` 会绕过沙箱隔离,并使用已配置的逃逸路径(默认是 `gateway`,或当 exec 目标为 `node` 时使用 `node`)。
+- Elevated `exec` 会绕过沙箱隔离,并使用已配置的逃逸路径(默认 `gateway`,或当 exec 目标为 `node` 时使用 `node`)。
### `tools.exec`
@@ -2055,8 +2055,8 @@ Talk 模式(macOS/iOS/Android)的默认值。
### `tools.loopDetection`
-工具循环安全检查默认**关闭**。设置 `enabled: true` 可启用检测。
-可以在全局 `tools.loopDetection` 中定义设置,并在每智能体 `agents.list[].tools.loopDetection` 中覆盖。
+工具循环安全检查**默认禁用**。设为 `enabled: true` 可启用检测。
+设置可在 `tools.loopDetection` 中全局定义,也可在 `agents.list[].tools.loopDetection` 中按智能体覆盖。
```json5
{
@@ -2077,13 +2077,13 @@ Talk 模式(macOS/iOS/Android)的默认值。
}
```
-- `historySize`:为循环分析保留的最大工具调用历史长度。
-- `warningThreshold`:对重复无进展模式发出警告的阈值。
-- `criticalThreshold`:阻止严重循环的更高重复阈值。
+- `historySize`:为循环分析保留的最大工具调用历史。
+- `warningThreshold`:用于发出警告的重复无进展模式阈值。
+- `criticalThreshold`:用于阻止严重循环的更高重复阈值。
- `globalCircuitBreakerThreshold`:任何无进展运行的硬停止阈值。
- `detectors.genericRepeat`:对重复的同工具/同参数调用发出警告。
-- `detectors.knownPollNoProgress`:对已知轮询工具(`process.poll`、`command_status` 等)的无进展轮询发出警告/阻止。
-- `detectors.pingPong`:对交替出现的无进展成对模式发出警告/阻止。
+- `detectors.knownPollNoProgress`:对已知轮询工具(`process.poll`、`command_status` 等)进行警告/阻止。
+- `detectors.pingPong`:对交替出现的双向无进展模式进行警告/阻止。
- 如果 `warningThreshold >= criticalThreshold` 或 `criticalThreshold >= globalCircuitBreakerThreshold`,校验会失败。
### `tools.web`
@@ -2094,14 +2094,14 @@ Talk 模式(macOS/iOS/Android)的默认值。
web: {
search: {
enabled: true,
- apiKey: "brave_api_key", // 或 BRAVE_API_KEY 环境变量
+ apiKey: "brave_api_key", // or BRAVE_API_KEY env
maxResults: 5,
timeoutSeconds: 30,
cacheTtlMinutes: 15,
},
fetch: {
enabled: true,
- provider: "firecrawl", // 可选;省略表示自动检测
+ provider: "firecrawl", // optional; omit for auto-detect
maxChars: 50000,
maxCharsCap: 50000,
maxResponseBytes: 2000000,
@@ -2126,7 +2126,7 @@ Talk 模式(macOS/iOS/Android)的默认值。
media: {
concurrency: 2,
asyncCompletion: {
- directSend: false, // 显式启用:将完成的异步音乐/视频直接发送到渠道
+ directSend: false, // opt-in: send finished async music/video directly to the channel
},
audio: {
enabled: true,
@@ -2166,7 +2166,7 @@ Talk 模式(macOS/iOS/Android)的默认值。
**通用字段:**
- `capabilities`:可选列表(`image`、`audio`、`video`)。默认值:`openai`/`anthropic`/`minimax` → image,`google` → image+audio+video,`groq` → audio。
-- `prompt`、`maxChars`、`maxBytes`、`timeoutSeconds`、`language`:每条目的覆盖值。
+- `prompt`、`maxChars`、`maxBytes`、`timeoutSeconds`、`language`:按条目覆盖。
- 失败时会回退到下一个条目。
提供商认证遵循标准顺序:`auth-profiles.json` → 环境变量 → `models.providers.*.apiKey`。
@@ -2174,8 +2174,8 @@ Talk 模式(macOS/iOS/Android)的默认值。
**异步完成字段:**
- `asyncCompletion.directSend`:为 `true` 时,已完成的异步 `music_generate`
- 和 `video_generate` 任务会优先尝试直接渠道投递。默认:`false`
- (旧版请求方会话唤醒/模型投递路径)。
+ 和 `video_generate` 任务会优先尝试直接投递到渠道。默认:`false`
+ (沿用旧版请求者会话唤醒/模型投递路径)。
@@ -2194,9 +2194,9 @@ Talk 模式(macOS/iOS/Android)的默认值。
### `tools.sessions`
-控制哪些会话可以被会话工具(`sessions_list`、`sessions_history`、`sessions_send`)作为目标。
+控制 session 工具(`sessions_list`、`sessions_history`、`sessions_send`)可定位哪些会话。
-默认值:`tree`(当前会话 + 由其派生的会话,例如子智能体)。
+默认值:`tree`(当前会话 + 由其派生的会话,例如 subagents)。
```json5
{
@@ -2212,10 +2212,10 @@ Talk 模式(macOS/iOS/Android)的默认值。
说明:
- `self`:仅当前会话键。
-- `tree`:当前会话 + 由当前会话派生的会话(子智能体)。
-- `agent`:属于当前智能体 id 的任意会话(如果你在同一个智能体 id 下运行按发送者隔离的会话,可能包含其他用户)。
+- `tree`:当前会话 + 由当前会话派生的会话(subagents)。
+- `agent`:属于当前智能体 id 的任意会话(如果你在同一智能体 id 下运行 per-sender 会话,可能包括其他用户)。
- `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`
@@ -2226,11 +2226,11 @@ Talk 模式(macOS/iOS/Android)的默认值。
tools: {
sessions_spawn: {
attachments: {
- enabled: false, // 显式启用:设为 true 可允许内联文件附件
- maxTotalBytes: 5242880, // 所有文件总计 5 MB
+ enabled: false, // opt-in: set true to allow inline file attachments
+ maxTotalBytes: 5242880, // 5 MB total across all files
maxFiles: 50,
- maxFileBytes: 1048576, // 每个文件 1 MB
- retainOnSessionKeep: false, // 当 cleanup="keep" 时保留附件
+ maxFileBytes: 1048576, // 1 MB per file
+ retainOnSessionKeep: false, // keep attachments when cleanup="keep"
},
},
},
@@ -2239,22 +2239,22 @@ Talk 模式(macOS/iOS/Android)的默认值。
说明:
-- 附件仅支持 `runtime: "subagent"`。ACP 运行时会拒绝它们。
-- 文件会物化到子工作区的 `.openclaw/attachments//` 下,并带有 `.manifest.json`。
-- 附件内容会自动从会话记录持久化中脱敏。
-- Base64 输入会执行严格字母表/填充校验,并在解码前进行大小保护。
-- 文件权限为目录 `0700`、文件 `0600`。
-- 清理由 `cleanup` 策略决定:`delete` 始终会删除附件;只有在 `retainOnSessionKeep: true` 时,`keep` 才会保留它们。
+- 仅对 `runtime: "subagent"` 支持附件。ACP runtime 会拒绝它们。
+- 文件会实体化到子工作区 `.openclaw/attachments//` 中,并附带 `.manifest.json`。
+- 附件内容会自动从转录持久化中脱敏。
+- Base64 输入会进行严格的字符集/填充校验,并带有解码前大小保护。
+- 目录权限为 `0700`,文件权限为 `0600`。
+- 清理遵循 `cleanup` 策略:`delete` 总是移除附件;`keep` 仅在 `retainOnSessionKeep: true` 时保留。
### `tools.experimental`
-实验性内置工具标志。默认关闭,除非某条运行时专用自动启用规则生效。
+实验性内置工具开关。默认关闭,除非运行时特定的自动启用规则生效。
```json5
{
tools: {
experimental: {
- planTool: true, // 启用实验性的 update_plan
+ planTool: true, // enable experimental update_plan
},
},
}
@@ -2262,9 +2262,9 @@ Talk 模式(macOS/iOS/Android)的默认值。
说明:
-- `planTool`:为非琐碎、多步骤工作跟踪启用结构化 `update_plan` 工具。
-- 默认值:对非 OpenAI 提供商为 `false`。OpenAI 和 OpenAI Codex 运行会自动启用它。
-- 启用后,系统提示还会加入使用指导,让模型仅在实质性工作中使用它,并始终最多只保留一个 `in_progress` 步骤。
+- `planTool`:为非简单多步骤工作跟踪启用结构化 `update_plan` 工具。
+- 默认值:对非 OpenAI 提供商为 `false`。OpenAI 和 OpenAI Codex 运行在未设置时会自动启用;设为 `false` 可关闭该自动启用。
+- 启用后,系统提示词也会加入使用指南,使模型仅在较复杂工作中使用它,并保持最多一个步骤处于 `in_progress`。
### `agents.defaults.subagents`
@@ -2284,21 +2284,21 @@ 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`。
+- 按子智能体的工具策略:`tools.subagents.tools.allow` / `tools.subagents.tools.deny`。
---
## 自定义提供商和 base URL
-OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~/.openclaw/agents//agent/models.json` 添加自定义提供商。
+OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 `~/.openclaw/agents//agent/models.json` 添加自定义提供商。
```json5
{
models: {
- mode: "merge", // merge(默认)| replace
+ mode: "merge", // merge (default) | replace
providers: {
"custom-proxy": {
baseUrl: "http://localhost:4000/v1",
@@ -2322,47 +2322,47 @@ OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~
}
```
-- 使用 `authHeader: true` + `headers` 以满足自定义认证需求。
-- 用 `OPENCLAW_AGENT_DIR`(或旧版环境变量别名 `PI_CODING_AGENT_DIR`)覆盖智能体配置根目录。
-- 匹配提供商 ID 的合并优先级:
- - 非空的智能体 `models.json` `baseUrl` 优先。
- - 非空的智能体 `apiKey` 仅在当前 config/auth-profile 上下文中该提供商不是 SecretRef 管理时优先。
- - 受 SecretRef 管理的提供商 `apiKey` 会从源标记刷新(环境变量引用为 `ENV_VAR_NAME`,file/exec 引用为 `secretref-managed`),而不是持久化已解析的 secret。
- - 受 SecretRef 管理的提供商 header 值也会从源标记刷新(环境变量引用为 `secretref-env:ENV_VAR_NAME`,file/exec 引用为 `secretref-managed`)。
+- 使用 `authHeader: true` + `headers` 可满足自定义认证需求。
+- 通过 `OPENCLAW_AGENT_DIR`(或旧版环境变量别名 `PI_CODING_AGENT_DIR`)覆盖智能体配置根目录。
+- 对匹配 provider ID 的合并优先级:
+ - 非空的智能体 `models.json` `baseUrl` 值优先。
+ - 非空的智能体 `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 值写入。
### 提供商字段详情
-- `models.mode`:提供商目录行为(`merge` 或 `replace`)。
-- `models.providers`:按提供商 id 键控的自定义提供商映射。
+- `models.mode`:provider 目录行为(`merge` 或 `replace`)。
+- `models.providers`:按 provider id 作为键的自定义 provider 映射。
- `models.providers.*.api`:请求适配器(`openai-completions`、`openai-responses`、`anthropic-messages`、`google-generative-ai` 等)。
-- `models.providers.*.apiKey`:提供商凭据(优先使用 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.*.injectNumCtxForOpenAICompat`:针对 Ollama + `openai-completions`,向请求注入 `options.num_ctx`(默认:`true`)。
+- `models.providers.*.authHeader`:在需要时强制通过 `Authorization` header 传输凭证。
- `models.providers.*.baseUrl`:上游 API base URL。
- `models.providers.*.headers`:用于代理/租户路由的额外静态 headers。
- `models.providers.*.request`:模型提供商 HTTP 请求的传输覆盖。
- - `request.headers`:额外 headers(与提供商默认值合并)。值支持 SecretRef。
- - `request.auth`:认证策略覆盖。模式:`"provider-default"`(使用提供商内置认证)、`"authorization-bearer"`(配合 `token`)、`"header"`(配合 `headerName`、`value`、可选 `prefix`)。
+ - `request.headers`:额外 headers(与 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`。
-- `models.providers.*.models`:显式提供商模型目录条目。
+ - `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.*.compat.requiresStringContent`:用于仅支持字符串的 OpenAI-compatible chat 端点的可选兼容性提示。为 `true` 时,OpenClaw 会在发送请求前将纯文本 `messages[].content` 数组压平为普通字符串。
-- `plugins.entries.amazon-bedrock.config.discovery`:Bedrock 自动发现设置根。
+- `models.providers.*.models.*.contextTokens`:可选的运行时上下文上限。当你想要比模型原生 `contextWindow` 更小的有效上下文预算时使用它。
+- `models.providers.*.models.*.compat.supportsDeveloperRole`:可选兼容性提示。对于 `api: "openai-completions"` 且存在非空、非原生 `baseUrl`(主机不是 `api.openai.com`)的情况,OpenClaw 会在运行时强制将其设为 `false`。空/省略的 `baseUrl` 保持 OpenAI 默认行为。
+- `models.providers.*.models.*.compat.requiresStringContent`:适用于仅支持字符串内容的 OpenAI 兼容聊天端点的可选兼容性提示。为 `true` 时,OpenClaw 会在发送请求前,将纯文本 `messages[].content` 数组压平成普通字符串。
+- `plugins.entries.amazon-bedrock.config.discovery`:Bedrock 自动发现设置根节点。
- `plugins.entries.amazon-bedrock.config.discovery.enabled`:开启/关闭隐式发现。
- `plugins.entries.amazon-bedrock.config.discovery.region`:用于发现的 AWS 区域。
-- `plugins.entries.amazon-bedrock.config.discovery.providerFilter`:可选的提供商 id 过滤器,用于定向发现。
-- `plugins.entries.amazon-bedrock.config.discovery.refreshInterval`:发现刷新的轮询间隔。
-- `plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow`:已发现模型的后备上下文窗口。
-- `plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens`:已发现模型的后备最大输出 token。
+- `plugins.entries.amazon-bedrock.config.discovery.providerFilter`:可选的 provider-id 过滤器,用于定向发现。
+- `plugins.entries.amazon-bedrock.config.discovery.refreshInterval`:发现刷新轮询间隔。
+- `plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow`:已发现模型的回退上下文窗口。
+- `plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens`:已发现模型的回退最大输出 token。
### 提供商示例
@@ -2400,7 +2400,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`。
@@ -2434,11 +2434,11 @@ Cerebras 使用 `cerebras/zai-glm-4.7`;Z.AI 直连使用 `zai/glm-4.7`。
}
```
-设置 `ZAI_API_KEY`。`z.ai/*` 和 `z-ai/*` 都是可接受别名。快捷方式:`openclaw onboard --auth-choice zai-api-key`。
+设置 `ZAI_API_KEY`。也接受 `z.ai/*` 和 `z-ai/*` 作为别名。快捷方式:`openclaw onboard --auth-choice zai-api-key`。
- 通用端点:`https://api.z.ai/api/paas/v4`
- Coding 端点(默认):`https://api.z.ai/api/coding/paas/v4`
-- 若要使用通用端点,请定义一个带 base URL 覆盖的自定义提供商。
+- 对于通用端点,请定义一个带 base URL 覆盖的自定义提供商。
@@ -2477,11 +2477,11 @@ Cerebras 使用 `cerebras/zai-glm-4.7`;Z.AI 直连使用 `zai/glm-4.7`。
}
```
-中国端点:`baseUrl: "https://api.moonshot.cn/v1"` 或 `openclaw onboard --auth-choice moonshot-api-key-cn`。
+中国端点使用:`baseUrl: "https://api.moonshot.cn/v1"` 或 `openclaw onboard --auth-choice moonshot-api-key-cn`。
原生 Moonshot 端点会在共享的
-`openai-completions` 传输上声明流式使用兼容性,OpenClaw 现在会根据端点
-能力而不仅仅是内置提供商 id 来判断这一点。
+`openai-completions` 传输层上声明流式传输兼容性,而 OpenClaw 现在会依据端点
+能力,而不再仅依据内置 provider id 来判断。
@@ -2499,11 +2499,11 @@ Cerebras 使用 `cerebras/zai-glm-4.7`;Z.AI 直连使用 `zai/glm-4.7`。
}
```
-Anthropic-compatible,内置提供商。快捷方式:`openclaw onboard --auth-choice kimi-code-api-key`。
+内置的 Anthropic 兼容 provider。快捷方式:`openclaw onboard --auth-choice kimi-code-api-key`。
-
+
```json5
{
@@ -2582,16 +2582,16 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
`openclaw onboard --auth-choice minimax-global-api` 或
`openclaw onboard --auth-choice minimax-cn-api`。
模型目录现在默认仅包含 M2.7。
-在 Anthropic-compatible 流式路径上,OpenClaw 默认会禁用 MiniMax thinking,
-除非你显式自行设置 `thinking`。`/fast on` 或
-`params.fastMode: true` 会将 `MiniMax-M2.7` 重写为
+在 Anthropic 兼容的流式传输路径上,除非你显式设置 `thinking`,
+否则 OpenClaw 默认会禁用 MiniMax thinking。`/fast on` 或
+`params.fastMode: true` 会将 `MiniMax-M2.7` 改写为
`MiniMax-M2.7-highspeed`。
-参见 [本地模型](/zh-CN/gateway/local-models)。简而言之:在性能足够强的硬件上,通过 LM Studio Responses API 运行大型本地模型;并保留已合并的托管模型作为后备。
+见 [Local Models](/zh-CN/gateway/local-models)。简而言之:在较强硬件上通过 LM Studio Responses API 运行大型本地模型;同时保留已合并的托管模型作为回退。
@@ -2612,7 +2612,7 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
},
entries: {
"image-lab": {
- apiKey: { source: "env", provider: "default", id: "GEMINI_API_KEY" }, // 或明文字符串
+ apiKey: { source: "env", provider: "default", id: "GEMINI_API_KEY" }, // or plaintext string
env: { GEMINI_API_KEY: "GEMINI_KEY_HERE" },
},
peekaboo: { enabled: true },
@@ -2622,12 +2622,12 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
}
```
-- `allowBundled`:仅对内置 Skills 生效的可选允许列表(managed/workspace Skills 不受影响)。
-- `load.extraDirs`:额外共享 Skills 根目录(优先级最低)。
-- `install.preferBrew`:为 true 时,在 `brew` 可用的情况下优先使用 Homebrew 安装器,再回退到其他安装类型。
-- `install.nodeManager`:`metadata.openclaw.install` 规范使用的 node 安装器偏好(`npm` | `pnpm` | `yarn` | `bun`)。
-- `entries..enabled: false`:即使某个 skill 已内置/已安装,也会禁用它。
-- `entries..apiKey`:为声明主环境变量的 skill 提供的便捷 API key 字段(明文字符串或 SecretRef 对象)。
+- `allowBundled`:仅针对内置技能的可选允许列表(managed/workspace Skills 不受影响)。
+- `load.extraDirs`:额外的共享技能根目录(最低优先级)。
+- `install.preferBrew`:为 true 时,若 `brew` 可用,会优先使用 Homebrew 安装器,再回退到其他安装器类型。
+- `install.nodeManager`:`metadata.openclaw.install` 规范的 node 安装器偏好(`npm` | `pnpm` | `yarn` | `bun`)。
+- `entries..enabled: false`:即使技能已内置/已安装,也会禁用该技能。
+- `entries..apiKey`:对声明了主环境变量的技能提供 API key 便捷字段(明文字符串或 SecretRef 对象)。
---
@@ -2656,36 +2656,36 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
```
- 从 `~/.openclaw/extensions`、`/.openclaw/extensions` 以及 `plugins.load.paths` 加载。
-- 设备发现接受原生 OpenClaw 插件、兼容的 Codex bundle 和 Claude bundle,包括无 manifest 的 Claude 默认布局 bundle。
+- 发现流程接受原生 OpenClaw 插件,以及兼容的 Codex bundle 和 Claude bundle,包括无 manifest 的 Claude 默认布局 bundle。
- **配置变更需要重启 Gateway 网关。**
- `allow`:可选允许列表(仅加载列出的插件)。`deny` 优先。
-- `plugins.entries..apiKey`:插件级 API key 便捷字段(插件支持时)。
-- `plugins.entries..env`:插件作用域环境变量映射。
-- `plugins.entries..hooks.allowPromptInjection`:为 `false` 时,core 会阻止 `before_prompt_build`,并忽略来自旧版 `before_agent_start` 的可变更提示字段,同时保留旧版 `modelOverride` 和 `providerOverride`。适用于原生插件 hooks 和支持的 bundle 提供 hook 目录。
-- `plugins.entries..subagent.allowModelOverride`:显式信任该插件,可为后台子智能体运行请求每次运行级别的 `provider` 和 `model` 覆盖。
-- `plugins.entries..subagent.allowedModels`:受信任子智能体覆盖允许的规范 `provider/model` 目标可选列表。仅当你明确想允许任意模型时才使用 `"*"`。
-- `plugins.entries..config`:插件定义的配置对象(如果可用,会由原生 OpenClaw 插件 schema 校验)。
-- `plugins.entries.firecrawl.config.webFetch`:Firecrawl web 抓取提供商设置。
- - `apiKey`:Firecrawl API key(支持 SecretRef)。会回退到 `plugins.entries.firecrawl.config.webSearch.apiKey`、旧版 `tools.web.fetch.firecrawl.apiKey` 或 `FIRECRAWL_API_KEY` 环境变量。
+- `plugins.entries..apiKey`:插件级 API key 便捷字段(插件支持时可用)。
+- `plugins.entries..env`:插件作用域的环境变量映射。
+- `plugins.entries..hooks.allowPromptInjection`:为 `false` 时,core 会阻止 `before_prompt_build`,并忽略来自旧版 `before_agent_start` 的提示词变更字段,同时保留旧版 `modelOverride` 和 `providerOverride`。适用于原生插件 hooks 和受支持 bundle 提供的 hook 目录。
+- `plugins.entries..subagent.allowModelOverride`:显式信任此插件可为后台 subagent 运行请求按次 `provider` 和 `model` 覆盖。
+- `plugins.entries..subagent.allowedModels`:受信任 subagent 覆盖可使用的规范 `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`)。
- `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 提供商。
+ - `enabled`:启用 X Search provider。
- `model`:用于搜索的 Grok 模型(例如 `"grok-4-1-fast"`)。
-- `plugins.entries.memory-core.config.dreaming`:memory dreaming(实验性)设置。阶段和阈值参见 [Dreaming](/zh-CN/concepts/dreaming)。
- - `enabled`:dreaming 主开关(默认 `false`)。
+- `plugins.entries.memory-core.config.dreaming`:记忆 dreaming(实验性)设置。阶段和阈值见 [Dreaming](/zh-CN/concepts/dreaming)。
+ - `enabled`:dreaming 总开关(默认 `false`)。
- `frequency`:每次完整 dreaming 扫描的 cron 频率(默认 `"0 3 * * *"`)。
- - phase policy 和阈值属于实现细节(不是面向用户的配置键)。
-- 已启用的 Claude bundle 插件也可以提供内嵌 Pi 默认值,来自 `settings.json`;OpenClaw 会将它们作为已净化的智能体设置应用,而不是作为原始 OpenClaw 配置补丁。
+ - 阶段策略和阈值属于实现细节(不是面向用户的配置键)。
+- 已启用的 Claude bundle 插件也可以从 `settings.json` 提供嵌入式 Pi 默认值;OpenClaw 会将其作为清洗后的智能体设置应用,而不是作为原始 OpenClaw 配置补丁。
- `plugins.slots.memory`:选择活动 memory 插件 id,或使用 `"none"` 禁用 memory 插件。
-- `plugins.slots.contextEngine`:选择活动上下文引擎插件 id;默认值是 `"legacy"`,除非你安装并选择其他引擎。
+- `plugins.slots.contextEngine`:选择活动上下文引擎插件 id;除非你安装并选择了其他引擎,否则默认是 `"legacy"`。
- `plugins.installs`:由 CLI 管理的安装元数据,供 `openclaw plugins update` 使用。
- 包含 `source`、`spec`、`sourcePath`、`installPath`、`version`、`resolvedName`、`resolvedVersion`、`resolvedSpec`、`integrity`、`shasum`、`resolvedAt`、`installedAt`。
- - 将 `plugins.installs.*` 视为托管状态;优先使用 CLI 命令,而不是手动编辑。
+ - 请将 `plugins.installs.*` 视为受管状态;优先使用 CLI 命令,而不是手动编辑。
-参见 [插件](/zh-CN/tools/plugin)。
+见 [Plugins](/zh-CN/tools/plugin)。
---
@@ -2698,8 +2698,8 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
evaluateEnabled: true,
defaultProfile: "user",
ssrfPolicy: {
- dangerouslyAllowPrivateNetwork: true, // 默认 trusted-network 模式
- // allowPrivateNetwork: true, // 旧版别名
+ dangerouslyAllowPrivateNetwork: true, // default trusted-network mode
+ // allowPrivateNetwork: true, // legacy alias
// hostnameAllowlist: ["*.example.com", "example.com"],
// allowedHostnames: ["localhost"],
},
@@ -2726,27 +2726,28 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
```
- `evaluateEnabled: false` 会禁用 `act:evaluate` 和 `wait --fn`。
-- `ssrfPolicy.dangerouslyAllowPrivateNetwork` 在未设置时默认为 `true`(trusted-network 模型)。
-- 若要使用严格的仅公共网络浏览导航,请设置 `ssrfPolicy.dangerouslyAllowPrivateNetwork: false`。
-- 在严格模式下,远程 CDP 配置端点(`profiles.*.cdpUrl`)在可达性/设备发现检查期间也会受到相同的私有网络阻止策略约束。
-- `ssrfPolicy.allowPrivateNetwork` 仍作为旧版别名支持。
-- 在严格模式下,使用 `ssrfPolicy.hostnameAllowlist` 和 `ssrfPolicy.allowedHostnames` 作为显式例外。
-- 远程 profiles 为仅附加模式(无法 start/stop/reset)。
+- `ssrfPolicy.dangerouslyAllowPrivateNetwork` 未设置时默认是 `true`(trusted-network 模型)。
+- 将 `ssrfPolicy.dangerouslyAllowPrivateNetwork: false` 设为严格的仅公共网络浏览导航模式。
+- 在严格模式下,远程 CDP 配置端点(`profiles.*.cdpUrl`)在可达性/发现检查期间也会受到相同的 private-network 阻止。
+- `ssrfPolicy.allowPrivateNetwork` 仍作为旧版别名受支持。
+- 在严格模式下,使用 `ssrfPolicy.hostnameAllowlist` 和 `ssrfPolicy.allowedHostnames` 进行显式例外配置。
+- 远程配置为仅附加模式(启动/停止/重置已禁用)。
- `profiles.*.cdpUrl` 接受 `http://`、`https://`、`ws://` 和 `wss://`。
- 如果你想让 OpenClaw 发现 `/json/version`,请使用 HTTP(S);
- 当提供商直接给你 DevTools WebSocket URL 时,请使用 WS(S)。
-- `existing-session` profiles 仅限主机使用,并使用 Chrome MCP 而非 CDP。
-- `existing-session` profiles 可以设置 `userDataDir` 以指定特定的
- Chromium-based 浏览器 profile,如 Brave 或 Edge。
-- `existing-session` profiles 保留当前 Chrome MCP 路由限制:
- 基于快照/ref 的操作,而不是 CSS 选择器目标;单文件上传 hooks;
- 不支持对话框超时覆盖;不支持 `wait --load networkidle`;也不支持
+ 如果你希望 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 选择器定向、单文件上传
+ hooks、无对话框超时覆盖、无 `wait --load networkidle`,也无
`responsebody`、PDF 导出、下载拦截或批量操作。
-- 本地托管的 `openclaw` profiles 会自动分配 `cdpPort` 和 `cdpUrl`;只有远程 CDP 才需要显式设置 `cdpUrl`。
-- 自动检测顺序:默认浏览器(若为 Chromium-based)→ Chrome → Brave → Edge → Chromium → Chrome Canary。
-- 控制服务:仅 loopback(端口从 `gateway.port` 派生,默认 `18791`)。
-- `extraArgs` 会将额外启动标志附加到本地 Chromium 启动参数中(例如
- `--disable-gpu`、窗口尺寸或调试标志)。
+- 本地受管 `openclaw` 配置会自动分配 `cdpPort` 和 `cdpUrl`;仅对远程 CDP
+ 才显式设置 `cdpUrl`。
+- 自动检测顺序:默认浏览器(若为 Chromium 内核)→ Chrome → Brave → Edge → Chromium → Chrome Canary。
+- 控制服务:仅监听 loopback(端口由 `gateway.port` 推导,默认 `18791`)。
+- `extraArgs` 会将额外启动参数附加到本地 Chromium 启动流程中(例如
+ `--disable-gpu`、窗口尺寸或调试参数)。
---
@@ -2758,18 +2759,18 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
seamColor: "#FF4500",
assistant: {
name: "OpenClaw",
- avatar: "CB", // emoji、短文本、图片 URL 或 data URI
+ avatar: "CB", // emoji, short text, image URL, or data URI
},
},
}
```
- `seamColor`:原生应用 UI 外观的强调色(Talk Mode 气泡着色等)。
-- `assistant`:Control UI 身份覆盖。会回退到当前活跃智能体身份。
+- `assistant`:控制 UI 的身份覆盖。会回退到当前活动智能体身份。
---
-## Gateway
+## Gateway 网关
```json5
{
@@ -2780,8 +2781,8 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
auth: {
mode: "token", // none | token | password | trusted-proxy
token: "your-token",
- // password: "your-password", // 或 OPENCLAW_GATEWAY_PASSWORD
- // trustedProxy: { userHeader: "x-forwarded-user" }, // 用于 mode=trusted-proxy;参见 /gateway/trusted-proxy-auth
+ // password: "your-password", // or OPENCLAW_GATEWAY_PASSWORD
+ // trustedProxy: { userHeader: "x-forwarded-user" }, // for mode=trusted-proxy; see /gateway/trusted-proxy-auth
allowTailscale: true,
rateLimit: {
maxAttempts: 10,
@@ -2798,8 +2799,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"], // required for non-loopback Control UI
+ // dangerouslyAllowHostHeaderOriginFallback: false, // dangerous Host-header origin fallback mode
// allowInsecureAuth: false,
// dangerouslyDisableDeviceAuth: false,
},
@@ -2810,12 +2811,12 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
// password: "your-password",
},
trustedProxies: ["10.0.0.1"],
- // 可选。默认 false。
+ // Optional. Default false.
allowRealIpFallback: false,
tools: {
- // 额外的 /tools/invoke HTTP deny
+ // Additional /tools/invoke HTTP denies
deny: ["browser"],
- // 从默认 HTTP deny 列表中移除工具
+ // Remove tools from the default HTTP deny list
allow: ["gateway"],
},
push: {
@@ -2832,26 +2833,29 @@ Base URL 不应包含 `/v1`(Anthropic 客户端会自行追加)。快捷方
-- `mode`:`local`(运行 Gateway 网关)或 `remote`(连接远程 Gateway 网关)。除非是 `local`,否则 Gateway 网关会拒绝启动。
+- `mode`:`local`(运行 gateway)或 `remote`(连接远程 gateway)。只有在 `local` 时 Gateway 网关才会启动。
- `port`:用于 WS + HTTP 的单一复用端口。优先级:`--port` > `OPENCLAW_GATEWAY_PORT` > `gateway.port` > `18789`。
- `bind`:`auto`、`loopback`(默认)、`lan`(`0.0.0.0`)、`tailnet`(仅 Tailscale IP)或 `custom`。
-- **旧版 bind 别名**:在 `gateway.bind` 中使用 bind 模式值(`auto`、`loopback`、`lan`、`tailnet`、`custom`),不要使用 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"`(或 `bind: "custom"` 且 `customBindHost: "0.0.0.0"`)以监听所有接口。
-- **认证**:默认必须启用。非 loopback bind 要求 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` 的身份头(参见 [Trusted Proxy Auth](/zh-CN/gateway/trusted-proxy-auth))。此模式要求**非 loopback**代理来源;同主机 loopback 反向代理不满足 trusted-proxy 认证条件。
-- `gateway.auth.allowTailscale`:为 `true` 时,Tailscale Serve 身份头可满足 Control UI/WebSocket 认证(通过 `tailscale whois` 验证)。HTTP API 端点**不会**使用该 Tailscale 头认证;它们仍遵循 Gateway 网关正常的 HTTP 认证模式。该无 token 流程假定网关主机是可信的。当 `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。
+- **旧版 bind 别名**:请在 `gateway.bind` 中使用 bind 模式值(`auto`、`loopback`、`lan`、`tailnet`、`custom`),不要使用主机别名(`0.0.0.0`、`127.0.0.1`、`localhost`、`::`、`::1`)。
+- **Docker 注意事项**:默认的 `loopback` bind 会在容器内部监听 `127.0.0.1`。在 Docker bridge 网络(`-p 18789:18789`)下,流量会到达 `eth0`,因此 gateway 无法访问。请使用 `--network host`,或者设置 `bind: "lan"`(或 `bind: "custom"` 并设置 `customBindHost: "0.0.0.0"`)以监听所有网络接口。
+- **认证**:默认必须启用。非 loopback bind 要求 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` 的身份头(见 [Trusted Proxy Auth](/zh-CN/gateway/trusted-proxy-auth))。该模式要求**非 loopback** 的代理来源;同主机 loopback 反向代理不满足 trusted-proxy 认证条件。
+- `gateway.auth.allowTailscale`:当为 `true` 时,Tailscale Serve 身份头可满足 Control UI/WebSocket 认证(通过 `tailscale whois` 验证)。HTTP API 端点**不会**使用该 Tailscale 头部认证;它们仍遵循 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 来源的连续失败不会自动
+ 锁住另一个来源。
- `tailscale.mode`:`serve`(仅 tailnet,loopback bind)或 `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` /
\ No newline at end of file
+- `controlUi.allowedOrigins`:用于 Gateway WebSocket 连接的显式浏览器来源允许列表。若期望来自非 loopback 来源的浏览器客户端,则必须设置。
+- `controlUi.dangerouslyAllowHostHeaderOriginFallback`:危险模式,会启用基于 Host header 的来源回退,适用于有意依赖 Host header 来源策略的部署。
+- `remote.transport`:`ssh`(默认)或 `direct`(ws/wss)。对于 `direct`,`remote.url` 必须是 `ws://` 或 `wss://`。
+- `OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1`:客户端侧紧急开关,允许对受信任 private-network IP 使用明文 `ws://`;默认仍然只允许对 loopback 使用明文。
+- `gateway.remote.token` / `.password` 是远程客户端凭证字段。它们本身不会配置 gateway 认证。
+- `gateway.push.apns.relay.baseUrl`:外部 APNs relay 的基础 HTTPS URL,供官方/TestFlight iOS 构建在将基于 relay 的注册发布到 gateway 之后使用。该 URL 必须与编译进 iOS 构建中的 relay URL 一致。
+- `gateway.push.apns.relay.timeoutMs`:gateway 到 relay 的发送超时(毫秒)。默认值为 `10000`。
+- 基于 relay 的注册会委托给特定的 gateway 身份。配对后的 iOS 应
\ No newline at end of file