diff --git a/docs/zh-CN/automation/tasks.md b/docs/zh-CN/automation/tasks.md index bbb4dfb56..bda7c6127 100644 --- a/docs/zh-CN/automation/tasks.md +++ b/docs/zh-CN/automation/tasks.md @@ -1,49 +1,49 @@ --- read_when: - - 检查正在进行中或最近完成的后台工作时 - - 调试分离式智能体运行的投递失败时 - - 了解后台运行如何与会话、cron 和 heartbeat 关联时 + - 检查正在进行中或最近已完成的后台工作 + - 调试分离式智能体运行的投递失败 + - 了解后台运行如何与会话、cron 和心跳相关联 summary: 用于跟踪 ACP 运行、子智能体、隔离的 cron 作业以及 CLI 操作的后台任务 title: 后台任务 x-i18n: - generated_at: "2026-04-06T00:20:21Z" + generated_at: "2026-04-06T02:31:07Z" model: gpt-5.4 provider: openai - source_hash: 5fc757b30e2d9c1b5c4d9c8ff21cdc406835af207a83ee6076b63c348ad07781 + source_hash: 2f56c1ac23237907a090c69c920c09578a2f56f5d8bf750c7f2136c603c8a8ff source_path: automation/tasks.md workflow: 15 --- # 后台任务 -> **在找调度功能？** 请参阅 [自动化与任务](/zh-CN/automation)，以选择合适的机制。本页介绍的是如何**跟踪**后台工作，而不是如何调度它。 +> **在找调度功能吗？** 请参阅 [自动化与任务](/zh-CN/automation) 以选择合适的机制。本页介绍的是如何**跟踪**后台工作，而不是如何调度它。 后台任务用于跟踪**在你的主对话会话之外**运行的工作： -ACP 运行、子智能体生成、隔离的 cron 作业执行，以及由 CLI 发起的操作。 +ACP 运行、子智能体派生、隔离的 cron 作业执行，以及由 CLI 发起的操作。 -任务**不会**取代会话、cron 作业或 heartbeat——它们是记录分离式工作发生了什么、何时发生以及是否成功的**活动台账**。 +任务**不会**替代会话、cron 作业或心跳——它们是记录分离式工作发生了什么、何时发生以及是否成功的**活动台账**。 -并非每次智能体运行都会创建任务。Heartbeat 回合和普通交互式聊天不会。所有 cron 执行、ACP 生成、子智能体生成以及 CLI 智能体命令都会创建任务。 +并不是每次智能体运行都会创建任务。心跳轮次和正常的交互式聊天不会。所有 cron 执行、ACP 派生、子智能体派生以及 CLI 智能体命令都会创建任务。 ## TL;DR -- 任务是**记录**，不是调度器——cron 和 heartbeat 决定工作_何时_运行，任务跟踪_发生了什么_。 -- ACP、子智能体、所有 cron 作业和 CLI 操作都会创建任务。Heartbeat 回合不会。 +- 任务是**记录**，不是调度器——cron 和心跳决定工作**何时**运行，任务跟踪**发生了什么**。 +- ACP、子智能体、所有 cron 作业以及 CLI 操作都会创建任务。心跳轮次不会。 - 每个任务都会经历 `queued → running → terminal`（succeeded、failed、timed_out、cancelled 或 lost）。 -- 只要 cron 运行时仍然拥有该作业，cron 任务就会保持活动状态；而基于聊天的 CLI 任务只会在其所属运行上下文仍处于活动状态时保持活动。 -- 完成是由推送驱动的：分离式工作在结束时可以直接通知，或唤醒请求方会话 / heartbeat，因此状态轮询循环通常不是正确方式。 -- 隔离的 cron 运行和子智能体完成时，会尽最大努力在最终清理记账前，清理其子会话所跟踪的浏览器标签页 / 进程。 -- 隔离的 cron 投递会在后代子智能体工作仍在排空时抑制过期的中间父级回复，并且在后代最终输出先于投递到达时优先使用该输出。 -- 完成通知会直接投递到某个渠道，或排队等待下一次 heartbeat。 +- 只要 cron 运行时仍拥有该作业，cron 任务就会保持活动状态；基于聊天的 CLI 任务则只会在其所属运行上下文仍处于活动状态时保持活动。 +- 完成由推送驱动：分离式工作完成后可以直接通知，或唤醒请求方会话 / 心跳，因此状态轮询循环通常不是正确模式。 +- 隔离的 cron 运行和子智能体完成时，会尽力为其子会话清理已跟踪的浏览器标签页 / 进程，然后再执行最终清理记账。 +- 隔离的 cron 投递会在后代子智能体工作仍在排空时抑制过期的中间父级回复，并且如果最终的后代输出先到达，则优先使用该输出。 +- 完成通知会直接投递到某个渠道，或排队等待下一次心跳。 - `openclaw tasks list` 显示所有任务；`openclaw tasks audit` 用于发现问题。 -- 终态记录会保留 7 天，然后自动清理。 +- 终态记录会保留 7 天，之后自动清理。 ## 快速开始 ```bash -# 列出所有任务（最新的在前） +# 列出所有任务（最新优先） openclaw tasks list # 按运行时或状态筛选 @@ -53,7 +53,7 @@ openclaw tasks list --status running # 显示特定任务的详细信息（按 ID、run ID 或 session key） openclaw tasks show -# 取消正在运行的任务（终止子会话） +# 取消正在运行的任务（会终止子会话） openclaw tasks cancel # 更改任务的通知策略 @@ -62,7 +62,7 @@ openclaw tasks notify state_changes # 运行健康审计 openclaw tasks audit -# 预览或应用维护 +# 预览或应用维护操作 openclaw tasks maintenance openclaw tasks maintenance --apply @@ -76,23 +76,23 @@ openclaw tasks flow cancel | 来源 | 运行时类型 | 何时创建任务记录 | 默认通知策略 | | ---------------------- | ------------ | ------------------------------------------------------ | --------------------- | -| ACP 后台运行 | `acp` | 生成子 ACP 会话时 | `done_only` | -| 子智能体编排 | `subagent` | 通过 `sessions_spawn` 生成子智能体时 | `done_only` | -| Cron 作业（所有类型） | `cron` | 每次 cron 执行时（主会话和隔离模式都算） | `silent` | +| ACP 后台运行 | `acp` | 派生 ACP 子会话时 | `done_only` | +| 子智能体编排 | `subagent` | 通过 `sessions_spawn` 派生子智能体时 | `done_only` | +| Cron 作业（所有类型） | `cron` | 每次 cron 执行时（主会话和隔离运行都包括） | `silent` | | CLI 操作 | `cli` | 通过 Gateway 网关运行的 `openclaw agent` 命令 | `silent` | | 智能体媒体作业 | `cli` | 基于会话的 `video_generate` 运行 | `silent` | -主会话 cron 任务默认使用 `silent` 通知策略——它们会创建用于跟踪的记录，但不会生成通知。隔离的 cron 任务也默认使用 `silent`，但由于它们在自己的会话中运行，因此可见性更高。 +主会话 cron 任务默认使用 `silent` 通知策略——它们会创建记录用于跟踪，但不会生成通知。隔离的 cron 任务也默认使用 `silent`，但由于它们在自己的会话中运行，因此更容易被看到。 -基于会话的 `video_generate` 运行也使用 `silent` 通知策略。它们仍会创建任务记录，但完成结果会作为内部唤醒返回给原始智能体会话，这样智能体就可以自行编写后续消息并附加生成完成的视频。 +基于会话的 `video_generate` 运行也使用 `silent` 通知策略。它们仍然会创建任务记录，但完成后会通过内部唤醒回传给原始智能体会话，这样智能体就可以自行编写后续消息并附加已完成的视频。如果你启用 `tools.media.asyncCompletion.directSend`，异步的 `music_generate` 和 `video_generate` 完成时会先尝试直接投递到渠道，如果失败，再回退到唤醒请求方会话的路径。 -当某个基于会话的 `video_generate` 任务仍处于活动状态时，该工具还会充当保护机制：在同一会话中重复调用 `video_generate` 时，会返回活动任务状态，而不是启动第二个并发生成。若你想从智能体侧显式查询进度 / 状态，请使用 `action: "status"`。 +当某个基于会话的 `video_generate` 任务仍在活动时，该工具还会充当防护机制：在同一会话中重复调用 `video_generate` 会返回活动任务状态，而不是启动第二个并发生成任务。如果你想从智能体侧显式查询进度 / 状态，请使用 `action: "status"`。 -**不会创建任务的情况：** +**哪些情况不会创建任务：** -- Heartbeat 回合——主会话；参见 [Heartbeat](/zh-CN/gateway/heartbeat) -- 普通交互式聊天回合 -- 直接 `/command` 响应 +- 心跳轮次——主会话；请参阅 [Heartbeat](/zh-CN/gateway/heartbeat) +- 正常的交互式聊天轮次 +- 直接的 `/command` 响应 ## 任务生命周期 @@ -110,48 +110,48 @@ stateDiagram-v2 | 状态 | 含义 | | ----------- | -------------------------------------------------------------------------- | -| `queued` | 已创建，等待智能体启动 | -| `running` | 智能体回合正在执行中 | +| `queued` | 已创建，等待智能体开始 | +| `running` | 智能体轮次正在积极执行 | | `succeeded` | 已成功完成 | -| `failed` | 已因错误完成 | -| `timed_out` | 超过配置的超时时间 | -| `cancelled` | 由操作员通过 `openclaw tasks cancel` 停止 | -| `lost` | 在 5 分钟宽限期后，运行时丢失了权威性支撑状态 | +| `failed` | 已带错误完成 | +| `timed_out` | 超过已配置的超时时间 | +| `cancelled` | 被操作员通过 `openclaw tasks cancel` 停止 | +| `lost` | 运行时在 5 分钟宽限期后丢失了权威的后备状态 | -状态转换会自动发生——当关联的智能体运行结束时，任务状态会更新为相应结果。 +状态转换会自动发生——当关联的智能体运行结束时，任务状态会更新为对应结果。 -`lost` 是感知运行时类型的： +`lost` 是感知运行时的： -- ACP 任务：其底层 ACP 子会话元数据已消失。 -- 子智能体任务：其底层子会话已从目标智能体存储中消失。 -- Cron 任务：cron 运行时不再将该作业标记为活动。 -- CLI 任务：隔离的子会话任务使用子会话；而基于聊天的 CLI 任务则改用实时运行上下文，因此残留的渠道 / 群组 / 直连会话行不会让它们继续保持活动。 +- ACP 任务：后备的 ACP 子会话元数据已消失。 +- 子智能体任务：后备子会话已从目标智能体存储中消失。 +- Cron 任务：cron 运行时不再将该作业视为活动。 +- CLI 任务：隔离的子会话任务使用子会话；基于聊天的 CLI 任务则改为使用实时运行上下文，因此残留的渠道 / 群组 / 直接会话行不会让它们继续保持活动。 ## 投递和通知 当任务进入终态时，OpenClaw 会通知你。有两种投递路径： -**直接投递**——如果任务有渠道目标（即 `requesterOrigin`），完成消息会直接发送到该渠道（Telegram、Discord、Slack 等）。对于子智能体完成，OpenClaw 还会在可用时保留已绑定的线程 / 主题路由，并且可以在直接投递放弃前，先用请求方会话存储的路由（`lastChannel` / `lastTo` / `lastAccountId`）补全缺失的 `to` / 账号。 +**直接投递**——如果任务有渠道目标（`requesterOrigin`），完成消息会直接发送到该渠道（Telegram、Discord、Slack 等）。对于子智能体完成，OpenClaw 还会在可用时保留已绑定的线程 / 主题路由，并且在放弃直接投递前，可以从请求方会话存储的路由（`lastChannel` / `lastTo` / `lastAccountId`）中补全缺失的 `to` / account。 -**会话排队投递**——如果直接投递失败，或未设置来源，则更新会作为系统事件排入请求方会话，并在下一次 heartbeat 时呈现。 +**会话排队投递**——如果直接投递失败，或者未设置 origin，更新会作为系统事件排入请求方会话，并在下一次心跳时显示出来。 -任务完成会立即触发 heartbeat 唤醒，这样你可以尽快看到结果——你不必等到下一次计划中的 heartbeat tick。 +任务完成会立即触发一次心跳唤醒，因此你可以很快看到结果——你不必等待下一次计划中的心跳周期。 -这意味着常见工作流是基于推送的：只需启动一次分离式工作，然后让运行时在完成时唤醒或通知你。只有在你需要调试、干预或显式审计时，才去轮询任务状态。 +这意味着常见工作流是基于推送的：启动一次分离式工作，然后让运行时在完成时唤醒或通知你。只有在你需要调试、干预或执行显式审计时，才去轮询任务状态。 ### 通知策略 -控制你会听到每个任务的多少信息： +控制你能听到每个任务多少信息： -| 策略 | 会投递的内容 | +| 策略 | 会投递什么 | | --------------------- | ----------------------------------------------------------------------- | | `done_only`（默认） | 仅终态（succeeded、failed 等）——**这是默认值** | | `state_changes` | 每次状态转换和进度更新 | | `silent` | 完全不通知 | -在任务运行时更改策略： +在任务运行期间更改策略： ```bash openclaw tasks notify state_changes @@ -173,7 +173,7 @@ openclaw tasks list [--runtime ] [--status ] [--j openclaw tasks show ``` -查找标记接受任务 ID、run ID 或 session key。显示完整记录，包括时间信息、投递状态、错误和终态摘要。 +查找令牌接受任务 ID、run ID 或 session key。显示完整记录，包括时间、投递状态、错误和终态摘要。 ### `tasks cancel` @@ -181,7 +181,7 @@ openclaw tasks show openclaw tasks cancel ``` -对于 ACP 和子智能体任务，这会终止子会话。状态会转为 `cancelled`，并发送一条投递通知。 +对于 ACP 和子智能体任务，这会终止子会话。状态会转换为 `cancelled`，并发送投递通知。 ### `tasks notify` @@ -195,16 +195,16 @@ openclaw tasks notify openclaw tasks audit [--json] ``` -用于发现运维问题。检测到问题时，结果也会显示在 `openclaw status` 中。 +用于发现运行问题。检测到问题时，结果也会显示在 `openclaw status` 中。 | 发现项 | 严重级别 | 触发条件 | | ------------------------- | -------- | ----------------------------------------------------- | -| `stale_queued` | warn | 排队超过 10 分钟 | -| `stale_running` | error | 运行超过 30 分钟 | -| `lost` | error | 运行时支撑的任务所有权已消失 | +| `stale_queued` | warn | 已排队超过 10 分钟 | +| `stale_running` | error | 已运行超过 30 分钟 | +| `lost` | error | 运行时支持的任务归属已消失 | | `delivery_failed` | warn | 投递失败且通知策略不是 `silent` | -| `missing_cleanup` | warn | 终态任务没有 cleanup 时间戳 | -| `inconsistent_timestamps` | warn | 时间线违规（例如结束早于开始） | +| `missing_cleanup` | warn | 终态任务缺少 cleanup 时间戳 | +| `inconsistent_timestamps` | warn | 时间线冲突（例如结束时间早于开始时间） | ### `tasks maintenance` @@ -213,20 +213,20 @@ openclaw tasks maintenance [--json] openclaw tasks maintenance --apply [--json] ``` -使用它来预览或应用任务及 Task Flow 状态的协调、清理时间戳记录和清理删除。 +用它来预览或应用任务与 Task Flow 状态的对账、清理时间戳补全和清理删除。 -协调是感知运行时类型的： +对账是感知运行时的： -- ACP / 子智能体任务会检查其底层子会话。 +- ACP / 子智能体任务会检查其后备子会话。 - Cron 任务会检查 cron 运行时是否仍拥有该作业。 - 基于聊天的 CLI 任务会检查所属的实时运行上下文，而不只是聊天会话行。 -完成清理同样是感知运行时类型的： +完成后的清理也是感知运行时的： -- 子智能体完成时，会尽最大努力在继续公告清理前关闭该子会话跟踪的浏览器标签页 / 进程。 -- 隔离的 cron 完成时，会尽最大努力在运行彻底拆除前关闭该 cron 会话跟踪的浏览器标签页 / 进程。 -- 隔离的 cron 投递会在需要时等待后代子智能体的后续处理完成，并抑制过期的父级确认文本，而不是将其公告出去。 -- 子智能体完成投递会优先采用最新可见的助手文本；如果该文本为空，则回退为净化后的最新 tool / toolResult 文本，而仅由超时工具调用构成的运行则可以折叠为简短的部分进度摘要。 +- 子智能体完成时，会尽力在继续执行通知后的清理之前关闭子会话中已跟踪的浏览器标签页 / 进程。 +- 隔离的 cron 完成时，会尽力在运行彻底结束前关闭 cron 会话中已跟踪的浏览器标签页 / 进程。 +- 隔离的 cron 投递会在需要时等待后代子智能体的后续处理完成，并抑制过期的父级确认文本，而不是宣布该文本。 +- 子智能体完成投递优先使用最新的可见 assistant 文本；如果该文本为空，则回退到已清理的最新 tool / toolResult 文本，而仅包含超时工具调用的运行可以折叠为简短的部分进度摘要。 - 清理失败不会掩盖真实的任务结果。 ### `tasks flow list|show|cancel` @@ -237,50 +237,50 @@ openclaw tasks flow show [--json] openclaw tasks flow cancel ``` -当你关心的是编排中的 Task Flow，而不是某一条单独的后台任务记录时，请使用这些命令。 +当你真正关心的是编排中的 Task Flow，而不是某一条单独的后台任务记录时，请使用这些命令。 ## 聊天任务面板（`/tasks`） -在任意聊天会话中使用 `/tasks` 可查看关联到该会话的后台任务。该面板会显示活动和最近完成的任务，以及它们的运行时、状态、时间信息，以及进度或错误详情。 +在任意聊天会话中使用 `/tasks` 可查看与该会话关联的后台任务。该面板会显示活动中和最近已完成的任务，包括运行时、状态、时间，以及进度或错误详情。 -当当前会话没有可见的关联任务时，`/tasks` 会回退为智能体本地任务计数，这样你仍然可以获得概览，而不会泄露其他会话的详情。 +当当前会话没有可见的关联任务时，`/tasks` 会回退为显示智能体本地任务计数，这样你仍能获得概览，同时不会泄露其他会话的详情。 -如需查看完整的操作员台账，请使用 CLI：`openclaw tasks list`。 +如需完整的操作员台账，请使用 CLI：`openclaw tasks list`。 ## 状态集成（任务压力） -`openclaw status` 包含一个任务概览摘要： +`openclaw status` 包含一个一目了然的任务摘要： ``` Tasks: 3 queued · 2 running · 1 issues ``` -该摘要报告： +该摘要会报告： -- **active**——`queued` + `running` 的数量 -- **failures**——`failed` + `timed_out` + `lost` 的数量 -- **byRuntime**——按 `acp`、`subagent`、`cron`、`cli` 分项统计 +- **active** —— `queued` + `running` 的数量 +- **failures** —— `failed` + `timed_out` + `lost` 的数量 +- **byRuntime** —— 按 `acp`、`subagent`、`cron`、`cli` 分类的明细 -`/status` 和 `session_status` 工具都使用“感知清理状态”的任务快照：会优先显示活动任务，隐藏过期的已完成记录，并且仅在没有活动工作剩余时才显示最近失败项。这样可以让状态卡片聚焦于当前真正重要的内容。 +`/status` 和 `session_status` 工具都使用带清理感知的任务快照：优先显示活动任务，隐藏过期的已完成记录，并且只有在没有活动工作剩余时才显示最近失败。这让状态卡聚焦于当前真正重要的内容。 ## 存储和维护 ### 任务存储位置 -任务记录会持久化到以下 SQLite 位置： +任务记录持久化到以下 SQLite 位置： ``` $OPENCLAW_STATE_DIR/tasks/runs.sqlite ``` -注册表会在 Gateway 网关启动时加载到内存中，并将写入同步到 SQLite，以便在重启后仍具备持久性。 +注册表会在 Gateway 网关启动时加载到内存中，并将写入同步到 SQLite，以便在重启后仍能保持持久性。 ### 自动维护 清扫器每 **60 秒**运行一次，并处理三件事： -1. **协调**——检查活动任务是否仍有权威性的运行时支撑。ACP / 子智能体任务使用子会话状态，cron 任务使用活动作业所有权，而基于聊天的 CLI 任务使用所属运行上下文。如果该支撑状态消失超过 5 分钟，则任务会被标记为 `lost`。 -2. **清理时间戳记录**——为终态任务设置 `cleanupAfter` 时间戳（`endedAt + 7 days`）。 +1. **对账**——检查活动任务是否仍具有权威的运行时后备支持。ACP / 子智能体任务使用子会话状态，cron 任务使用活动作业归属，基于聊天的 CLI 任务使用所属运行上下文。如果该后备状态消失超过 5 分钟，任务会被标记为 `lost`。 +2. **清理时间戳补全**——为终态任务设置 `cleanupAfter` 时间戳（endedAt + 7 天）。 3. **清理删除**——删除超过其 `cleanupAfter` 日期的记录。 **保留期**：终态任务记录会保留 **7 天**，然后自动清理。无需任何配置。 @@ -289,25 +289,25 @@ $OPENCLAW_STATE_DIR/tasks/runs.sqlite ### 任务与 Task Flow -[Task Flow](/zh-CN/automation/taskflow) 是位于后台任务之上的流程编排层。单个流程在其生命周期内可能通过受管或镜像同步模式协调多个任务。使用 `openclaw tasks` 检查单个任务记录，使用 `openclaw tasks flow` 检查编排中的流程。 +[Task Flow](/zh-CN/automation/taskflow) 是位于后台任务之上的流程编排层。单个 flow 在其生命周期内可能通过托管或镜像同步模式协调多个任务。使用 `openclaw tasks` 检查单个任务记录，使用 `openclaw tasks flow` 检查编排 flow。 -详见 [Task Flow](/zh-CN/automation/taskflow)。 +详情请参阅 [Task Flow](/zh-CN/automation/taskflow)。 ### 任务与 cron -cron 作业的**定义**位于 `~/.openclaw/cron/jobs.json`。**每次** cron 执行都会创建任务记录——无论是主会话模式还是隔离模式。主会话 cron 任务默认使用 `silent` 通知策略，因此它们只做跟踪，不生成通知。 +cron 作业**定义**存储在 `~/.openclaw/cron/jobs.json` 中。**每一次** cron 执行都会创建任务记录——包括主会话和隔离运行。主会话 cron 任务默认使用 `silent` 通知策略，因此它们只做跟踪而不会生成通知。 -参见 [Cron Jobs](/zh-CN/automation/cron-jobs)。 +请参阅 [Cron Jobs](/zh-CN/automation/cron-jobs)。 -### 任务与 heartbeat +### 任务与心跳 -Heartbeat 运行属于主会话回合——它们不会创建任务记录。当任务完成时，它可以触发 heartbeat 唤醒，让你及时看到结果。 +心跳运行属于主会话轮次——它们不会创建任务记录。任务完成时，可以触发一次心跳唤醒，以便你及时看到结果。 -参见 [Heartbeat](/zh-CN/gateway/heartbeat)。 +请参阅 [Heartbeat](/zh-CN/gateway/heartbeat)。 ### 任务与会话 -一个任务可能会引用 `childSessionKey`（工作运行的位置）和 `requesterSessionKey`（发起者）。会话是对话上下文；任务则是在其之上的活动跟踪。 +一个任务可能会引用 `childSessionKey`（工作运行的位置）和 `requesterSessionKey`（谁发起了它）。会话是对话上下文；任务则是在其之上的活动跟踪。 ### 任务与智能体运行 @@ -315,8 +315,8 @@ Heartbeat 运行属于主会话回合——它们不会创建任务记录。当 ## 相关内容 -- [自动化与任务](/zh-CN/automation)——所有自动化机制一览 -- [Task Flow](/zh-CN/automation/taskflow)——位于任务之上的流程编排 -- [计划任务](/zh-CN/automation/cron-jobs)——调度后台工作 -- [Heartbeat](/zh-CN/gateway/heartbeat)——周期性的主会话回合 -- [CLI：任务](/cli/index#tasks)——CLI 命令参考 +- [自动化与任务](/zh-CN/automation) —— 所有自动化机制总览 +- [Task Flow](/zh-CN/automation/taskflow) —— 位于任务之上的流程编排 +- [计划任务](/zh-CN/automation/cron-jobs) —— 调度后台工作 +- [Heartbeat](/zh-CN/gateway/heartbeat) —— 周期性的主会话轮次 +- [CLI：任务](/cli/index#tasks) —— CLI 命令参考 diff --git a/docs/zh-CN/gateway/configuration-reference.md b/docs/zh-CN/gateway/configuration-reference.md index 76f9f1ab7..687e8987e 100644 --- a/docs/zh-CN/gateway/configuration-reference.md +++ b/docs/zh-CN/gateway/configuration-reference.md @@ -1,56 +1,56 @@ --- read_when: - 你需要精确到字段级别的配置语义或默认值 - - 你正在校验渠道、模型、Gateway 网关或工具配置块 + - 你正在验证渠道、模型、Gateway 网关或工具配置块 summary: 每个 OpenClaw 配置键、默认值和渠道设置的完整参考 title: 配置参考 x-i18n: - generated_at: "2026-04-06T02:29:17Z" + generated_at: "2026-04-06T02:35:56Z" model: gpt-5.4 provider: openai - source_hash: 266cbb43d9a4b4a3e8839dc8bc6c6d06382ecbbe33210c702f7699b47988123d + source_hash: 6aa6b24b593f6f07118817afabea4cc7842aca6b7c5602b45f479b40c1685230 source_path: gateway/configuration-reference.md workflow: 15 --- # 配置参考 -`~/.openclaw/openclaw.json` 中可用的每个字段。关于面向任务的概览，请参见 [Configuration](/zh-CN/gateway/configuration)。 +`~/.openclaw/openclaw.json` 中可用的每个字段。要查看面向任务的概览，请参阅 [Configuration](/zh-CN/gateway/configuration)。 -配置格式为 **JSON5**（允许注释 + 尾随逗号）。所有字段都是可选的——省略时，OpenClaw 会使用安全的默认值。 +配置格式为 **JSON5**（允许注释和尾随逗号）。所有字段都是可选的——省略时，OpenClaw 会使用安全的默认值。 --- ## 渠道 -每个渠道在其配置段存在时都会自动启动（除非设置了 `enabled: false`）。 +当每个渠道的配置部分存在时，它会自动启动（除非设置了 `enabled: false`）。 ### 私信和群组访问 所有渠道都支持私信策略和群组策略： -| 私信策略 | 行为 | -| ------------------- | -------------------------------------------------------------- | -| `pairing`（默认） | 未知发送者会收到一次性配对码；必须由所有者批准 | -| `allowlist` | 仅允许 `allowFrom`（或已配对允许存储）中的发送者 | -| `open` | 允许所有传入私信（需要 `allowFrom: ["*"]`） | -| `disabled` | 忽略所有传入私信 | +| 私信策略 | 行为 | +| ------------------- | -------------------------------------------- | +| `pairing`（默认） | 未知发送者会收到一次性配对码；所有者必须批准 | +| `allowlist` | 仅允许 `allowFrom` 中的发送者（或已配对允许存储） | +| `open` | 允许所有传入私信（需要 `allowFrom: ["*"]`） | +| `disabled` | 忽略所有传入私信 | -| 群组策略 | 行为 | -| --------------------- | ------------------------------------------------------ | -| `allowlist`（默认） | 仅允许匹配已配置允许列表的群组 | -| `open` | 绕过群组允许列表（仍会应用提及门控） | -| `disabled` | 阻止所有群组/房间消息 | +| 群组策略 | 行为 | +| --------------------- | -------------------------------------------------- | +| `allowlist`（默认） | 仅允许匹配已配置允许列表的群组 | +| `open` | 绕过群组允许列表（仍然应用提及门控） | +| `disabled` | 屏蔽所有群组/房间消息 | -`channels.defaults.groupPolicy` 在提供商的 `groupPolicy` 未设置时设置默认值。 -配对码会在 1 小时后过期。待处理的私信配对请求每个渠道最多 **3 个**。 -如果某个提供商配置块完全缺失（即不存在 `channels.`），运行时群组策略会回退为 `allowlist`（故障时默认关闭），并在启动时给出警告。 +当提供商的 `groupPolicy` 未设置时，`channels.defaults.groupPolicy` 会设置默认值。 +配对码会在 1 小时后过期。待处理的私信配对请求每个渠道最多为 **3 个**。 +如果某个提供商配置块完全缺失（即不存在 `channels.`），运行时群组策略会回退到 `allowlist`（失败时默认关闭），并在启动时发出警告。 ### 渠道模型覆盖 -使用 `channels.modelByChannel` 将特定渠道 ID 固定到某个模型。值接受 `provider/model` 或已配置的模型别名。仅当某个会话尚未有模型覆盖时（例如通过 `/model` 设置），才会应用该渠道映射。 +使用 `channels.modelByChannel` 将特定渠道 ID 固定到某个模型。值可接受 `provider/model` 或已配置的模型别名。当某个会话尚未拥有模型覆盖时（例如通过 `/model` 设置），才会应用该渠道映射。 ```json5 { @@ -71,9 +71,9 @@ x-i18n: } ``` -### 渠道默认值与心跳 +### 渠道默认值和心跳 -使用 `channels.defaults` 为各提供商设置共享的群组策略和心跳行为： +使用 `channels.defaults` 为各个提供商共享群组策略和心跳行为： ```json5 { @@ -91,15 +91,15 @@ x-i18n: } ``` -- `channels.defaults.groupPolicy`：当提供商级 `groupPolicy` 未设置时的回退群组策略。 +- `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, // 蓝色双勾（自聊模式下为 false） + sendReadReceipts: true, // 蓝色对勾（在 self-chat 模式下为 false） groups: { "*": { requireMention: true }, }, @@ -150,10 +150,10 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。当存在 } ``` -- 出站命令默认使用 `default` 账号（如果存在）；否则使用第一个已配置的账号 id（排序后）。 -- 可选的 `channels.whatsapp.defaultAccount` 会在其匹配已配置账号 id 时，覆盖该回退默认账号选择。 +- 出站命令默认使用账号 `default`（如果存在）；否则使用第一个已配置的账号 id（排序后）。 +- 可选的 `channels.whatsapp.defaultAccount` 会在匹配已配置账号 id 时覆盖该后备默认账号选择。 - 旧版单账号 Baileys 认证目录会由 `openclaw doctor` 迁移到 `whatsapp/default`。 -- 按账号覆盖：`channels.whatsapp.accounts..sendReadReceipts`、`channels.whatsapp.accounts..dmPolicy`、`channels.whatsapp.accounts..allowFrom`。 +- 每账号覆盖：`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（默认：off；如需避免预览编辑速率限制，请显式启用） actions: { reactions: true, sendMessage: true }, reactionNotifications: "own", // off | own | all mediaMaxMb: 100, @@ -211,12 +211,12 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。当存在 } ``` -- Bot token：`channels.telegram.botToken` 或 `channels.telegram.tokenFile`（仅接受普通文件；拒绝符号链接），默认账号可回退到 `TELEGRAM_BOT_TOKEN`。 -- 可选的 `channels.telegram.defaultAccount` 会在其匹配已配置账号 id 时覆盖默认账号选择。 -- 在多账号设置（2 个或更多账号 id）中，请设置显式默认值（`channels.telegram.defaultAccount` 或 `channels.telegram.accounts.default`）以避免回退路由；缺失或无效时，`openclaw doctor` 会给出警告。 -- `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`（适用于私聊和群聊）。 +- 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`（可用于私聊和群聊）。 - 重试策略：参见 [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（在 Discord 上，progress 会映射为 partial） + streaming: "off", // off | partial | block | progress（在 Discord 上 progress 会映射为 partial） 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, // 为 `sessions_spawn({ thread: true })` 显式启用 }, voice: { enabled: true, @@ -320,35 +320,35 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。当存在 ``` - Token：`channels.discord.token`，默认账号可回退到 `DISCORD_BOT_TOKEN`。 -- 提供显式 Discord `token` 的直接出站调用会对此次调用使用该 token；账号级重试/策略设置仍来自当前运行时快照中选定的账号。 -- 可选的 `channels.discord.defaultAccount` 会在其匹配已配置账号 id 时覆盖默认账号选择。 -- 使用 `user:`（私信）或 `channel:`（服务器频道）作为投递目标；拒绝裸数字 ID。 -- 服务器 slug 使用小写并将空格替换为 `-`；频道键使用 slug 化名称（不含 `#`）。优先使用服务器 ID。 -- 默认会忽略机器人发布的消息。`allowBots: true` 可启用；使用 `allowBots: "mentions"` 则只接受提及该机器人的机器人消息（仍会过滤自身消息）。 -- `channels.discord.guilds..ignoreOtherMentions`（及频道级覆盖）会丢弃提及了其他用户或角色但未提及机器人的消息（不包括 @everyone/@here）。 -- `maxLinesPerMessage`（默认 17）即使在少于 2000 字符时，也会拆分过高的消息。 +- 直接出站调用如果提供了显式 Discord `token`，则调用会使用该 token；账号重试/策略设置仍来自活动运行时快照中所选账号。 +- 可选的 `channels.discord.defaultAccount` 会在匹配已配置账号 id 时覆盖默认账号选择。 +- 交付目标使用 `user:`（私信）或 `channel:`（guild 渠道）；裸数字 ID 会被拒绝。 +- Guild slug 会转换为小写并将空格替换为 `-`；渠道键使用 slug 化名称（不带 `#`）。优先使用 guild ID。 +- 默认会忽略机器人撰写的消息。`allowBots: true` 会启用它们；使用 `allowBots: "mentions"` 则只接受提及该机器人的机器人消息（仍会过滤自身消息）。 +- `channels.discord.guilds..ignoreOtherMentions`（以及渠道覆盖）会丢弃那些提及其他用户或角色、但未提及机器人的消息（不包括 @everyone/@here）。 +- `maxLinesPerMessage`（默认 17）即使在未超过 2000 字符时，也会拆分过高的消息。 - `channels.discord.threadBindings` 控制 Discord 线程绑定路由： - - `enabled`：线程绑定会话功能的 Discord 覆盖（`/focus`、`/unfocus`、`/agents`、`/session idle`、`/session max-age`，以及绑定投递/路由） - - `idleHours`：按小时计算的 Discord 非活动自动取消聚焦覆盖（`0` 表示禁用） - - `maxAgeHours`：按小时计算的 Discord 硬性最大存活时间覆盖（`0` 表示禁用） - - `spawnSubagentSessions`：为 `sessions_spawn({ thread: true })` 自动创建/绑定线程的选择启用开关 -- 顶层 `bindings[]` 中 `type: "acp"` 的条目可为频道和线程配置持久 ACP 绑定（在 `match.peer.id` 中使用频道/线程 id）。字段语义与 [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings) 共享。 -- `channels.discord.ui.components.accentColor` 设置 Discord components v2 容器的强调色。 + - `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` 会重新启用可变名称/标签匹配（紧急兼容模式）。 -- `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"` 两者都发。当目标包含 `"channel"` 时，按钮仅对已解析的审批人可用。 - - `cleanupAfterResolve`：为 `true` 时，在批准、拒绝或超时后删除审批私信。 +- 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"` 同时发送。若 target 包含 `"channel"`，按钮仅可由已解析的审批者使用。 + - `cleanupAfterResolve`：当为 `true` 时，在审批、拒绝或超时后删除审批私信。 -**反应通知模式：** `off`（无）、`own`（机器人自己的消息，默认）、`all`（所有消息）、`allowlist`（来自 `guilds..users`，适用于所有消息）。 +**反应通知模式：** `off`（无）、`own`（机器人自己的消息，默认）、`all`（所有消息）、`allowlist`（来自 `guilds..users`，作用于所有消息）。 ### Google Chat @@ -382,8 +382,8 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。当存在 - 服务账号 JSON：可内联（`serviceAccount`）或基于文件（`serviceAccountFile`）。 - 也支持服务账号 SecretRef（`serviceAccountRef`）。 - 环境变量回退：`GOOGLE_CHAT_SERVICE_ACCOUNT` 或 `GOOGLE_CHAT_SERVICE_ACCOUNT_FILE`。 -- 使用 `spaces/` 或 `users/` 作为投递目标。 -- `channels.googlechat.dangerouslyAllowNameMatching` 会重新启用可变邮箱主体匹配（紧急兼容模式）。 +- 交付目标使用 `spaces/` 或 `users/`。 +- `channels.googlechat.dangerouslyAllowNameMatching` 会重新启用可变电子邮件主体匹配（紧急兼容模式）。 ### Slack @@ -449,28 +449,28 @@ WhatsApp 通过 Gateway 网关的 Web 渠道（Baileys Web）运行。当存在 ``` - **Socket mode** 需要同时提供 `botToken` 和 `appToken`（默认账号环境变量回退为 `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN`）。 -- **HTTP mode** 需要 `botToken` 加 `signingSecret`（可在根级或按账号设置）。 +- **HTTP mode** 需要 `botToken` 和 `signingSecret`（位于根级别或每账号级别）。 - `botToken`、`appToken`、`signingSecret` 和 `userToken` 接受明文字符串或 SecretRef 对象。 -- Slack 账号快照会暴露按凭证划分的来源/状态字段，例如 `botTokenSource`、`botTokenStatus`、`appTokenStatus`，以及在 HTTP 模式下的 `signingSecretStatus`。`configured_unavailable` 表示该账号通过 SecretRef 配置，但当前命令/运行时路径无法解析该 secret 值。 +- Slack 账号快照会暴露每项凭据的来源/状态字段，例如 `botTokenSource`、`botTokenStatus`、`appTokenStatus`，以及在 HTTP 模式下的 `signingSecretStatus`。`configured_unavailable` 表示该账号通过 SecretRef 配置，但当前命令/运行时路径无法解析该 secret 值。 - `configWrites: false` 会阻止由 Slack 发起的配置写入。 -- 可选的 `channels.slack.defaultAccount` 会在其匹配已配置账号 id 时覆盖默认账号选择。 -- `channels.slack.streaming` 是规范的流式模式键。旧版 `streamMode` 和布尔值 `streaming` 会自动迁移。 -- 使用 `user:`（私信）或 `channel:` 作为投递目标。 +- 可选的 `channels.slack.defaultAccount` 会在匹配已配置账号 id 时覆盖默认账号选择。 +- `channels.slack.streaming` 是规范的流式模式键。旧版 `streamMode` 和布尔型 `streaming` 值会自动迁移。 +- 交付目标使用 `user:`（私信）或 `channel:`（渠道）。 **反应通知模式：** `off`、`own`（默认）、`all`、`allowlist`（来自 `reactionAllowlist`）。 -**线程会话隔离：** `thread.historyScope` 为每线程（默认）或整个频道共享。`thread.inheritParent` 会将父频道转录复制到新线程中。 +**线程会话隔离：** `thread.historyScope` 为按线程（默认）或在整个渠道内共享。`thread.inheritParent` 会将父渠道的会话记录复制到新线程。 -- `typingReaction` 会在回复运行期间给传入的 Slack 消息临时添加一个 reaction，完成后移除。请使用 Slack emoji 简码，例如 `"hourglass_flowing_sand"`。 -- `channels.slack.execApprovals`：Slack 原生 exec 审批投递和审批人授权。与 Discord 使用相同 schema：`enabled`（`true`/`false`/`"auto"`）、`approvers`（Slack 用户 ID）、`agentFilter`、`sessionFilter` 和 `target`（`"dm"`、`"channel"` 或 `"both"`）。 +- `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 | 启用 | 添加 reaction + 列表 | -| messages | 启用 | 读取/发送/编辑/删除 | -| pins | 启用 | 固定/取消固定/列表 | -| memberInfo | 启用 | 成员信息 | -| emojiList | 启用 | 自定义 emoji 列表 | +| 操作组 | 默认值 | 说明 | +| ----------- | -------- | -------------------- | +| reactions | 已启用 | 添加反应 + 列出反应 | +| messages | 已启用 | 读取/发送/编辑/删除 | +| pins | 已启用 | 置顶/取消置顶/列出 | +| memberInfo | 已启用 | 成员信息 | +| emojiList | 已启用 | 自定义 emoji 列表 | ### Mattermost @@ -491,10 +491,10 @@ Mattermost 作为插件提供：`openclaw plugins install @openclaw/mattermost` "team-channel-id": { requireMention: false }, }, commands: { - native: true, // 选择启用 + native: true, // 显式启用 nativeSkills: true, callbackPath: "/api/channels/mattermost/command", - // 可选：用于反向代理/公共部署的显式 URL + // 反向代理/公网部署时可选的显式 URL callbackUrl: "https://gateway.example.com/api/channels/mattermost/command", }, textChunkLimit: 4000, @@ -506,17 +506,19 @@ Mattermost 作为插件提供：`openclaw plugins install @openclaw/mattermost` 聊天模式：`oncall`（在 @ 提及时回复，默认）、`onmessage`（每条消息都回复）、`onchar`（以触发前缀开头的消息）。 -当启用 Mattermost 原生命令时： +启用 Mattermost 原生命令时： -- `commands.callbackPath` 必须是路径（例如 `/api/channels/mattermost/command`），而不是完整 URL。 -- `commands.callbackUrl` 必须解析到 OpenClaw Gateway 网关端点，并且 Mattermost 服务器能够访问。 -- 原生斜杠命令回调使用 Mattermost 在斜杠命令注册期间返回的每命令 token 进行认证。如果注册失败或没有激活任何命令，OpenClaw 会拒绝回调，并返回 `Unauthorized: invalid command token.`。 -- 对于私有/tailnet/内部回调主机，Mattermost 可能要求 `ServiceSettings.AllowedUntrustedInternalConnections` 包含回调主机/域名。 - 请使用主机/域名值，而不是完整 URL。 +- `commands.callbackPath` 必须是路径（例如 `/api/channels/mattermost/command`），不能是完整 URL。 +- `commands.callbackUrl` 必须解析到 OpenClaw Gateway 网关端点，并且 Mattermost 服务器必须可访问该地址。 +- 原生 slash 回调使用 Mattermost 在 slash 命令注册期间返回的每命令 token 进行认证。如果注册失败或没有任何命令被激活，OpenClaw 会以 + `Unauthorized: invalid command token.` 拒绝回调。 +- 对于私有/tailnet/内部回调主机，Mattermost 可能需要 + `ServiceSettings.AllowedUntrustedInternalConnections` 包含回调主机/域名。 + 使用主机/域名值，不要使用完整 URL。 - `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 @@ -541,11 +543,11 @@ Mattermost 作为插件提供：`openclaw plugins install @openclaw/mattermost` - `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 { @@ -560,14 +562,14 @@ BlueBubbles 是推荐的 iMessage 路径（基于插件，在 `channels.bluebubb } ``` -- 这里涵盖的核心键路径：`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)。 +- 完整的 BlueBubbles 渠道配置见 [BlueBubbles](/zh-CN/channels/bluebubbles)。 ### iMessage -OpenClaw 会生成 `imsg rpc`（通过 stdio 的 JSON-RPC）。不需要守护进程或端口。 +OpenClaw 会启动 `imsg rpc`（基于 stdio 的 JSON-RPC）。无需守护进程或端口。 ```json5 { @@ -591,15 +593,15 @@ OpenClaw 会生成 `imsg rpc`（通过 stdio 的 JSON-RPC）。不需要守护 } ``` -- 可选的 `channels.imessage.defaultAccount` 会在其匹配已配置账号 id 时覆盖默认账号选择。 +- 可选的 `channels.imessage.defaultAccount` 会在匹配已配置账号 id 时覆盖默认账号选择。 -- 需要对 Messages 数据库授予 Full Disk Access。 -- 优先使用 `chat_id:` 目标。使用 `imsg chats --limit 20` 列出聊天。 +- 需要对 Messages DB 授予完整磁盘访问权限。 +- 优先使用 `chat_id:` 目标。使用 `imsg chats --limit 20` 可列出聊天。 - `cliPath` 可以指向 SSH 包装器；设置 `remoteHost`（`host` 或 `user@host`）以通过 SCP 获取附件。 - `attachmentRoots` 和 `remoteAttachmentRoots` 会限制传入附件路径（默认：`/Users/*/Library/Messages/Attachments`）。 - SCP 使用严格主机密钥检查，因此请确保中继主机密钥已存在于 `~/.ssh/known_hosts` 中。 - `channels.imessage.configWrites`：允许或拒绝由 iMessage 发起的配置写入。 -- 顶层 `bindings[]` 中 `type: "acp"` 的条目可将 iMessage 会话绑定到持久 ACP 会话。在 `match.peer.id` 中使用规范化 handle 或显式聊天目标（`chat_id:*`、`chat_guid:*`、`chat_identifier:*`）。共享字段语义： [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings)。 +- 顶层 `bindings[]` 中 `type: "acp"` 的条目可将 iMessage 会话绑定到持久 ACP 会话。在 `match.peer.id` 中使用规范化后的 handle 或显式聊天目标（`chat_id:*`、`chat_guid:*`、`chat_identifier:*`）。共享字段语义： [ACP Agents](/zh-CN/tools/acp-agents#channel-specific-settings)。 @@ -612,7 +614,7 @@ exec ssh -T gateway-host imsg "$@" ### Matrix -Matrix 由扩展提供，并在 `channels.matrix` 下配置。 +Matrix 由扩展支持，并在 `channels.matrix` 下配置。 ```json5 { @@ -643,23 +645,23 @@ Matrix 由扩展提供，并在 `channels.matrix` 下配置。 ``` - Token 认证使用 `accessToken`；密码认证使用 `userId` + `password`。 -- `channels.matrix.proxy` 会将 Matrix HTTP 流量路由到显式 HTTP(S) 代理。命名账号可以用 `channels.matrix.accounts..proxy` 覆盖。 +- `channels.matrix.proxy` 会通过显式 HTTP(S) 代理路由 Matrix HTTP 流量。命名账号可通过 `channels.matrix.accounts..proxy` 覆盖它。 - `channels.matrix.allowPrivateNetwork` 允许私有/内部 homeserver。`proxy` 和 `allowPrivateNetwork` 是彼此独立的控制项。 -- `channels.matrix.defaultAccount` 在多账号设置中选择首选账号。 -- `channels.matrix.execApprovals`：Matrix 原生 exec 审批投递和审批人授权。 - - `enabled`：`true`、`false` 或 `"auto"`（默认）。在 auto 模式下，当可以从 `approvers` 或 `commands.ownerAllowFrom` 解析出审批人时，会激活 exec 审批。 - - `approvers`：允许批准 exec 请求的 Matrix 用户 ID（例如 `@owner:example.org`）。 - - `agentFilter`：可选智能体 ID 允许列表。省略则为所有智能体转发审批。 - - `sessionFilter`：可选会话键模式（子串或正则）。 - - `target`：审批提示的发送位置。`"dm"`（默认）、`"channel"`（来源房间）或 `"both"`。 - - 按账号覆盖：`channels.matrix.accounts..execApprovals`。 -- `channels.matrix.dm.sessionScope` 控制 Matrix 私信如何归入会话：`per-user`（默认）按路由对等方共享，而 `per-room` 会隔离每个私信房间。 -- Matrix 状态探测和在线目录查找与运行时流量使用相同的代理策略。 -- 完整的 Matrix 配置、目标规则和设置示例记录于 [Matrix](/zh-CN/channels/matrix)。 +- `channels.matrix.defaultAccount` 会在多账号配置中选择首选账号。 +- `channels.matrix.execApprovals`：Matrix 原生 exec 审批交付和审批者授权。 + - `enabled`：`true`、`false` 或 `"auto"`（默认）。在自动模式下，当可以从 `approvers` 或 `commands.ownerAllowFrom` 解析出审批者时，会激活 exec 审批。 + - `approvers`：允许审批 exec 请求的 Matrix 用户 ID（例如 `@owner:example.org`）。 + - `agentFilter`：可选的智能体 ID 允许列表。省略时转发所有智能体的审批。 + - `sessionFilter`：可选的会话键模式（子串或正则）。 + - `target`：审批提示发送位置。`"dm"`（默认）、`"channel"`（原始房间）或 `"both"`。 + - 每账号覆盖：`channels.matrix.accounts..execApprovals`。 +- `channels.matrix.dm.sessionScope` 控制 Matrix 私信如何归入会话：`per-user`（默认）按路由对端共享，`per-room` 则隔离每个私信房间。 +- Matrix 状态探测和实时目录查找与运行时流量使用相同的代理策略。 +- 完整的 Matrix 配置、目标规则和设置示例见 [Matrix](/zh-CN/channels/matrix)。 ### Microsoft Teams -Microsoft Teams 由扩展提供，并在 `channels.msteams` 下配置。 +Microsoft Teams 由扩展支持，并在 `channels.msteams` 下配置。 ```json5 { @@ -667,19 +669,19 @@ Microsoft Teams 由扩展提供，并在 `channels.msteams` 下配置。 msteams: { enabled: true, configWrites: true, - // appId、appPassword、tenantId、webhook、团队/频道策略： + // appId、appPassword、tenantId、webhook、团队/渠道策略： // 参见 /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 -IRC 由扩展提供，并在 `channels.irc` 下配置。 +IRC 由扩展支持，并在 `channels.irc` 下配置。 ```json5 { @@ -700,13 +702,13 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 } ``` -- 这里涵盖的核心键路径：`channels.irc`、`channels.irc.dmPolicy`、`channels.irc.configWrites`、`channels.irc.nickserv.*`。 -- 可选的 `channels.irc.defaultAccount` 会在其匹配已配置账号 id 时覆盖默认账号选择。 -- 完整的 IRC 渠道配置（主机/端口/TLS/频道/允许列表/提及门控）记录于 [IRC](/zh-CN/channels/irc)。 +- 此处覆盖的核心键路径：`channels.irc`、`channels.irc.dmPolicy`、`channels.irc.configWrites`、`channels.irc.nickserv.*`。 +- 可选的 `channels.irc.defaultAccount` 会在匹配已配置账号 id 时覆盖默认账号选择。 +- 完整的 IRC 渠道配置（主机/端口/TLS/渠道/允许列表/提及门控）见 [IRC](/zh-CN/channels/irc)。 ### 多账号（所有渠道） -在每个渠道运行多个账号（每个都有自己的 `accountId`）： +每个渠道运行多个账号（每个都有自己的 `accountId`）： ```json5 { @@ -730,15 +732,15 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 - 当省略 `accountId` 时，使用 `default`（CLI + 路由）。 - 环境变量 token 仅适用于 **default** 账号。 - 基础渠道设置会应用于所有账号，除非按账号覆盖。 -- 使用 `bindings[].match.accountId` 将每个账号路由到不同智能体。 -- 如果你在仍使用单账号顶层渠道配置时，通过 `openclaw channels add`（或渠道新手引导）添加非默认账号，OpenClaw 会先将账号范围的顶层单账号值提升到渠道账号映射中，以保持原账号继续工作。大多数渠道会将它们移到 `channels..accounts.default`；Matrix 则可以保留现有匹配的命名/default 目标。 -- 现有仅按渠道绑定（无 `accountId`）仍会匹配默认账号；账号范围绑定仍是可选的。 -- `openclaw doctor --fix` 也会通过将账号范围的顶层单账号值移动到该渠道所选择的提升账号中来修复混合结构。大多数渠道使用 `accounts.default`；Matrix 则可以保留现有匹配的命名/default 目标。 +- 使用 `bindings[].match.accountId` 将不同账号路由到不同智能体。 +- 如果你通过 `openclaw channels add`（或渠道新手引导）添加非默认账号，而当前仍处于单账号顶层渠道配置，OpenClaw 会先把账号范围的顶层单账号值提升到渠道账号映射中，以确保原始账号继续工作。大多数渠道会将它们移到 `channels..accounts.default`；Matrix 则可以保留现有的匹配命名/默认目标。 +- 现有仅渠道级的绑定（没有 `accountId`）将继续匹配默认账号；账号范围绑定仍是可选的。 +- `openclaw doctor --fix` 还会修复混合结构，方法是将账号范围的顶层单账号值移动到该渠道选定的已提升账号中。大多数渠道使用 `accounts.default`；Matrix 则可以保留现有的匹配命名/默认目标。 ### 其他扩展渠道 -许多扩展渠道配置为 `channels.`，并记录于各自专属的渠道页面中（例如 Feishu、Matrix、LINE、Nostr、Zalo、Nextcloud Talk、Synology Chat 和 Twitch）。 -请参见完整渠道索引：[Channels](/zh-CN/channels)。 +许多扩展渠道以 `channels.` 的形式配置，并记录在各自的专用渠道页面中（例如 Feishu、Matrix、LINE、Nostr、Zalo、Nextcloud Talk、Synology Chat 和 Twitch）。 +查看完整渠道索引：[Channels](/zh-CN/channels)。 ### 群聊提及门控 @@ -746,9 +748,9 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 **提及类型：** -- **元数据提及**：平台原生 @ 提及。在 WhatsApp 自聊模式中会被忽略。 -- **文本模式**：位于 `agents.list[].groupChat.mentionPatterns` 的安全正则模式。无效模式和不安全的嵌套重复会被忽略。 -- 只有在可检测到提及时（原生提及或至少一个模式），才会强制执行提及门控。 +- **元数据提及**：平台原生 @ 提及。在 WhatsApp self-chat 模式下会被忽略。 +- **文本模式**：位于 `agents.list[].groupChat.mentionPatterns` 中的安全正则模式。无效模式和不安全的嵌套重复会被忽略。 +- 仅在能够检测到提及时（原生提及或至少一个模式），才会强制执行提及门控。 ```json5 { @@ -761,7 +763,7 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 } ``` -`messages.groupChat.historyLimit` 设置全局默认值。渠道可以用 `channels..historyLimit`（或按账号）覆盖。设置为 `0` 可禁用。 +`messages.groupChat.historyLimit` 设置全局默认值。渠道可以使用 `channels..historyLimit`（或每账号值）来覆盖。设置为 `0` 可禁用。 #### 私信历史限制 @@ -778,13 +780,13 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 } ``` -解析顺序：按私信覆盖 → 提供商默认值 → 不限制（全部保留）。 +解析顺序：每私信覆盖 → 提供商默认值 → 不限（全部保留）。 支持：`telegram`、`whatsapp`、`discord`、`slack`、`signal`、`imessage`、`msteams`。 -#### 自聊模式 +#### self-chat 模式 -将你自己的号码加入 `allowFrom` 以启用自聊模式（忽略原生 @ 提及，仅响应文本模式）： +将你自己的号码包含在 `allowFrom` 中以启用 self-chat 模式（忽略原生 @ 提及，仅响应文本模式）： ```json5 { @@ -810,7 +812,7 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 ```json5 { commands: { - native: "auto", // 在支持时注册原生命令 + native: "auto", // 在支持的平台上注册原生命令 text: true, // 解析聊天消息中的 /commands bash: false, // 允许 !（别名：/bash） bashForegroundMs: 2000, @@ -829,15 +831,15 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 - 文本命令必须是带前导 `/` 的**独立**消息。 -- `native: "auto"` 会为 Discord/Telegram 开启原生命令，对 Slack 保持关闭。 -- 按渠道覆盖：`channels.discord.commands.native`（布尔值或 `"auto"`）。`false` 会清除之前已注册的命令。 +- `native: "auto"` 会为 Discord/Telegram 打开原生命令，但保持 Slack 关闭。 +- 按渠道覆盖：`channels.discord.commands.native`（布尔值或 `"auto"`）。`false` 会清除先前注册的命令。 - `channels.telegram.customCommands` 会添加额外的 Telegram 机器人菜单项。 -- `bash: true` 启用宿主 Shell 的 `! `。要求 `tools.elevated.enabled`，且发送者位于 `tools.elevated.allowFrom.` 中。 -- `config: true` 启用 `/config`（读取/写入 `openclaw.json`）。对于 gateway `chat.send` 客户端，持久化的 `/config set|unset` 写入还要求 `operator.admin`；只读的 `/config show` 仍对普通写权限 operator 客户端可用。 -- `channels..configWrites` 控制每个渠道的配置变更（默认：true）。 +- `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` 时，命令绕过 access-group 策略。 +- `allowFrom` 是按提供商区分的。设置后，它会成为**唯一**的授权来源（渠道允许列表/配对和 `useAccessGroups` 都会被忽略）。 +- `useAccessGroups: false` 允许在未设置 `allowFrom` 时让命令绕过访问组策略。 @@ -857,7 +859,7 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 ### `agents.defaults.repoRoot` -可选的仓库根目录，会显示在系统提示词的 Runtime 行中。如果未设置，OpenClaw 会从工作区向上遍历自动检测。 +可选的仓库根目录，会显示在系统提示词的 Runtime 行中。如果未设置，OpenClaw 会从工作区开始向上遍历并自动检测。 ```json5 { @@ -883,13 +885,13 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 ``` - 省略 `agents.defaults.skills`，则默认 Skills 不受限制。 -- 省略 `agents.list[].skills`，则继承默认值。 +- 省略 `agents.list[].skills` 将继承默认值。 - 设置 `agents.list[].skills: []` 表示无 Skills。 - 非空的 `agents.list[].skills` 列表就是该智能体的最终集合；不会与默认值合并。 ### `agents.defaults.skipBootstrap` -禁用自动创建工作区 bootstrap 文件（`AGENTS.md`、`SOUL.md`、`TOOLS.md`、`IDENTITY.md`、`USER.md`、`HEARTBEAT.md`、`BOOTSTRAP.md`）。 +禁用自动创建工作区引导文件（`AGENTS.md`、`SOUL.md`、`TOOLS.md`、`IDENTITY.md`、`USER.md`、`HEARTBEAT.md`、`BOOTSTRAP.md`）。 ```json5 { @@ -899,7 +901,7 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 ### `agents.defaults.bootstrapMaxChars` -每个工作区 bootstrap 文件在截断前允许的最大字符数。默认值：`20000`。 +单个工作区引导文件在截断前的最大字符数。默认值：`20000`。 ```json5 { @@ -909,7 +911,7 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 ### `agents.defaults.bootstrapTotalMaxChars` -注入所有工作区 bootstrap 文件的总最大字符数。默认值：`150000`。 +所有工作区引导文件注入内容的总最大字符数。默认值：`150000`。 ```json5 { @@ -919,12 +921,12 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 ### `agents.defaults.bootstrapPromptTruncationWarning` -控制在 bootstrap 上下文被截断时，向智能体显示的警告文本。 +控制当引导上下文被截断时，对智能体可见的警告文本。 默认值：`"once"`。 -- `"off"`：绝不将警告文本注入系统提示词。 -- `"once"`：针对每个唯一截断签名仅注入一次警告（推荐）。 -- `"always"`：存在截断时，每次运行都注入警告。 +- `"off"`：绝不在系统提示词中注入警告文本。 +- `"once"`：每个唯一截断签名仅注入一次警告（推荐）。 +- `"always"`：只要存在截断，每次运行都注入警告。 ```json5 { @@ -934,11 +936,11 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 ### `agents.defaults.imageMaxDimensionPx` -在调用提供商前，转录/工具图像块中图像最长边的最大像素尺寸。 +在调用提供商前，transcript/tool 图像块中最长边的最大像素尺寸。 默认值：`1200`。 -较低的值通常会减少视觉 token 使用量和请求负载大小，尤其适合大量截图的运行。 -较高的值可保留更多视觉细节。 +较低值通常会减少视觉 token 使用量和请求负载大小，适合包含大量截图的运行。 +较高值则会保留更多视觉细节。 ```json5 { @@ -948,7 +950,7 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 ### `agents.defaults.userTimezone` -系统提示词上下文使用的时区（不影响消息时间戳）。会回退到宿主机时区。 +系统提示词上下文使用的时区（不影响消息时间戳）。会回退到主机时区。 ```json5 { @@ -996,7 +998,7 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 primary: "anthropic/claude-opus-4-6", fallbacks: ["openai/gpt-5.4-mini"], }, - params: { cacheRetention: "long" }, // 全局默认提供商参数 + params: { cacheRetention: "long" }, // 全局默认 provider 参数 pdfMaxBytesMb: 10, pdfMaxPages: 20, thinkingDefault: "low", @@ -1015,39 +1017,39 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 - 字符串形式只设置主模型。 - 对象形式设置主模型以及有序故障转移模型。 - `imageModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 被 `image` 工具路径用作视觉模型配置。 - - 当所选/默认模型无法接受图像输入时，也作为回退路由使用。 + - 被 `image` 工具路径用作其视觉模型配置。 + - 当已选/默认模型不能接受图像输入时，也用作后备路由。 - `imageGenerationModel`：接受字符串（`"provider/model"`）或对象（`{ primary, fallbacks }`）。 - - 用于共享图像生成能力，以及任何未来生成图像的工具/插件接口。 - - 典型值：用于原生 Gemini 图像生成的 `google/gemini-3.1-flash-image-preview`，用于 fal 的 `fal/fal-ai/flux/dev`，或用于 OpenAI Images 的 `openai/gpt-image-1`。 - - 如果你直接选择某个 provider/model，也请配置相应的提供商认证/API key（例如 `google/*` 使用 `GEMINI_API_KEY` 或 `GOOGLE_API_KEY`，`openai/*` 使用 `OPENAI_API_KEY`，`fal/*` 使用 `FAL_KEY`）。 - - 如果省略，`image_generate` 仍可推断一个具备认证的提供商默认值。它会先尝试当前默认提供商，再按 provider-id 顺序尝试其余已注册的图像生成提供商。 + - 用于共享的图像生成能力以及任何未来生成图像的工具/插件接口。 + - 常见值：`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` 仍可推断一个具备认证的提供商默认值。它会先尝试当前默认提供商，再按 provider-id 顺序尝试其余已注册的音乐生成提供商。 - - 如果你直接选择某个 provider/model，也请配置相应的提供商认证/API key。 + - 用于共享的音乐生成能力和内置 `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` 仍可推断一个具备认证的提供商默认值。它会先尝试当前默认提供商，再按 provider-id 顺序尝试其余已注册的视频生成提供商。 - - 如果你直接选择某个 provider/model，也请配置相应的提供商认证/API key。 - - 内置的 Qwen 视频生成提供商当前最多支持 1 个输出视频、1 张输入图像、4 个输入视频、10 秒时长，以及提供商级 `size`、`aspectRatio`、`resolution`、`audio` 和 `watermark` 选项。 + - 用于共享的视频生成能力和内置 `video_generate` 工具。 + - 常见值：`qwen/wan2.6-t2v`、`qwen/wan2.6-i2v`、`qwen/wan2.6-r2v`、`qwen/wan2.6-r2v-flash` 或 `qwen/wan2.7-r2v`。 + - 如果省略，`video_generate` 仍可推断出基于认证的提供商默认值。它会先尝试当前默认提供商，然后按提供商 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 大小限制。 + - 被 `pdf` 工具用于模型路由。 + - 如果省略，PDF 工具会回退到 `imageModel`，再回退到已解析的会话/默认模型。 +- `pdfMaxBytesMb`：当调用时未传递 `maxBytesMb` 时，`pdf` 工具使用的默认 PDF 大小限制。 - `pdfMaxPages`：`pdf` 工具在提取回退模式下默认考虑的最大页数。 -- `verboseDefault`：智能体的默认详细级别。取值：`"off"`、`"on"`、`"full"`。默认值：`"off"`。 -- `elevatedDefault`：智能体的默认 elevated-output 级别。取值：`"off"`、`"on"`、`"ask"`、`"full"`。默认值：`"on"`。 -- `model.primary`：格式为 `provider/model`（例如 `openai/gpt-5.4`）。如果省略 provider，OpenClaw 会先尝试别名，然后尝试唯一匹配已配置提供商中该精确模型 id 的项，最后才回退到已配置默认提供商（这是已弃用的兼容行为，因此推荐显式使用 `provider/model`）。如果该提供商不再暴露已配置的默认模型，OpenClaw 会回退到第一个已配置 provider/model，而不是暴露一个过期的、已移除提供商默认值。 -- `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` 和回退添加/删除命令）会保存规范对象形式，并尽可能保留现有回退列表。 -- `maxConcurrent`：跨会话并行智能体运行的最大数量（每个会话本身仍串行）。默认值：4。 +- `verboseDefault`：智能体默认 verbose 级别。取值：`"off"`、`"on"`、`"full"`。默认值：`"off"`。 +- `elevatedDefault`：智能体默认 elevated 输出级别。取值：`"off"`、`"on"`、`"ask"`、`"full"`。默认值：`"on"`。 +- `model.primary`：格式为 `provider/model`（例如 `openai/gpt-5.4`）。如果省略 provider，OpenClaw 会先尝试别名，再尝试已配置提供商中唯一匹配该精确模型 id 的项，最后才回退到已配置的默认提供商（这是已弃用的兼容行为，因此推荐显式使用 `provider/model`）。如果该提供商不再暴露已配置的默认模型，OpenClaw 会回退到第一个已配置的 provider/model，而不是暴露一个陈旧的已移除提供商默认值。 +- `models`：已配置的模型目录和 `/model` 允许列表。每项都可包含 `alias`（快捷方式）和 `params`（provider 特定参数，例如 `temperature`、`maxTokens`、`cacheRetention`、`context1m`）。 +- `params`：应用到所有模型的全局默认 provider 参数。设置在 `agents.defaults.params`（例如 `{ cacheRetention: "long" }`）。 +- `params` 合并优先级（配置）：`agents.defaults.params`（全局基础）会被 `agents.defaults.models["provider/model"].params`（每模型）覆盖，然后再由 `agents.list[].params`（匹配智能体 id）按键覆盖。详情见 [Prompt Caching](/zh-CN/reference/prompt-caching)。 +- 会修改这些字段的配置写入器（例如 `/models set`、`/models set-image` 和后备 add/remove 命令）会保存规范对象形式，并尽可能保留现有后备列表。 +- `maxConcurrent`：跨会话的最大并行智能体运行数（每个会话仍然串行）。默认值：4。 -**内置别名简写**（仅当模型位于 `agents.defaults.models` 中时适用）： +**内置别名简写**（仅当模型位于 `agents.defaults.models` 中时才生效）： | 别名 | 模型 | | ------------------- | -------------------------------------- | @@ -1060,18 +1062,18 @@ IRC 由扩展提供，并在 `channels.irc` 下配置。 | `gemini-flash` | `google/gemini-3-flash-preview` | | `gemini-flash-lite` | `google/gemini-3.1-flash-lite-preview` | -你自己配置的别名始终优先于默认值。 +你配置的别名始终优先于默认值。 -Z.AI GLM-4.x 模型会自动启用 thinking 模式，除非你设置 `--thinking off` 或自行定义 `agents.defaults.models["zai/"].params.thinking`。 -Z.AI 模型默认启用 `tool_stream` 以进行工具调用流式传输。将 `agents.defaults.models["zai/"].params.tool_stream` 设为 `false` 可禁用。 +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。 -- 当设置了 `sessionArg` 时支持会话。 -- 当 `imageArg` 接受文件路径时支持图像透传。 +- 当设置了 `sessionArg` 时，支持会话。 +- 当 `imageArg` 接受文件路径时，支持图像透传。 ### `agents.defaults.heartbeat` -定期心跳运行。 +周期性心跳运行。 ```json5 { @@ -1081,8 +1083,8 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 every: "30m", // 0m 禁用 model: "openai/gpt-5.4-mini", includeReasoning: false, - lightContext: false, // 默认：false；true 时仅保留工作区 bootstrap 文件中的 HEARTBEAT.md - isolatedSession: false, // 默认：false；true 时每次心跳在全新会话中运行（无对话历史） + lightContext: false, // 默认：false；true 时仅从工作区引导文件中保留 HEARTBEAT.md + isolatedSession: false, // 默认：false；true 时每次心跳都在一个全新会话中运行（无对话历史） session: "main", to: "+15555550123", directPolicy: "allow", // allow（默认）| block @@ -1096,13 +1098,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 上下文，并仅保留工作区 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 时，心跳运行使用轻量级引导上下文，并且仅保留工作区引导文件中的 `HEARTBEAT.md`。 +- `isolatedSession`：为 true 时，每次心跳都在一个没有先前对话历史的全新会话中运行。与 cron `sessionTarget: "isolated"` 的隔离模式相同。可将每次心跳的 token 成本从约 100K 降至约 2-5K。 +- 每智能体：设置 `agents.list[].heartbeat`。当任一智能体定义了 `heartbeat` 时，**只有这些智能体**会运行心跳。 +- 心跳会运行完整智能体轮次——间隔越短，消耗的 token 越多。 ### `agents.defaults.compaction` @@ -1115,10 +1117,10 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 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"], // [] 可禁用重新注入 + 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） + notifyUser: true, // 在 compaction 开始时向用户发送简短通知（默认：false） memoryFlush: { enabled: true, softThresholdTokens: 6000, @@ -1131,14 +1133,14 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 } ``` -- `mode`：`default` 或 `safeguard`（针对长历史的分块摘要）。参见 [Compaction](/zh-CN/concepts/compaction)。 -- `timeoutSeconds`：OpenClaw 中止单次 compaction 操作前允许的最长秒数。默认值：`900`。 -- `identifierPolicy`：`strict`（默认）、`off` 或 `custom`。`strict` 会在 compaction 摘要期间预置内置的不透明标识符保留指导。 -- `identifierInstructions`：当 `identifierPolicy=custom` 时，使用的可选自定义标识符保留文本。 -- `postCompactionSections`：可选的 AGENTS.md H2/H3 章节名，会在 compaction 后重新注入。默认值为 `["Session Startup", "Red Lines"]`；设为 `[]` 可禁用重新注入。未设置或显式设置为该默认对时，也接受旧版 `Every Session`/`Safety` 标题作为兼容回退。 -- `model`：仅用于 compaction 摘要的可选 `provider/model-id` 覆盖。当你希望主会话保留一个模型，而 compaction 摘要使用另一个模型时可用；未设置时，compaction 使用会话主模型。 -- `notifyUser`：为 `true` 时，在 compaction 开始时向用户发送简短通知（例如 “Compacting context...”）。默认禁用，以保持 compaction 静默。 -- `memoryFlush`：在自动 compaction 之前进行的静默智能体回合，用于存储持久记忆。工作区为只读时跳过。 +- `mode`：`default` 或 `safeguard`（针对长历史记录的分块摘要）。参见 [Compaction](/zh-CN/concepts/compaction)。 +- `timeoutSeconds`：OpenClaw 在中止前允许单次 compaction 操作持续的最大秒数。默认值：`900`。 +- `identifierPolicy`：`strict`（默认）、`off` 或 `custom`。`strict` 会在 compaction 摘要期间预置内建的不透明标识符保留指导。 +- `identifierInstructions`：当 `identifierPolicy=custom` 时使用的可选自定义标识符保留文本。 +- `postCompactionSections`：在 compaction 后重新注入的可选 `AGENTS.md` H2/H3 章节名称。默认值为 `["Session Startup", "Red Lines"]`；设置为 `[]` 可禁用重新注入。若未设置，或显式设置为这对默认值，也会接受旧版 `Every Session`/`Safety` 标题作为兼容回退。 +- `model`：仅用于 compaction 摘要的可选 `provider/model-id` 覆盖。当主会话应继续使用一个模型，而 compaction 摘要应使用另一个模型时使用；未设置时，compaction 使用会话的主模型。 +- `notifyUser`：当为 `true` 时，在 compaction 开始时向用户发送简短通知（例如 “Compacting context...”）。默认禁用，以保持 compaction 静默进行。 +- `memoryFlush`：在自动 compaction 前执行一次静默的智能体轮次，用于存储持久记忆。工作区为只读时会跳过。 ### `agents.defaults.contextPruning` @@ -1166,23 +1168,23 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 -- `mode: "cache-ttl"` 启用修剪过程。 -- `ttl` 控制多久之后才能再次运行修剪（从上次缓存接触开始计算）。 -- 修剪会先对过大的工具结果进行软截断，如有需要，再对更旧的工具结果进行硬清除。 +- `mode: "cache-ttl"` 会启用修剪过程。 +- `ttl` 控制在上次缓存触碰之后，多久可以再次运行修剪。 +- 修剪会先对超大的工具结果进行软裁剪，如有需要再对更旧的工具结果进行硬清除。 -**软截断**会保留开头 + 结尾，并在中间插入 `...`。 +**软裁剪**保留开头和结尾，并在中间插入 `...`。 **硬清除**会用占位符替换整个工具结果。 注意： -- 图像块永远不会被截断/清除。 -- 比率按字符计算（近似值），并非精确 token 计数。 -- 如果 assistant 消息少于 `keepLastAssistants` 条，则跳过修剪。 +- 图像块永远不会被裁剪/清除。 +- 比例按字符数计算（近似），不是精确 token 数。 +- 如果 assistant 消息数量少于 `keepLastAssistants`，则跳过修剪。 -行为细节请参见 [Session Pruning](/zh-CN/concepts/session-pruning)。 +行为详情请参见 [Session Pruning](/zh-CN/concepts/session-pruning)。 ### 分块流式传输 @@ -1200,13 +1202,13 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 } ``` -- 非 Telegram 渠道需要显式 `*.blockStreaming: true` 才会启用块回复。 -- 渠道覆盖：`channels..blockStreamingCoalesce`（以及按账号变体）。Signal/Slack/Discord/Google Chat 默认 `minChars: 1500`。 -- `humanDelay`：块回复之间的随机暂停。`natural` = 800–2500ms。按智能体覆盖：`agents.list[].humanDelay`。 +- 非 Telegram 渠道需要显式设置 `*.blockStreaming: true` 才能启用分块回复。 +- 渠道覆盖：`channels..blockStreamingCoalesce`（以及每账号变体）。Signal/Slack/Discord/Google Chat 默认 `minChars: 1500`。 +- `humanDelay`：分块回复之间的随机暂停。`natural` = 800–2500ms。每智能体覆盖：`agents.list[].humanDelay`。 -关于行为和分块细节，参见 [Streaming](/zh-CN/concepts/streaming)。 +行为和分块细节请参见 [Streaming](/zh-CN/concepts/streaming)。 -### 正在输入指示器 +### 输入中指示器 ```json5 { @@ -1219,8 +1221,8 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 } ``` -- 默认值：在私聊/被提及时为 `instant`，在未被提及的群聊中为 `message`。 -- 按会话覆盖：`session.typingMode`、`session.typingIntervalSeconds`。 +- 默认值：私聊/被提及时使用 `instant`，未被提及的群聊使用 `message`。 +- 每会话覆盖：`session.typingMode`、`session.typingIntervalSeconds`。 参见 [Typing Indicators](/zh-CN/concepts/typing-indicators)。 @@ -1228,7 +1230,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 ### `agents.defaults.sandbox` -嵌入式智能体的可选沙箱隔离。完整指南请参见 [沙箱隔离](/zh-CN/gateway/sandboxing)。 +为嵌入式智能体提供可选沙箱隔离。完整指南请参见 [Sandboxing](/zh-CN/gateway/sandboxing)。 ```json5 { @@ -1274,7 +1276,7 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 identityFile: "~/.ssh/id_ed25519", certificateFile: "~/.ssh/id_ed25519-cert.pub", knownHostsFile: "~/.ssh/known_hosts", - // 也支持 SecretRefs / 内联内容： + // 也支持 SecretRef / 内联内容： // 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" }, @@ -1331,37 +1333,37 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 - `ssh`：通用 SSH 远程运行时 - `openshell`：OpenShell 运行时 -当选择 `backend: "openshell"` 时，运行时特定设置会移至 +当选择 `backend: "openshell"` 时，运行时特定设置会移动到 `plugins.entries.openshell.config`。 **SSH 后端配置：** - `target`：`user@host[:port]` 形式的 SSH 目标 - `command`：SSH 客户端命令（默认：`ssh`） -- `workspaceRoot`：用于按作用域工作区的绝对远程根目录 -- `identityFile` / `certificateFile` / `knownHostsFile`：传给 OpenSSH 的现有本地文件 -- `identityData` / `certificateData` / `knownHostsData`：OpenClaw 在运行时实体化为临时文件的内联内容或 SecretRef -- `strictHostKeyChecking` / `updateHostKeys`：OpenSSH 主机密钥策略选项 +- `workspaceRoot`：用于每个作用域工作区的绝对远程根路径 +- `identityFile` / `certificateFile` / `knownHostsFile`：传递给 OpenSSH 的现有本地文件 +- `identityData` / `certificateData` / `knownHostsData`：内联内容或 SecretRef，OpenClaw 会在运行时将其实体化为临时文件 +- `strictHostKeyChecking` / `updateHostKeys`：OpenSSH 主机密钥策略旋钮 **SSH 认证优先级：** - `identityData` 优先于 `identityFile` - `certificateData` 优先于 `certificateFile` - `knownHostsData` 优先于 `knownHostsFile` -- 以 SecretRef 为后盾的 `*Data` 值会在沙箱会话启动前，从活动 secrets 运行时快照中解析 +- 基于 SecretRef 的 `*Data` 值会在沙箱会话开始前从活动 secrets 运行时快照中解析 **SSH 后端行为：** -- 在创建或重建后只播种远程工作区一次 -- 然后保持远程 SSH 工作区为规范状态 +- 在创建或重建后，向远程工作区执行一次初始化填充 +- 之后保持远程 SSH 工作区为规范副本 - 通过 SSH 路由 `exec`、文件工具和媒体路径 -- 不会自动将远程更改同步回宿主机 +- 不会自动将远程更改同步回主机 - 不支持沙箱浏览器容器 **工作区访问：** -- `none`：位于 `~/.openclaw/sandboxes` 下按作用域划分的沙箱工作区 -- `ro`：沙箱工作区位于 `/workspace`，智能体工作区只读挂载到 `/agent` +- `none`：在 `~/.openclaw/sandboxes` 下为每个作用域创建沙箱工作区 +- `ro`：沙箱工作区位于 `/workspace`，智能体工作区以只读方式挂载到 `/agent` - `rw`：智能体工作区以读写方式挂载到 `/workspace` **作用域：** @@ -1398,30 +1400,31 @@ Anthropic Claude 4.6 模型在未设置显式 thinking 级别时，默认使用 **OpenShell 模式：** -- `mirror`：在 exec 前将本地播种到远程，在 exec 后同步回来；本地工作区保持为规范状态 -- `remote`：在沙箱创建时仅将本地播种到远程一次，之后保持远程工作区为规范状态 +- `mirror`：在 exec 前从本地初始化远程，exec 后再同步回本地；本地工作区保持为规范副本 +- `remote`：仅在创建沙箱时向远程初始化一次，之后保持远程工作区为规范副本 -在 `remote` 模式下，于 OpenClaw 外部在宿主机本地所做的修改，在播种步骤后不会自动同步进沙箱。 -传输层是通过 SSH 进入 OpenShell 沙箱，但插件拥有沙箱生命周期以及可选镜像同步。 +在 `remote` 模式下，于 OpenClaw 外部在主机本地做出的修改，在初始化步骤之后不会自动同步到沙箱。 -**`setupCommand`** 在容器创建后运行一次（通过 `sh -lc`）。需要网络出口、可写根文件系统和 root 用户。 +传输使用 SSH 进入 OpenShell 沙箱，但插件负责沙箱生命周期和可选的镜像同步。 -**容器默认使用 `network: "none"`**——如果智能体需要对外访问，请设置为 `"bridge"`（或自定义 bridge 网络）。 -默认阻止 `"host"`。默认也阻止 `"container:"`，除非你显式设置 +**`setupCommand`** 会在容器创建后运行一次（通过 `sh -lc`）。需要网络出口、可写根文件系统以及 root 用户。 + +**容器默认使用 `network: "none"`**——如果智能体需要出站访问，请设置为 `"bridge"`（或自定义 bridge 网络）。 +默认阻止 `"host"`。默认也会阻止 `"container:"`，除非你显式设置 `sandbox.docker.dangerouslyAllowContainerNamespaceJoin: true`（紧急模式）。 -**传入附件** 会被暂存到当前工作区中的 `media/inbound/*`。 +**传入附件** 会暂存到当前活动工作区中的 `media/inbound/*`。 -**`docker.binds`** 会挂载额外宿主目录；全局和按智能体 binds 会合并。 +**`docker.binds`** 会挂载额外的主机目录；全局和每智能体 binds 会合并。 -**沙箱浏览器**（`sandbox.browser.enabled`）：在容器中运行 Chromium + CDP。会将 noVNC URL 注入系统提示词。不需要在 `openclaw.json` 中启用 `browser.enabled`。 -noVNC 观察者访问默认使用 VNC 认证，OpenClaw 会发出短期 token URL（而不是在共享 URL 中暴露密码）。 +**沙箱隔离浏览器**（`sandbox.browser.enabled`）：在容器中运行 Chromium + CDP。会将 noVNC URL 注入系统提示词中。不需要在 `openclaw.json` 中启用 `browser.enabled`。 +noVNC 观察者访问默认使用 VNC 认证，OpenClaw 会发出一个短时有效的 token URL（而不是在共享 URL 中暴露密码）。 -- `allowHostControl: false`（默认）会阻止沙箱隔离会话以宿主浏览器为目标。 -- `network` 默认为 `openclaw-sandbox-browser`（专用 bridge 网络）。只有在你明确希望使用全局 bridge 连接时，才设置为 `bridge`。 -- `cdpSourceRange` 可选地在容器边界将 CDP 入口限制为某个 CIDR 范围（例如 `172.21.0.1/32`）。 -- `sandbox.browser.binds` 仅将额外宿主目录挂载到沙箱浏览器容器中。设置后（包括 `[]`），它会替换浏览器容器的 `docker.binds`。 -- 启动默认值定义于 `scripts/sandbox-browser-entrypoint.sh`，并针对容器宿主环境进行了调优： +- `allowHostControl: false`（默认）会阻止沙箱会话把目标指向主机浏览器。 +- `network` 默认为 `openclaw-sandbox-browser`（专用 bridge 网络）。仅当你明确需要全局 bridge 连接性时，才设置为 `bridge`。 +- `cdpSourceRange` 可选地将容器边缘的 CDP 入站限制到某个 CIDR 范围（例如 `172.21.0.1/32`）。 +- `sandbox.browser.binds` 仅向沙箱浏览器容器挂载额外主机目录。设置后（包括 `[]`）会替换浏览器容器的 `docker.binds`。 +- 启动默认值定义于 `scripts/sandbox-browser-entrypoint.sh`，并针对容器主机进行过调优： - `--remote-debugging-address=127.0.0.1` - `--remote-debugging-port=` - `--user-data-dir=${HOME}/.chrome` @@ -1439,14 +1442,14 @@ noVNC 观察者访问默认使用 VNC 认证，OpenClaw 会发出短期 token UR - `--no-zygote` - `--metrics-recording-only` - `--disable-extensions`（默认启用） - - `--disable-3d-apis`、`--disable-software-rasterizer` 和 `--disable-gpu` 默认启用；如果 WebGL/3D 使用场景需要，可通过 - `OPENCLAW_BROWSER_DISABLE_GRAPHICS_FLAGS=0` 禁用这些默认项。 - - 如果你的工作流依赖扩展，可通过 - `OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0` 重新启用扩展。 + - `--disable-3d-apis`、`--disable-software-rasterizer` 和 `--disable-gpu` + 默认启用；如果 WebGL/3D 使用场景需要，可以通过 + `OPENCLAW_BROWSER_DISABLE_GRAPHICS_FLAGS=0` 关闭。 + - `OPENCLAW_BROWSER_DISABLE_EXTENSIONS=0` 会重新启用扩展，如果你的工作流依赖它们。 - `--renderer-process-limit=2` 可通过 - `OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=` 修改；设为 `0` 可使用 Chromium 的默认进程上限。 - - 当启用 `noSandbox` 时，还会附加 `--no-sandbox` 和 `--disable-setuid-sandbox`。 - - 这些默认值是容器镜像的基线；如需修改容器默认值，请使用带自定义 entrypoint 的自定义浏览器镜像。 + `OPENCLAW_BROWSER_RENDERER_PROCESS_LIMIT=` 修改；设置为 `0` 则使用 Chromium 的默认进程限制。 + - 当启用 `noSandbox` 时，还会加上 `--no-sandbox` 和 `--disable-setuid-sandbox`。 + - 这些默认值是容器镜像基线；如需更改容器默认行为，请使用带自定义入口点的自定义浏览器镜像。 @@ -1459,7 +1462,7 @@ scripts/sandbox-setup.sh # 主沙箱镜像 scripts/sandbox-browser-setup.sh # 可选浏览器镜像 ``` -### `agents.list`（按智能体覆盖） +### `agents.list`（每智能体覆盖） ```json5 { @@ -1472,11 +1475,11 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 workspace: "~/.openclaw/workspace", agentDir: "~/.openclaw/agents/main/agent", model: "anthropic/claude-opus-4-6", // 或 { primary, fallbacks } - thinkingDefault: "high", // 按智能体设置的 thinking 级别覆盖 - reasoningDefault: "on", // 按智能体设置的 reasoning 可见性覆盖 - fastModeDefault: false, // 按智能体设置的快速模式覆盖 - params: { cacheRetention: "none" }, // 按键覆盖匹配的 defaults.models params - skills: ["docs-search"], // 设置后会替换 agents.defaults.skills + thinkingDefault: "high", // 每智能体 thinking 级别覆盖 + reasoningDefault: "on", // 每智能体 reasoning 可见性覆盖 + fastModeDefault: false, // 每智能体 fast mode 覆盖 + params: { cacheRetention: "none" }, // 按键覆盖匹配 defaults.models params + skills: ["docs-search"], // 设置时会替换 agents.defaults.skills identity: { name: "Samantha", theme: "helpful sloth", @@ -1507,26 +1510,26 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 } ``` -- `id`：稳定的智能体 id（必填）。 -- `default`：当设置多个时，第一个生效（会记录警告）。如果都未设置，则列表第一项为默认值。 -- `model`：字符串形式仅覆盖 `primary`；对象形式 `{ primary, fallbacks }` 同时覆盖二者（`[]` 可禁用全局回退）。仅覆盖 `primary` 的 Cron 作业仍会继承默认回退，除非你设置 `fallbacks: []`。 -- `params`：按智能体设置的流参数，会合并覆盖 `agents.defaults.models` 中所选模型条目。用于设置智能体特定覆盖，如 `cacheRetention`、`temperature` 或 `maxTokens`，而无需复制整个模型目录。 -- `skills`：可选的按智能体 Skills 允许列表。如果省略，则在设置了 `agents.defaults.skills` 时继承之；显式列表会替换默认值而不是合并，`[]` 表示无 Skills。 -- `thinkingDefault`：可选的按智能体默认 thinking 级别（`off | minimal | low | medium | high | xhigh | adaptive`）。当未设置每消息或每会话覆盖时，它会覆盖此智能体的 `agents.defaults.thinkingDefault`。 -- `reasoningDefault`：可选的按智能体默认 reasoning 可见性（`on | off | stream`）。在未设置每消息或每会话 reasoning 覆盖时生效。 -- `fastModeDefault`：可选的按智能体快速模式默认值（`true | false`）。在未设置每消息或每会话快速模式覆盖时生效。 -- `runtime`：可选的按智能体运行时描述符。当智能体默认应使用 ACP harness 会话时，使用 `type: "acp"` 和 `runtime.acp` 默认值（`agent`、`backend`、`mode`、`cwd`）。 +- `id`：稳定的智能体 id（必需）。 +- `default`：当设置了多个时，以第一个为准（会记录警告）。如果都未设置，则列表第一项为默认。 +- `model`：字符串形式仅覆盖 `primary`；对象形式 `{ primary, fallbacks }` 会同时覆盖二者（`[]` 禁用全局后备）。仅覆盖 `primary` 的 cron 任务仍会继承默认后备，除非你设置 `fallbacks: []`。 +- `params`：按智能体区分的流参数，合并到 `agents.defaults.models` 中所选模型条目之上。用于智能体特定覆盖，如 `cacheRetention`、`temperature` 或 `maxTokens`，而不必复制整个模型目录。 +- `skills`：可选的每智能体 Skills 允许列表。若省略，智能体会在已设置时继承 `agents.defaults.skills`；显式列表会替换默认值而不是合并，`[]` 表示无 Skills。 +- `thinkingDefault`：可选的每智能体默认 thinking 级别（`off | minimal | low | medium | high | xhigh | adaptive`）。当未设置每消息或每会话覆盖时，会覆盖该智能体的 `agents.defaults.thinkingDefault`。 +- `reasoningDefault`：可选的每智能体默认 reasoning 可见性（`on | off | stream`）。当未设置每消息或每会话 reasoning 覆盖时生效。 +- `fastModeDefault`：可选的每智能体默认 fast mode（`true | false`）。当未设置每消息或每会话 fast-mode 覆盖时生效。 +- `runtime`：可选的每智能体运行时描述符。当智能体应默认使用 ACP harness 会话时，可使用 `type: "acp"` 并配置 `runtime.acp` 默认值（`agent`、`backend`、`mode`、`cwd`）。 - `identity.avatar`：工作区相对路径、`http(s)` URL 或 `data:` URI。 -- `identity` 会推导默认值：从 `emoji` 推导 `ackReaction`，从 `name`/`emoji` 推导 `mentionPatterns`。 +- `identity` 会派生默认值：`ackReaction` 来自 `emoji`，`mentionPatterns` 来自 `name`/`emoji`。 - `subagents.allowAgents`：`sessions_spawn` 的智能体 id 允许列表（`["*"]` = 任意；默认：仅同一智能体）。 -- 沙箱继承保护：如果请求方会话处于沙箱隔离中，`sessions_spawn` 会拒绝那些会以未沙箱隔离方式运行的目标。 -- `subagents.requireAgentId`：为 true 时，会阻止省略 `agentId` 的 `sessions_spawn` 调用（强制显式配置选择；默认：false）。 +- 沙箱继承保护：如果请求方会话位于沙箱中，`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 { @@ -1545,12 +1548,12 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 ### 绑定匹配字段 -- `type`（可选）：正常路由使用 `route`（省略时默认 route），持久 ACP 会话绑定使用 `acp` -- `match.channel`（必填） +- `type`（可选）：正常路由使用 `route`（缺失 type 时默认是 route），持久 ACP 会话绑定使用 `acp`。 +- `match.channel`（必需） - `match.accountId`（可选；`*` = 任意账号；省略 = 默认账号） - `match.peer`（可选；`{ kind: direct|group|channel, id }`） -- `match.guildId` / `match.teamId`（可选；按渠道特定） -- `acp`（可选；仅适用于 `type: "acp"`）：`{ mode, label, cwd, backend }` +- `match.guildId` / `match.teamId`（可选；渠道特定） +- `acp`（可选；仅用于 `type: "acp"`）：`{ mode, label, cwd, backend }` **确定性匹配顺序：** @@ -1558,14 +1561,14 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 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 绑定层级顺序。 -### 按智能体访问配置 +### 每智能体访问配置 @@ -1686,7 +1689,7 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 }, resetTriggers: ["/new", "/reset"], store: "~/.openclaw/agents/{agentId}/sessions/sessions.json", - parentForkMaxTokens: 100000, // 超过该 token 数时跳过父线程 fork（0 表示禁用） + parentForkMaxTokens: 100000, // 超过此 token 数则跳过父线程 fork（0 表示禁用） maintenance: { mode: "warn", // warn | enforce pruneAfter: "30d", @@ -1698,10 +1701,10 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 }, threadBindings: { enabled: true, - idleHours: 24, // 默认按小时计算的非活动自动取消聚焦（`0` 禁用） - maxAgeHours: 0, // 默认按小时计算的硬性最大存活时间（`0` 禁用） + idleHours: 24, // 默认以小时为单位的非活动自动取消聚焦（`0` 表示禁用） + maxAgeHours: 0, // 默认以小时为单位的最大存活时间硬限制（`0` 表示禁用） }, - mainKey: "main", // 旧版（运行时始终使用 "main"） + mainKey: "main", // 旧版字段（运行时始终使用 "main"） agentToAgent: { maxPingPongTurns: 5 }, sendPolicy: { rules: [{ action: "deny", match: { channel: "discord", chatType: "group" } }], @@ -1713,35 +1716,35 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 -- **`scope`**：用于群聊上下文的基础会话分组策略。 - - `per-sender`（默认）：每个发送者在一个渠道上下文中拥有独立会话。 - - `global`：一个渠道上下文中的所有参与者共享一个会话（仅在明确希望共享上下文时使用）。 -- **`dmScope`**：私信分组方式。 +- **`scope`**：群聊上下文的基础会话分组策略。 + - `per-sender`（默认）：在某个渠道上下文内，每个发送者拥有独立会话。 + - `global`：某个渠道上下文中的所有参与者共享一个会话（仅在确实需要共享上下文时使用）。 +- **`dmScope`**：私信的分组方式。 - `main`：所有私信共享主会话。 - `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`**：创建 fork 线程会话时，允许的父会话 `totalTokens` 最大值（默认 `100000`）。 - - 如果父会话 `totalTokens` 高于此值，OpenClaw 将启动全新的线程会话，而不是继承父转录历史。 - - 设为 `0` 可禁用此保护，并始终允许父级 fork。 +- **`identityLinks`**：将规范 id 映射到带提供商前缀的对端，以便跨渠道共享会话。 +- **`reset`**：主要重置策略。`daily` 会在本地时间 `atHour` 重置；`idle` 会在 `idleMinutes` 后重置。若两者都配置，则先到期者生效。 +- **`resetByType`**：按类型覆盖（`direct`、`group`、`thread`）。旧版 `dm` 可作为 `direct` 的别名。 +- **`parentForkMaxTokens`**：创建 fork 线程会话时，允许父会话 `totalTokens` 的最大值（默认 `100000`）。 + - 如果父会话 `totalTokens` 高于此值，OpenClaw 会启动新的线程会话，而不是继承父 transcript 历史。 + - 设置为 `0` 可禁用此保护，并始终允许父 fork。 - **`mainKey`**：旧版字段。运行时现在始终对主私聊桶使用 `"main"`。 -- **`agentToAgent.maxPingPongTurns`**：智能体间交换期间允许的最大回复往返轮数（整数，范围：`0`–`5`）。`0` 表示禁用 ping-pong 链。 -- **`sendPolicy`**：按 `channel`、`chatType`（`direct|group|channel`，旧版 `dm` 为别名）、`keyPrefix` 或 `rawKeyPrefix` 匹配。第一个 deny 胜出。 -- **`maintenance`**：会话存储清理 + 保留控制。 +- **`agentToAgent.maxPingPongTurns`**：智能体互相交流时的最大来回回复轮数（整数，范围：`0`–`5`）。`0` 表示禁用乒乓链接续。 +- **`sendPolicy`**：按 `channel`、`chatType`（`direct|group|channel`，旧版 `dm` 为别名）、`keyPrefix` 或 `rawKeyPrefix` 匹配。第一个 deny 优先。 +- **`maintenance`**：会话存储清理和保留控制。 - `mode`：`warn` 仅发出警告；`enforce` 应用清理。 - - `pruneAfter`：过期条目的年龄截止值（默认 `30d`）。 + - `pruneAfter`：过期条目的时间阈值（默认 `30d`）。 - `maxEntries`：`sessions.json` 中的最大条目数（默认 `500`）。 - - `rotateBytes`：当 `sessions.json` 超过该大小时轮转（默认 `10mb`）。 - - `resetArchiveRetention`：`*.reset.` 转录归档的保留时间。默认与 `pruneAfter` 一致；设为 `false` 可禁用。 - - `maxDiskBytes`：可选的 sessions 目录磁盘预算。在 `warn` 模式下会记录警告；在 `enforce` 模式下会优先移除最旧的产物/会话。 - - `highWaterBytes`：预算清理后的可选目标值。默认为 `maxDiskBytes` 的 `80%`。 + - `rotateBytes`：当 `sessions.json` 超过该大小时进行轮换（默认 `10mb`）。 + - `resetArchiveRetention`：`*.reset.` transcript 归档的保留期。默认继承 `pruneAfter`；设置为 `false` 可禁用。 + - `maxDiskBytes`：可选的 sessions 目录磁盘预算。在 `warn` 模式下记录警告；在 `enforce` 模式下优先移除最旧的工件/会话。 + - `highWaterBytes`：预算清理后的可选目标值。默认是 `maxDiskBytes` 的 `80%`。 - **`threadBindings`**：线程绑定会话功能的全局默认值。 - `enabled`：主默认开关（提供商可覆盖；Discord 使用 `channels.discord.threadBindings.enabled`） - - `idleHours`：按小时计算的默认非活动自动取消聚焦（`0` 禁用；提供商可覆盖） - - `maxAgeHours`：按小时计算的默认硬性最大存活时间（`0` 禁用；提供商可覆盖） + - `idleHours`：默认以小时为单位的非活动自动取消聚焦（`0` 表示禁用；提供商可覆盖） + - `maxAgeHours`：默认以小时为单位的最大存活时间硬限制（`0` 表示禁用；提供商可覆盖） @@ -1777,38 +1780,38 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 } ``` -### 回复前缀 +### 响应前缀 -按渠道/账号覆盖：`channels..responsePrefix`、`channels..accounts..responsePrefix`。 +每渠道/每账号覆盖：`channels..responsePrefix`、`channels..accounts..responsePrefix`。 -解析顺序（最具体者优先）：账号 → 渠道 → 全局。`""` 会禁用并停止级联。`"auto"` 会派生为 `[{identity.name}]`。 +解析顺序（越具体越优先）：账号 → 渠道 → 全局。`""` 会禁用并停止级联。`"auto"` 会派生为 `[{identity.name}]`。 **模板变量：** -| 变量 | 描述 | 示例 | +| 变量 | 说明 | 示例 | | ------------------ | ---------------- | --------------------------- | | `{model}` | 短模型名 | `claude-opus-4-6` | | `{modelFull}` | 完整模型标识符 | `anthropic/claude-opus-4-6` | | `{provider}` | 提供商名称 | `anthropic` | | `{thinkingLevel}` | 当前 thinking 级别 | `high`、`low`、`off` | -| `{identity.name}` | 智能体 identity 名称 | （与 `"auto"` 相同） | +| `{identity.name}` | 智能体身份名称 | （与 `"auto"` 相同） | -变量不区分大小写。`{think}` 是 `{thinkingLevel}` 的别名。 +变量大小写不敏感。`{think}` 是 `{thinkingLevel}` 的别名。 -### 确认 reaction +### 确认反应 -- 默认使用当前智能体的 `identity.emoji`，否则为 `"👀"`。设置 `""` 可禁用。 -- 按渠道覆盖：`channels..ackReaction`、`channels..accounts..ackReaction`。 -- 解析顺序：账号 → 渠道 → `messages.ackReaction` → identity 回退。 -- 范围：`group-mentions`（默认）、`group-all`、`direct`、`all`。 +- 默认使用活动智能体的 `identity.emoji`，否则为 `"👀"`。设置 `""` 可禁用。 +- 每渠道覆盖：`channels..ackReaction`、`channels..accounts..ackReaction`。 +- 解析顺序：账号 → 渠道 → `messages.ackReaction` → identity 后备。 +- 作用域：`group-mentions`（默认）、`group-all`、`direct`、`all`。 - `removeAckAfterReply`：在 Slack、Discord 和 Telegram 上于回复后移除 ack。 -- `messages.statusReactions.enabled`：在 Slack、Discord 和 Telegram 上启用生命周期状态 reaction。 - 在 Slack 和 Discord 上，未设置时会在 ack reaction 处于激活状态时保持状态 reaction 启用。 - 在 Telegram 上，需显式设置为 `true` 才会启用生命周期状态 reaction。 +- `messages.statusReactions.enabled`：为 Slack、Discord 和 Telegram 启用生命周期状态反应。 + 在 Slack 和 Discord 上，未设置时只要 ack 反应处于激活状态，状态反应就会保持启用。 + 在 Telegram 上，需要显式设置为 `true` 才会启用生命周期状态反应。 -### 传入防抖 +### 传入去抖 -将来自同一发送者的快速纯文本消息批处理为单个智能体轮次。媒体/附件会立即刷新。控制命令会绕过防抖。 +将同一发送者快速连续发送的纯文本消息合并为单个智能体轮次。媒体/附件会立即冲刷。控制命令会绕过去抖。 ### TTS（文本转语音） @@ -1853,10 +1856,10 @@ scripts/sandbox-browser-setup.sh # 可选浏览器镜像 - `auto` 控制自动 TTS。`/tts off|always|inbound|tagged` 会按会话覆盖。 - `summaryModel` 会覆盖自动摘要所使用的 `agents.defaults.model.primary`。 -- `modelOverrides` 默认启用；`modelOverrides.allowProvider` 默认为 `false`（选择启用）。 +- `modelOverrides` 默认启用；`modelOverrides.allowProvider` 默认值为 `false`（需显式启用）。 - API key 会回退到 `ELEVENLABS_API_KEY`/`XI_API_KEY` 和 `OPENAI_API_KEY`。 -- `openai.baseUrl` 会覆盖 OpenAI TTS 端点。解析顺序是配置，然后 `OPENAI_TTS_BASE_URL`，然后 `https://api.openai.com/v1`。 -- 当 `openai.baseUrl` 指向非 OpenAI 端点时，OpenClaw 会将其视为 OpenAI 兼容的 TTS 服务器，并放宽模型/语音校验。 +- `openai.baseUrl` 会覆盖 OpenAI TTS 端点。解析顺序为：配置，然后 `OPENAI_TTS_BASE_URL`，最后是 `https://api.openai.com/v1`。 +- 当 `openai.baseUrl` 指向非 OpenAI 端点时，OpenClaw 会将其视为兼容 OpenAI 的 TTS 服务器，并放宽模型/语音校验。 --- @@ -1886,13 +1889,13 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -- 当配置了多个 Talk 提供商时，`talk.provider` 必须匹配 `talk.providers` 中的某个键。 -- 旧版扁平 Talk 键（`talk.voiceId`、`talk.voiceAliases`、`talk.modelId`、`talk.outputFormat`、`talk.apiKey`）仅用于兼容，并会自动迁移到 `talk.providers.`。 +- 当配置了多个 Talk 提供商时，`talk.provider` 必须匹配 `talk.providers` 中的一个键。 +- 旧版扁平 Talk 键（`talk.voiceId`、`talk.voiceAliases`、`talk.modelId`、`talk.outputFormat`、`talk.apiKey`）仅用于兼容，会自动迁移到 `talk.providers.`。 - Voice ID 会回退到 `ELEVENLABS_VOICE_ID` 或 `SAG_VOICE_ID`。 - `providers.*.apiKey` 接受明文字符串或 SecretRef 对象。 -- 仅当未配置 Talk API key 时，才会应用 `ELEVENLABS_API_KEY` 回退。 -- `providers.*.voiceAliases` 允许 Talk 指令使用友好名称。 -- `silenceTimeoutMs` 控制 Talk 模式在用户静音后等待多久才发送转录。未设置时保持平台默认暂停窗口（`macOS 和 Android 为 700 ms，iOS 为 900 ms`）。 +- `ELEVENLABS_API_KEY` 回退仅在未配置 Talk API key 时适用。 +- `providers.*.voiceAliases` 允许 Talk 指令使用友好的名称。 +- `silenceTimeoutMs` 控制 Talk 模式在用户静音后等待多久再发送转录文本。未设置时保留平台默认停顿窗口（`macOS 和 Android 为 700 ms，iOS 为 900 ms`）。 --- @@ -1902,35 +1905,35 @@ Talk 模式（macOS/iOS/Android）的默认值。 `tools.profile` 会在 `tools.allow`/`tools.deny` 之前设置基础允许列表： -当 `tools.profile` 未设置时，本地新手引导默认将新本地配置设置为 `tools.profile: "coding"`（现有显式配置文件会保留）。 +当未设置时，本地新手引导会默认将新的本地配置设为 `tools.profile: "coding"`（已有的显式配置文件会保留）。 -| 配置文件 | 包含 | +| 配置文件 | 包含内容 | | ----------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `minimal` | 仅 `session_status` | +| `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` | 不做限制（与未设置相同） | +| `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` | 所有内置工具（不包括提供商插件） | ### `tools.allow` / `tools.deny` -全局工具允许/拒绝策略（拒绝优先）。不区分大小写，支持 `*` 通配符。即使 Docker 沙箱关闭也会应用。 +全局工具允许/拒绝策略（deny 优先）。大小写不敏感，支持 `*` 通配符。即使 Docker 沙箱已关闭，也会生效。 ```json5 { @@ -1940,7 +1943,7 @@ Talk 模式（macOS/iOS/Android）的默认值。 ### `tools.byProvider` -进一步限制特定提供商或模型可用的工具。顺序：基础 profile → provider profile → allow/deny。 +进一步限制特定提供商或模型的工具。顺序：基础配置文件 → 提供商配置文件 → allow/deny。 ```json5 { @@ -1972,9 +1975,9 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -- 按智能体覆盖（`agents.list[].tools.elevated`）只能进一步收紧限制。 -- `/elevated on|off|ask|full` 会按会话存储状态；内联指令仅作用于单条消息。 -- Elevated `exec` 会绕过沙箱隔离，并使用已配置的逃逸路径（默认是 `gateway`，或当 exec 目标是 `node` 时使用 `node`）。 +- 每智能体覆盖（`agents.list[].tools.elevated`）只能进一步限制。 +- `/elevated on|off|ask|full` 会为每个会话存储状态；内联指令仅适用于单条消息。 +- elevated `exec` 会绕过沙箱隔离，并使用已配置的逃逸路径（默认 `gateway`，或当 exec 目标是 `node` 时使用 `node`）。 ### `tools.exec` @@ -1998,8 +2001,8 @@ Talk 模式（macOS/iOS/Android）的默认值。 ### `tools.loopDetection` -工具循环安全检查**默认禁用**。设置 `enabled: true` 可启用检测。 -可在 `tools.loopDetection` 中全局定义设置，并在 `agents.list[].tools.loopDetection` 中按智能体覆盖。 +工具循环安全检查默认**关闭**。设置 `enabled: true` 即可激活检测。 +设置可以在 `tools.loopDetection` 中全局定义，并在 `agents.list[].tools.loopDetection` 中按智能体覆盖。 ```json5 { @@ -2020,14 +2023,14 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -- `historySize`：用于循环分析保留的最大工具调用历史。 +- `historySize`：用于循环分析的最大工具调用历史保留数。 - `warningThreshold`：用于发出警告的重复无进展模式阈值。 -- `criticalThreshold`：用于阻止严重循环的更高重复阈值。 -- `globalCircuitBreakerThreshold`：针对任何无进展运行的硬停止阈值。 +- `criticalThreshold`：用于阻止关键循环的更高重复阈值。 +- `globalCircuitBreakerThreshold`：任何无进展运行的硬停止阈值。 - `detectors.genericRepeat`：对重复的同工具/同参数调用发出警告。 - `detectors.knownPollNoProgress`：对已知轮询工具（`process.poll`、`command_status` 等）的无进展情况发出警告/阻止。 -- `detectors.pingPong`：对交替出现的无进展成对模式发出警告/阻止。 -- 如果 `warningThreshold >= criticalThreshold` 或 `criticalThreshold >= globalCircuitBreakerThreshold`，校验会失败。 +- `detectors.pingPong`：对交替出现的无进展双工具模式发出警告/阻止。 +- 如果 `warningThreshold >= criticalThreshold` 或 `criticalThreshold >= globalCircuitBreakerThreshold`，验证会失败。 ### `tools.web` @@ -2068,6 +2071,9 @@ Talk 模式（macOS/iOS/Android）的默认值。 tools: { media: { concurrency: 2, + asyncCompletion: { + directSend: false, // 显式启用：将完成的异步音乐/视频直接发送到渠道 + }, audio: { enabled: true, maxBytes: 20971520, @@ -2092,11 +2098,11 @@ Talk 模式（macOS/iOS/Android）的默认值。 -**提供商条目**（`type: "provider"` 或省略）： +**Provider 条目**（`type: "provider"` 或省略）： - `provider`：API 提供商 id（`openai`、`anthropic`、`google`/`gemini`、`groq` 等） - `model`：模型 id 覆盖 -- `profile` / `preferredProfile`：`auth-profiles.json` profile 选择 +- `profile` / `preferredProfile`：`auth-profiles.json` 配置文件选择 **CLI 条目**（`type: "cli"`）： @@ -2106,10 +2112,16 @@ 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`。 +Provider 认证遵循标准顺序：`auth-profiles.json` → 环境变量 → `models.providers.*.apiKey`。 + +**异步完成字段：** + +- `asyncCompletion.directSend`：当为 `true` 时，已完成的异步 `music_generate` + 和 `video_generate` 任务会优先尝试直接渠道交付。默认：`false` + （旧版请求者会话唤醒/模型交付路径）。 @@ -2128,7 +2140,7 @@ Talk 模式（macOS/iOS/Android）的默认值。 ### `tools.sessions` -控制哪些会话可以被会话工具（`sessions_list`、`sessions_history`、`sessions_send`）作为目标。 +控制哪些会话可以被会话工具（`sessions_list`、`sessions_history`、`sessions_send`）访问。 默认值：`tree`（当前会话 + 由其生成的会话，例如子智能体）。 @@ -2147,9 +2159,9 @@ Talk 模式（macOS/iOS/Android）的默认值。 - `self`：仅当前会话键。 - `tree`：当前会话 + 由当前会话生成的会话（子智能体）。 -- `agent`：属于当前智能体 id 的任意会话（如果你在同一智能体 id 下按发送者运行会话，可能包含其他用户）。 +- `agent`：属于当前智能体 id 的任意会话（如果你在同一个智能体 id 下运行按发送者分会话，可能包括其他用户）。 - `all`：任意会话。跨智能体定向仍需要 `tools.agentToAgent`。 -- 沙箱钳制：当当前会话处于沙箱隔离中，且 `agents.defaults.sandbox.sessionToolsVisibility="spawned"` 时，即使 `tools.sessions.visibility="all"`，可见性也会被强制为 `tree`。 +- 沙箱限制：当当前会话处于沙箱中且 `agents.defaults.sandbox.sessionToolsVisibility="spawned"` 时，即使 `tools.sessions.visibility="all"`，可见性也会被强制为 `tree`。 ### `tools.sessions_spawn` @@ -2160,7 +2172,7 @@ Talk 模式（macOS/iOS/Android）的默认值。 tools: { sessions_spawn: { attachments: { - enabled: false, // 选择启用：设为 true 以允许内联文件附件 + enabled: false, // 显式启用：设置为 true 以允许内联文件附件 maxTotalBytes: 5242880, // 所有文件总计 5 MB maxFiles: 50, maxFileBytes: 1048576, // 每个文件 1 MB @@ -2173,16 +2185,16 @@ Talk 模式（macOS/iOS/Android）的默认值。 注意： -- 仅 `runtime: "subagent"` 支持附件。ACP runtime 会拒绝它们。 -- 文件会实体化到子工作区中的 `.openclaw/attachments//`，并带有 `.manifest.json`。 -- 附件内容会自动从转录持久化中脱敏。 -- Base64 输入会使用严格的字母表/填充检查和解码前大小保护进行校验。 -- 文件权限：目录为 `0700`，文件为 `0600`。 -- 清理遵循 `cleanup` 策略：`delete` 始终会移除附件；`keep` 仅在 `retainOnSessionKeep: true` 时保留。 +- 附件仅支持 `runtime: "subagent"`。ACP 运行时会拒绝它们。 +- 文件会实体化到子工作区中的 `.openclaw/attachments//`，并附带 `.manifest.json`。 +- 附件内容会自动从 transcript 持久化中脱敏。 +- Base64 输入会使用严格的字母表/填充校验以及解码前大小保护进行验证。 +- 文件权限为：目录 `0700`，文件 `0600`。 +- 清理遵循 `cleanup` 策略：`delete` 总是移除附件；`keep` 仅在 `retainOnSessionKeep: true` 时保留。 ### `tools.experimental` -实验性内置工具开关。默认关闭，除非适用某个运行时特定的自动启用规则。 +实验性内置工具标志。默认关闭，除非存在运行时特定的自动启用规则。 ```json5 { @@ -2196,9 +2208,9 @@ Talk 模式（macOS/iOS/Android）的默认值。 注意： -- `planTool`：为非平凡多步骤工作跟踪启用结构化 `update_plan` 工具。 -- 默认值：对非 OpenAI 提供商为 `false`。OpenAI 和 OpenAI Codex 运行会自动启用它。 -- 启用后，系统提示词也会增加使用指导，使模型仅在较复杂工作时使用它，并最多保持一个 `in_progress` 步骤。 +- `planTool`：为非琐碎多步骤工作跟踪启用结构化 `update_plan` 工具。 +- 默认：对非 OpenAI 提供商为 `false`。OpenAI 和 OpenAI Codex 运行会自动启用它。 +- 启用后，系统提示词还会添加使用指导，以便模型仅在实质性工作中使用它，并且最多只保留一个 `in_progress` 步骤。 ### `agents.defaults.subagents` @@ -2218,16 +2230,16 @@ Talk 模式（macOS/iOS/Android）的默认值。 } ``` -- `model`：生成子智能体的默认模型。如果省略，子智能体会继承调用者的模型。 -- `allowAgents`：当请求智能体未设置自己的 `subagents.allowAgents` 时，`sessions_spawn` 的目标智能体 id 默认允许列表（`["*"]` = 任意；默认：仅同一智能体）。 -- `runTimeoutSeconds`：当工具调用省略 `runTimeoutSeconds` 时，`sessions_spawn` 使用的默认超时时间（秒）。`0` 表示无超时。 -- 按子智能体工具策略：`tools.subagents.tools.allow` / `tools.subagents.tools.deny`。 +- `model`：生成的子智能体默认模型。如果省略，子智能体会继承调用方模型。 +- `allowAgents`：当请求方智能体未设置自己的 `subagents.allowAgents` 时，`sessions_spawn` 的目标智能体 id 默认允许列表（`["*"]` = 任意；默认：仅同一智能体）。 +- `runTimeoutSeconds`：当工具调用省略 `runTimeoutSeconds` 时，`sessions_spawn` 的默认超时时间（秒）。`0` 表示无超时。 +- 每子智能体工具策略：`tools.subagents.tools.allow` / `tools.subagents.tools.deny`。 --- ## 自定义提供商和 base URL -OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 `~/.openclaw/agents//agent/models.json` 添加自定义提供商。 +OpenClaw 使用内置模型目录。通过配置中的 `models.providers` 或 `~/.openclaw/agents//agent/models.json` 添加自定义提供商。 ```json5 { @@ -2256,46 +2268,46 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 } ``` -- 自定义认证需求请使用 `authHeader: true` + `headers`。 +- 使用 `authHeader: true` + `headers` 来满足自定义认证需求。 - 使用 `OPENCLAW_AGENT_DIR`（或旧版环境变量别名 `PI_CODING_AGENT_DIR`）覆盖智能体配置根目录。 -- 匹配提供商 ID 的合并优先级： +- 对于匹配的 provider ID，合并优先级如下： - 非空的智能体 `models.json` `baseUrl` 值优先。 - - 非空的智能体 `apiKey` 值仅在当前配置/auth-profile 上下文中该提供商不是 SecretRef 托管时优先。 - - SecretRef 托管的提供商 `apiKey` 值会从源标记刷新（环境变量引用用 `ENV_VAR_NAME`，文件/exec 引用用 `secretref-managed`），而不是持久化已解析的 secret。 - - SecretRef 托管的提供商 header 值也会从源标记刷新（环境变量引用用 `secretref-env:ENV_VAR_NAME`，文件/exec 引用用 `secretref-managed`）。 - - 智能体的 `apiKey`/`baseUrl` 为空或缺失时，会回退到配置中的 `models.providers`。 - - 匹配模型的 `contextWindow`/`maxTokens` 取显式配置和隐式目录值中的较高者。 - - 匹配模型的 `contextTokens` 在存在时会保留显式运行时上限；用它可以在不改变原生模型元数据的前提下限制有效上下文。 - - 当你希望配置完全重写 `models.json` 时，使用 `models.mode: "replace"`。 - - 标记持久化以源为权威：标记是根据活动源配置快照（解析前）写入，而不是根据已解析的运行时 secret 值写入。 + - 非空的智能体 `apiKey` 值仅在当前配置/auth-profile 上下文中该提供商不是由 SecretRef 管理时优先。 + - 由 SecretRef 管理的 provider `apiKey` 值会从源标记刷新（环境变量引用为 `ENV_VAR_NAME`，文件/exec 引用为 `secretref-managed`），而不是持久化已解析的 secret。 + - 由 SecretRef 管理的 provider header 值会从源标记刷新（环境变量引用为 `secretref-env:ENV_VAR_NAME`，文件/exec 引用为 `secretref-managed`）。 + - 空或缺失的智能体 `apiKey`/`baseUrl` 会回退到配置中的 `models.providers`。 + - 匹配模型的 `contextWindow`/`maxTokens` 使用显式配置值和隐式目录值中的较大者。 + - 匹配模型的 `contextTokens` 会在存在时保留显式运行时上限；用它可在不更改模型原生元数据的情况下限制有效上下文。 + - 如果你希望配置完全重写 `models.json`，请使用 `models.mode: "replace"`。 + - 标记持久化遵循源配置权威：标记会从活动源配置快照（解析前）写入，而不是从已解析的运行时 secret 值写入。 ### 提供商字段详情 - `models.mode`：提供商目录行为（`merge` 或 `replace`）。 -- `models.providers`：以提供商 id 为键的自定义提供商映射。 +- `models.providers`：按 provider id 键控的自定义提供商映射。 - `models.providers.*.api`：请求适配器（`openai-completions`、`openai-responses`、`anthropic-messages`、`google-generative-ai` 等）。 -- `models.providers.*.apiKey`：提供商凭证（优先使用 SecretRef/环境变量替换）。 +- `models.providers.*.apiKey`：提供商凭据（推荐使用 SecretRef/环境变量替换）。 - `models.providers.*.auth`：认证策略（`api-key`、`token`、`oauth`、`aws-sdk`）。 - `models.providers.*.injectNumCtxForOpenAICompat`：对于 Ollama + `openai-completions`，向请求中注入 `options.num_ctx`（默认：`true`）。 -- `models.providers.*.authHeader`：在需要时强制通过 `Authorization` header 传输凭证。 +- `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.auth`：认证策略覆盖。模式：`"provider-default"`（使用提供商内建认证）、`"authorization-bearer"`（配合 `token`）、`"header"`（配合 `headerName`、`value` 和可选 `prefix`）。 - `request.proxy`：HTTP 代理覆盖。模式：`"env-proxy"`（使用 `HTTP_PROXY`/`HTTPS_PROXY` 环境变量）、`"explicit-proxy"`（配合 `url`）。两种模式都接受可选的 `tls` 子对象。 - `request.tls`：直连时的 TLS 覆盖。字段：`ca`、`cert`、`key`、`passphrase`（都接受 SecretRef）、`serverName`、`insecureSkipVerify`。 -- `models.providers.*.models`：显式提供商模型目录条目。 +- `models.providers.*.models`：显式 provider 模型目录条目。 - `models.providers.*.models.*.contextWindow`：原生模型上下文窗口元数据。 -- `models.providers.*.models.*.contextTokens`：可选的运行时上下文上限。当你希望有效上下文预算小于模型原生 `contextWindow` 时，请使用它。 -- `models.providers.*.models.*.compat.supportsDeveloperRole`：可选兼容性提示。对于 `api: "openai-completions"` 且使用非空的非原生 `baseUrl`（主机不是 `api.openai.com`）的情况，OpenClaw 会在运行时强制将其设为 `false`。`baseUrl` 为空/省略时保持默认 OpenAI 行为。 -- `plugins.entries.amazon-bedrock.config.discovery`：Bedrock 自动发现设置根节点。 +- `models.providers.*.models.*.contextTokens`：可选运行时上下文上限。当你希望有效上下文预算小于模型原生 `contextWindow` 时使用。 +- `models.providers.*.models.*.compat.supportsDeveloperRole`：可选兼容性提示。对于 `api: "openai-completions"` 且非空的非原生 `baseUrl`（主机不是 `api.openai.com`），OpenClaw 会在运行时强制设为 `false`。空/省略的 `baseUrl` 则保留默认 OpenAI 行为。 +- `plugins.entries.amazon-bedrock.config.discovery`：Bedrock 自动发现设置根。 - `plugins.entries.amazon-bedrock.config.discovery.enabled`：开启/关闭隐式发现。 -- `plugins.entries.amazon-bedrock.config.discovery.region`：发现所用 AWS 区域。 -- `plugins.entries.amazon-bedrock.config.discovery.providerFilter`：用于定向发现的可选 provider-id 过滤器。 +- `plugins.entries.amazon-bedrock.config.discovery.region`：用于发现的 AWS 区域。 +- `plugins.entries.amazon-bedrock.config.discovery.providerFilter`：可选的 provider-id 过滤器，用于定向发现。 - `plugins.entries.amazon-bedrock.config.discovery.refreshInterval`：发现刷新轮询间隔。 -- `plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow`：已发现模型的回退上下文窗口。 -- `plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens`：已发现模型的回退最大输出 token。 +- `plugins.entries.amazon-bedrock.config.discovery.defaultContextWindow`：发现模型的后备上下文窗口。 +- `plugins.entries.amazon-bedrock.config.discovery.defaultMaxTokens`：发现模型的后备最大输出 token。 ### 提供商示例 @@ -2311,8 +2323,8 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 fallbacks: ["cerebras/zai-glm-4.6"], }, models: { - "cerebras/zai-glm-4.7": { alias: "GLM 4.7（Cerebras）" }, - "cerebras/zai-glm-4.6": { alias: "GLM 4.6（Cerebras）" }, + "cerebras/zai-glm-4.7": { alias: "GLM 4.7 (Cerebras)" }, + "cerebras/zai-glm-4.6": { alias: "GLM 4.6 (Cerebras)" }, }, }, }, @@ -2324,8 +2336,8 @@ OpenClaw 使用内置模型目录。可通过配置中的 `models.providers` 或 apiKey: "${CEREBRAS_API_KEY}", api: "openai-completions", models: [ - { id: "zai-glm-4.7", name: "GLM 4.7（Cerebras）" }, - { id: "zai-glm-4.6", name: "GLM 4.6（Cerebras）" }, + { id: "zai-glm-4.7", name: "GLM 4.7 (Cerebras)" }, + { id: "zai-glm-4.6", name: "GLM 4.6 (Cerebras)" }, ], }, }, @@ -2367,11 +2379,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` - 编码端点（默认）：`https://api.z.ai/api/coding/paas/v4` -- 对于通用端点，请定义带 base URL 覆盖的自定义提供商。 +- 对于通用端点，请定义一个带 base URL 覆盖的自定义提供商。 @@ -2412,7 +2424,8 @@ 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`。 -原生 Moonshot 端点会在共享的 `openai-completions` 传输上声明流式使用兼容性，OpenClaw 现在依据端点能力而不是仅依据内置 provider id 来识别这一点。 +原生 Moonshot 端点会在共享的 +`openai-completions` 传输上声明流式使用兼容性，OpenClaw 现在会根据端点能力而不是仅根据内置 provider id 来判断这一点。 @@ -2430,7 +2443,7 @@ Cerebras 使用 `cerebras/zai-glm-4.7`；Z.AI 直连使用 `zai/glm-4.7`。 } ``` -Anthropic 兼容的内置提供商。快捷方式：`openclaw onboard --auth-choice kimi-code-api-key`。 +Anthropic 兼容，内置提供商。快捷方式：`openclaw onboard --auth-choice kimi-code-api-key`。 @@ -2469,7 +2482,7 @@ Anthropic 兼容的内置提供商。快捷方式：`openclaw onboard --auth-cho } ``` -base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方式：`openclaw onboard --auth-choice synthetic-api-key`。 +Base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方式：`openclaw onboard --auth-choice synthetic-api-key`。 @@ -2512,8 +2525,8 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 设置 `MINIMAX_API_KEY`。快捷方式： `openclaw onboard --auth-choice minimax-global-api` 或 `openclaw onboard --auth-choice minimax-cn-api`。 -模型目录现在默认仅包含 M2.7。 -在 Anthropic 兼容的流式路径上，除非你显式设置 `thinking`，否则 OpenClaw 默认禁用 MiniMax thinking。 +模型目录现在默认只包含 M2.7。 +在 Anthropic 兼容的流式路径上，除非你显式设置 `thinking`，否则 OpenClaw 默认会关闭 MiniMax thinking。 `/fast on` 或 `params.fastMode: true` 会将 `MiniMax-M2.7` 重写为 `MiniMax-M2.7-highspeed`。 @@ -2521,7 +2534,7 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 -参见 [Local Models](/zh-CN/gateway/local-models)。简而言之：在高性能硬件上通过 LM Studio Responses API 运行大型本地模型；同时保留已合并的托管模型作为回退。 +参见 [Local Models](/zh-CN/gateway/local-models)。简而言之：在性能较强的硬件上通过 LM Studio Responses API 运行大型本地模型；保留已合并的托管模型作为后备。 @@ -2552,12 +2565,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`）。 +- `allowBundled`：仅针对内置 Skills 的可选允许列表（托管/工作区 Skills 不受影响）。 +- `load.extraDirs`：额外的共享 skill 根目录（优先级最低）。 +- `install.preferBrew`：为 true 时，如果存在 `brew`，则优先使用 Homebrew 安装器，然后再回退到其他安装器类型。 +- `install.nodeManager`：`metadata.openclaw.install` 规范的 node 安装器偏好（`npm` | `pnpm` | `yarn` | `bun`）。 - `entries..enabled: false`：即使某个 skill 已内置/已安装，也会禁用它。 -- `entries..apiKey`：为声明了主环境变量的 Skills 提供的便捷 API key 字段（明文字符串或 SecretRef 对象）。 +- `entries..apiKey`：为声明了主环境变量的 skill 提供便利字段（明文字符串或 SecretRef 对象）。 --- @@ -2585,35 +2598,35 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 } ``` -- 从 `~/.openclaw/extensions`、`/.openclaw/extensions` 以及 `plugins.load.paths` 加载。 -- 发现机制接受原生 OpenClaw 插件，以及兼容的 Codex bundle 和 Claude bundle，包括无 manifest 的 Claude 默认布局 bundle。 -- **配置更改需要重启 Gateway 网关。** +- 从 `~/.openclaw/extensions`、`/.openclaw/extensions` 和 `plugins.load.paths` 加载。 +- 设备发现接受原生 OpenClaw 插件以及兼容的 Codex bundle 和 Claude bundle，包括无 manifest 的 Claude 默认布局 bundle。 +- **配置变更需要重启 Gateway 网关。** - `allow`：可选允许列表（仅加载列出的插件）。`deny` 优先。 -- `plugins.entries..apiKey`：插件级 API key 便捷字段（插件支持时）。 +- `plugins.entries..apiKey`：插件级 API key 便利字段（当插件支持时）。 - `plugins.entries..env`：插件作用域环境变量映射。 -- `plugins.entries..hooks.allowPromptInjection`：为 `false` 时，核心会阻止 `before_prompt_build`，并忽略旧版 `before_agent_start` 中会修改提示词的字段，同时保留旧版 `modelOverride` 和 `providerOverride`。适用于原生插件 hooks 以及支持的 bundle 提供 hook 目录。 -- `plugins.entries..subagent.allowModelOverride`：显式信任该插件可为后台子智能体运行请求按次 `provider` 和 `model` 覆盖。 -- `plugins.entries..subagent.allowedModels`：针对受信任子智能体覆盖的可选规范 `provider/model` 目标允许列表。仅当你确实打算允许任意模型时才使用 `"*"`。 -- `plugins.entries..config`：插件定义的配置对象（若有原生 OpenClaw 插件 schema，则会据此校验）。 -- `plugins.entries.firecrawl.config.webFetch`：Firecrawl Web 获取提供商设置。 - - `apiKey`：Firecrawl API key（接受 SecretRef）。会回退到 `plugins.entries.firecrawl.config.webSearch.apiKey`、旧版 `tools.web.fetch.firecrawl.apiKey`，或 `FIRECRAWL_API_KEY` 环境变量。 +- `plugins.entries..hooks.allowPromptInjection`：为 `false` 时，核心会阻止 `before_prompt_build`，并忽略来自旧版 `before_agent_start` 的提示词变异字段，同时保留旧版 `modelOverride` 和 `providerOverride`。适用于原生插件 hooks 和受支持 bundle 提供的 hook 目录。 +- `plugins.entries..subagent.allowModelOverride`：显式信任此插件，使其可以为后台子智能体运行请求按次的 `provider` 和 `model` 覆盖。 +- `plugins.entries..subagent.allowedModels`：针对受信任子智能体覆盖的规范 `provider/model` 目标可选允许列表。只有当你确实想允许任意模型时，才使用 `"*"`。 +- `plugins.entries..config`：插件定义的配置对象（在可用时由原生 OpenClaw 插件 schema 验证）。 +- `plugins.entries.firecrawl.config.webFetch`：Firecrawl Web 抓取提供商设置。 + - `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`）。 + - `onlyMainContent`：仅提取页面主体内容（默认：`true`）。 - `maxAgeMs`：最大缓存年龄（毫秒）（默认：`172800000` / 2 天）。 - `timeoutSeconds`：抓取请求超时时间（秒）（默认：`60`）。 - `plugins.entries.xai.config.xSearch`：xAI X Search（Grok Web 搜索）设置。 - `enabled`：启用 X Search 提供商。 - `model`：用于搜索的 Grok 模型（例如 `"grok-4-1-fast"`）。 -- `plugins.entries.memory-core.config.dreaming`：记忆 dreaming（实验性）设置。关于阶段和阈值，请参见 [Dreaming](/zh-CN/concepts/dreaming)。 +- `plugins.entries.memory-core.config.dreaming`：记忆 dreaming（实验性）设置。阶段和阈值请参见 [Dreaming](/zh-CN/concepts/dreaming)。 - `enabled`：dreaming 总开关（默认 `false`）。 - `frequency`：每次完整 dreaming 扫描的 cron 频率（默认 `"0 3 * * *"`）。 - 阶段策略和阈值属于实现细节（不是面向用户的配置键）。 -- 已启用的 Claude bundle 插件也可以从 `settings.json` 提供嵌入式 Pi 默认值；OpenClaw 会将这些作为经过净化的智能体设置应用，而不是作为原始 OpenClaw 配置补丁。 -- `plugins.slots.memory`：选择活动 memory 插件 id，或设为 `"none"` 以禁用 memory 插件。 -- `plugins.slots.contextEngine`：选择活动 context engine 插件 id；默认是 `"legacy"`，除非你安装并选择了其他引擎。 -- `plugins.installs`：CLI 管理的安装元数据，由 `openclaw plugins update` 使用。 +- 已启用的 Claude bundle 插件还可以通过 `settings.json` 提供内嵌 Pi 默认值；OpenClaw 会将其作为已净化的智能体设置来应用，而不是作为原始 OpenClaw 配置补丁。 +- `plugins.slots.memory`：选择活动 memory 插件 id，或使用 `"none"` 禁用 memory 插件。 +- `plugins.slots.contextEngine`：选择活动上下文引擎插件 id；默认是 `"legacy"`，除非你安装并选择其他引擎。 +- `plugins.installs`：由 CLI 管理的安装元数据，供 `openclaw plugins update` 使用。 - 包括 `source`、`spec`、`sourcePath`、`installPath`、`version`、`resolvedName`、`resolvedVersion`、`resolvedSpec`、`integrity`、`shasum`、`resolvedAt`、`installedAt`。 - - 请将 `plugins.installs.*` 视为受管状态；优先使用 CLI 命令而不是手动编辑。 + - 将 `plugins.installs.*` 视为受管状态；优先使用 CLI 命令，而不是手动编辑。 参见 [Plugins](/zh-CN/tools/plugin)。 @@ -2628,7 +2641,7 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 evaluateEnabled: true, defaultProfile: "user", ssrfPolicy: { - dangerouslyAllowPrivateNetwork: true, // 默认可信网络模式 + dangerouslyAllowPrivateNetwork: true, // 默认受信网络模式 // allowPrivateNetwork: true, // 旧版别名 // hostnameAllowlist: ["*.example.com", "example.com"], // allowedHostnames: ["localhost"], @@ -2656,23 +2669,27 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 ``` - `evaluateEnabled: false` 会禁用 `act:evaluate` 和 `wait --fn`。 -- `ssrfPolicy.dangerouslyAllowPrivateNetwork` 在未设置时默认为 `true`（可信网络模型）。 +- 当未设置时，`ssrfPolicy.dangerouslyAllowPrivateNetwork` 默认值为 `true`（受信网络模型）。 - 如需严格的仅公网浏览器导航，请设置 `ssrfPolicy.dangerouslyAllowPrivateNetwork: false`。 -- 在严格模式下，远程 CDP profile 端点（`profiles.*.cdpUrl`）在可达性/发现检查期间也会受到相同的私有网络阻止策略约束。 -- `ssrfPolicy.allowPrivateNetwork` 仍作为旧版别名受支持。 -- 在严格模式下，使用 `ssrfPolicy.hostnameAllowlist` 和 `ssrfPolicy.allowedHostnames` 作为显式例外。 -- 远程 profile 为仅附加模式（禁用 start/stop/reset）。 +- 在严格模式下，远程 CDP 配置文件端点（`profiles.*.cdpUrl`）在可达性/设备发现检查期间也会受到同样的私有网络阻止。 +- `ssrfPolicy.allowPrivateNetwork` 仍支持作为旧版别名。 +- 在严格模式下，使用 `ssrfPolicy.hostnameAllowlist` 和 `ssrfPolicy.allowedHostnames` 配置显式例外。 +- 远程配置文件为仅附加模式（禁用 start/stop/reset）。 - `profiles.*.cdpUrl` 接受 `http://`、`https://`、`ws://` 和 `wss://`。 - 当你希望 OpenClaw 发现 `/json/version` 时使用 HTTP(S)； - 当提供商直接给你 DevTools WebSocket URL 时使用 WS(S)。 -- `existing-session` profile 仅限宿主机，并使用 Chrome MCP 而不是 CDP。 -- `existing-session` profile 可设置 `userDataDir`，以指向特定基于 Chromium 的浏览器 profile，例如 Brave 或 Edge。 -- `existing-session` profile 保留当前 Chrome MCP 路由限制： - 使用 snapshot/ref 驱动操作而不是 CSS 选择器定位，单文件上传 hook，无对话框超时覆盖，无 `wait --load networkidle`，也不支持 `responsebody`、PDF 导出、下载拦截或批处理操作。 -- 本地受管 `openclaw` profile 会自动分配 `cdpPort` 和 `cdpUrl`；仅在远程 CDP 时显式设置 `cdpUrl`。 -- 自动检测顺序：默认浏览器（如果是基于 Chromium）→ Chrome → Brave → Edge → Chromium → Chrome Canary。 -- 控制服务：仅 loopback（端口从 `gateway.port` 派生，默认 `18791`）。 -- `extraArgs` 会将额外启动标志附加到本地 Chromium 启动参数中（例如 `--disable-gpu`、窗口大小或调试标志）。 + 当你希望 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` 配置文件会自动分配 `cdpPort` 和 `cdpUrl`；只有在远程 CDP 情况下才需要显式设置 `cdpUrl`。 +- 自动检测顺序：默认浏览器（如果是 Chromium 系）→ Chrome → Brave → Edge → Chromium → Chrome Canary。 +- 控制服务：仅 loopback（端口由 `gateway.port` 派生，默认 `18791`）。 +- `extraArgs` 会向本地 Chromium 启动追加额外启动参数（例如 + `--disable-gpu`、窗口大小或调试标志）。 --- @@ -2684,14 +2701,14 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 seamColor: "#FF4500", assistant: { name: "OpenClaw", - avatar: "CB", // emoji、短文本、图像 URL 或 data URI + avatar: "CB", // emoji、短文本、图片 URL 或 data URI }, }, } ``` -- `seamColor`：原生应用 UI 外观的强调色（Talk 模式气泡色调等）。 -- `assistant`：Control UI identity 覆盖。会回退到活动智能体 identity。 +- `seamColor`：原生应用 UI 外观的强调色（Talk Mode 气泡色调等）。 +- `assistant`：Control UI 身份覆盖。会回退到活动智能体身份。 --- @@ -2707,7 +2724,7 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 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 + // trustedProxy: { userHeader: "x-forwarded-user" }, // 用于 mode=trusted-proxy；参见 /gateway/trusted-proxy-auth allowTailscale: true, rateLimit: { maxAttempts: 10, @@ -2724,7 +2741,7 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 enabled: true, basePath: "/openclaw", // root: "dist/control-ui", - // allowedOrigins: ["https://control.example.com"], // 非 loopback Control UI 必填 + // allowedOrigins: ["https://control.example.com"], // 非 loopback Control UI 必需 // dangerouslyAllowHostHeaderOriginFallback: false, // 危险的 Host header origin 回退模式 // allowInsecureAuth: false, // dangerouslyDisableDeviceAuth: false, @@ -2739,7 +2756,7 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 // 可选。默认 false。 allowRealIpFallback: false, tools: { - // 额外的 /tools/invoke HTTP deny + // 附加的 /tools/invoke HTTP deny deny: ["browser"], // 从默认 HTTP deny 列表中移除工具 allow: ["gateway"], @@ -2758,49 +2775,39 @@ base URL 不应包含 `/v1`（Anthropic 客户端会自行追加）。快捷方 -- `mode`：`local`（运行 gateway）或 `remote`（连接远程 gateway）。除非为 `local`，否则 Gateway 网关会拒绝启动。 -- `port`：WS + HTTP 复用的单一端口。优先级：`--port` > `OPENCLAW_GATEWAY_PORT` > `gateway.port` > `18789`。 +- `mode`：`local`（运行 Gateway 网关）或 `remote`（连接远程 Gateway 网关）。除非为 `local`，否则 Gateway 网关拒绝启动。 +- `port`：用于 WS + HTTP 的单一复用端口。优先级：`--port` > `OPENCLAW_GATEWAY_PORT` > `gateway.port` > `18789`。 - `bind`：`auto`、`loopback`（默认）、`lan`（`0.0.0.0`）、`tailnet`（仅 Tailscale IP）或 `custom`。 -- **旧版 bind 别名**：在 `gateway.bind` 中使用 bind 模式值（`auto`、`loopback`、`lan`、`tailnet`、`custom`），而不是主机别名（`0.0.0.0`、`127.0.0.1`、`localhost`、`::`、`::1`）。 -- **Docker 说明**：默认的 `loopback` bind 会在容器内部监听 `127.0.0.1`。使用 Docker bridge 网络（`-p 18789:18789`）时，流量会到达 `eth0`，因此 gateway 不可达。请使用 `--network host`，或设置 `bind: "lan"`（或 `bind: "custom"` 并设置 `customBindHost: "0.0.0.0"`）以监听所有接口。 -- **认证**：默认要求认证。非 loopback 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` 的身份 header（参见 [Trusted Proxy Auth](/zh-CN/gateway/trusted-proxy-auth)）。该模式要求 **非 loopback** 代理来源；同机 loopback 反向代理不满足 trusted-proxy auth 的要求。 -- `gateway.auth.allowTailscale`：为 `true` 时，Tailscale Serve identity header 可以满足 Control UI/WebSocket 认证（通过 `tailscale whois` 校验）。HTTP API 端点**不会**使用该 Tailscale header 认证；它们仍遵循 gateway 的常规 HTTP 认证模式。该无 token 流程假设 gateway 主机受信任。当 `tailscale.mode = "serve"` 时默认值为 `true`。 -- `gateway.auth.rateLimit`：可选的认证失败限制器。按客户端 IP 及认证作用域生效（共享密钥和设备 token 会分别跟踪）。被阻止的尝试返回 `429` + `Retry-After`。 - - 在异步 Tailscale Serve Control UI 路径上，同一 `{scope, clientIp}` 的失败尝试会在写入失败记录前被串行化。因此，同一客户端的并发错误尝试可能会在第二个请求上触发限制，而不是两个都仅作为普通不匹配通过。 - - `gateway.auth.rateLimit.exemptLoopback` 默认值为 `true`；当你有意希望 localhost 流量也被限速时（例如测试设置或严格代理部署），设为 `false`。 -- 来自浏览器 origin 的 WS 认证尝试始终会在关闭 loopback 豁免的情况下节流（作为针对基于浏览器的 localhost 暴力破解的纵深防御）。 -- 在 loopback 上，这些来自浏览器 origin 的锁定会按规范化后的 `Origin` 值隔离，因此一个 localhost origin 的重复失败不会自动锁定另一个 origin。 -- `tailscale.mode`：`serve`（仅 tailnet，loopback bind）或 `funnel`（公开访问，需要认证）。 -- `controlUi.allowedOrigins`：显式浏览器 origin 允许列表，用于 Gateway WebSocket 连接。当预期有来自非 loopback origin 的浏览器客户端时为必填。 -- `controlUi.dangerouslyAllowHostHeaderOriginFallback`：危险模式，可为有意依赖 Host header origin 策略的部署启用 Host header 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"`：显式无认证模式。仅用于受信的本地 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 header 认证；它们仍遵循 Gateway 网关正常的 HTTP 认证模式。此无 token 流程假设 Gateway 网关主机是受信的。当 `tailscale.mode = "serve"` 时默认为 `true`。 +- `gateway.auth.rateLimit`：可选的认证失败限制器。按客户端 IP 和认证作用域应用（共享密钥和设备 token 分开跟踪）。被阻止的尝试会返回 `429` + `Retry-After`。 + - 在异步 Tailscale Serve Control UI 路径上，对于相同 `{scope, clientIp}` 的失败尝试，会在写入失败记录前进行串行化。因此，同一客户端的并发错误尝试可能会在第二个请求时触发限制器，而不是两个都作为普通不匹配而竞态通过。 + - `gateway.auth.rateLimit.exemptLoopback` 默认值为 `true`；如果你确实希望 localhost 流量也被限速（用于测试环境或严格代理部署），请设置为 `false`。 +- 浏览器来源的 WS 认证尝试始终会在禁用 loopback 豁免的情况下受到限流（作为针对基于浏览器的 localhost 暴力破解的纵深防御）。 +- 在 loopback 上，这些浏览器来源锁定会按规范化后的 `Origin` + 值进行隔离，因此来自某个 localhost origin 的重复失败不会自动 + 锁定另一个不同的 origin。 +- `tailscale.mode`：`serve`（仅 tailnet，loopback bind）或 `funnel`（公网，需要认证）。 +- `controlUi.allowedOrigins`：Gateway 网关 WebSocket 连接的显式浏览器来源允许列表。当浏览器客户端来自非 loopback origin 时必需。 +- `controlUi.dangerouslyAllowHostHeaderOriginFallback`：危险模式，用于那些刻意依赖 Host-header origin 策略的部署，可启用 Host-header origin 回退。 - `remote.transport`：`ssh`（默认）或 `direct`（ws/wss）。对于 `direct`，`remote.url` 必须是 `ws://` 或 `wss://`。 -- `OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1`：客户端侧的紧急覆盖，允许向受信任私有网络 IP 使用明文 `ws://`；默认仍仅允许 loopback 使用明文。 -- `gateway.remote.token` / `.password` 是远程客户端凭证字段。它们本身不会配置 gateway 认证。 -- `gateway.push.apns.relay.baseUrl`：官方/TestFlight iOS 构建在向 gateway 发布基于 relay 的注册后，用于外部 APNs relay 的基础 HTTPS URL。该 URL 必须与 iOS 构建中编译进去的 relay URL 匹配。 -- `gateway.push.apns.relay.timeoutMs`：gateway 到 relay 的发送超时时间（毫秒）。默认值：`10000`。 -- 基于 relay 的注册会委托给特定 gateway identity。配对的 iOS 应用会获取 `gateway.identity.get`，在 relay 注册中包含该 identity，并将注册范围的发送授权转发给 gateway。其他 gateway 无法复用该已存储注册。 -- `OPENCLAW_APNS_RELAY_BASE_URL` / `OPENCLAW_APNS_RELAY_TIMEOUT_MS`：针对上述 relay 配置的临时环境变量覆盖。 -- `OPENCLAW_APNS_RELAY_ALLOW_HTTP=true`：仅开发用逃逸开关，用于 loopback HTTP relay URL。生产 relay URL 应保持 HTTPS。 -- `gateway.channelHealthCheckMinutes`：渠道健康监控间隔（分钟）。设为 `0` 可全局禁用健康监控重启。默认值：`5`。 +- `OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1`：客户端侧的紧急开关，允许对受信私有网络 IP 使用明文 `ws://`；默认仍只允许对 loopback 使用明文。 +- `gateway.remote.token` / `.password` 是远程客户端凭据字段。它们本身不会配置 Gateway 网关认证。 +- `gateway.push.apns.relay.baseUrl`：官方/TestFlight iOS 构建在向 Gateway 网关发布基于 relay 的注册后所使用的外部 APNs relay 的 base HTTPS URL。该 URL 必须与编译进 iOS 构建中的 relay URL 一致。 +- `gateway.push.apns.relay.timeoutMs`：Gateway 网关到 relay 的发送超时时间（毫秒）。默认值为 `10000`。 +- 基于 relay 的注册会委托给特定 Gateway 网关身份。已配对的 iOS 应用会获取 `gateway.identity.get`，在 relay 注册中包含该身份，并向 Gateway 网关转发一个基于注册范围的发送授权。其他 Gateway 网关不能复用该已存储注册。 +- `OPENCLAW_APNS_RELAY_BASE_URL` / `OPENCLAW_APNS_RELAY_TIMEOUT_MS`：上述 relay 配置的临时环境变量覆盖。 +- `OPENCLAW_APNS_RELAY_ALLOW_HTTP=true`：仅用于开发的紧急开关，允许 loopback HTTP relay URL。生产 relay URL 应保持为 HTTPS。 +- `gateway.channelHealthCheckMinutes`：渠道健康监测间隔（分钟）。设置为 `0` 可全局禁用健康监测重启。默认值：`5`。 - `gateway.channelStaleEventThresholdMinutes`：陈旧 socket 阈值（分钟）。应保持其大于或等于 `gateway.channelHealthCheckMinutes`。默认值：`30`。 -- `gateway.channelMaxRestartsPerHour`：每渠道/账号在滚动 1 小时内的最大健康监控重启次数。默认值：`10`。 -- `channels..healthMonitor.enabled`：在保持全局监控启用的同时，为单个渠道选择退出健康监控重启。 -- `channels..accounts..healthMonitor.enabled`：多账号渠道的按账号覆盖。设置后优先于渠道级覆盖。 -- 本地 gateway 调用路径只有在 `gateway.auth.*` 未设置时，才会将 `gateway.remote.*` 用作回退。 -- 如果 `gateway.auth.token` / `gateway.auth.password` 通过 SecretRef 显式配置但无法解析，则解析会故障关闭（不会用远程回退掩盖）。 -- `trustedProxies`：终止 TLS 或注入转发客户端 header 的反向代理 IP。只列出你控制的代理。loopback 条目对同机代理/本地检测设置（例如 Tailscale Serve 或本地反向代理）仍然有效，但它们**不会**让 loopback 请求符合 `gateway.auth.mode: "trusted-proxy"` 的资格。 -- `allowRealIpFallback`：为 `true` 时，如果缺少 `X-Forwarded-For`，gateway 会接受 `X-Real-IP`。默认值 `false`，以实现故障关闭行为。 -- `gateway.tools.deny`：针对 HTTP `POST /tools/invoke` 额外阻止的工具名称（扩展默认 deny 列表）。 -- `gateway.tools.allow`：从默认 HTTP deny 列表中移除工具名称。 - - - -### OpenAI 兼容端点 - -- Chat Completions：默认禁用。通过 `gateway.http.endpoints.chatCompletions.enabled: true` 启用。 -- Responses API：`gateway.http.endpoints.responses.enabled`。 -- Responses URL 输入加固： - - `gateway \ No newline at end of file +- `gateway.channelMaxRestartsPerHour`：滚动一小时内，每个渠道/账号允许的最大健康监测重启次数。默认值：`10`。 +- `channels..healthMonitor.enabled`：在保留全局监测启用状态的同时，按渠道选择退出健康监测重启。 +- `channels..accounts..healthMonitor.enabled`：多账号渠道的每账号覆盖。设置后，它优先于渠道级覆盖。 +- 仅当 `gateway.auth.*` 未设置时，本地 Gateway 网关调用路径才可以使用 `gateway.remote.*` 作为回退。 +- 如果 `gateway.auth.token` / `gateway.auth.password` 通过 SecretRef 显式配置但未解析，则解析会失败关闭（不会用远程回退掩盖）。 +- `trustedProxies`：终止 TLS 或注入转发客户端头的反向代理 IP。仅列出你控制的代理。loopback 条目对同机代理/本地检测设置（例如 Tailscale Serve 或本地反 \ No newline at end of file