diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index df19ea397..75d6f9b25 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -1,96 +1,104 @@ --- read_when: - 在本地或 CI 中运行测试 - - 为模型/提供商缺陷添加回归测试 + - 为模型 / 提供商缺陷添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包：unit/e2e/live 测试套件、Docker 运行器，以及每项测试涵盖的内容 +summary: 测试工具包：单元 / e2e / live 测试套件、Docker 运行器，以及每类测试覆盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-14T14:00:57Z" + generated_at: "2026-04-14T20:31:11Z" model: gpt-5.4 provider: openai - source_hash: ba64fd19580b8064078fcf885a2c7d99db70fc03de6d59c64cdcc31ab8ea4c43 + source_hash: 5efa95e37c3c4b8d4ff979b42981fb238dd8441b747d38a81c66d77050d78337 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三套 Vitest 测试套件（unit/integration、e2e、live）以及一小组 Docker 运行器。 +OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、live），以及一小组 Docker 运行器。 本文档是一份“我们如何测试”的指南： -- 每个测试套件覆盖什么内容（以及它刻意**不**覆盖什么） +- 每个测试套件覆盖什么内容（以及它**刻意不**覆盖什么） - 常见工作流应运行哪些命令（本地、推送前、调试） -- live 测试如何发现凭证并选择模型/提供商 -- 如何为真实世界中的模型/提供商问题添加回归测试 +- live 测试如何发现凭证并选择模型 / 提供商 +- 如何为真实世界中的模型 / 提供商问题添加回归测试 ## 快速开始 -大多数情况下： +大多数时候： -- 完整门禁（推送前的预期要求）：`pnpm build && pnpm check && pnpm test` -- 在配置宽裕的机器上更快地运行本地完整测试套件：`pnpm test:max` +- 完整 gate（推送前的预期要求）：`pnpm build && pnpm check && pnpm test` +- 在资源充足的机器上更快地运行本地完整测试套件：`pnpm test:max` - 直接进入 Vitest 监听循环：`pnpm test:watch` -- 现在也支持直接按文件路径定位 extension/channel 路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` -- 当你在迭代单个失败用例时，优先使用有针对性的运行方式。 +- 现在也支持直接按文件路径定位扩展 / 渠道路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` +- 当你在迭代单个失败用例时，优先先跑有针对性的测试。 - Docker 支持的 QA 站点：`pnpm qa:lab:up` - Linux VM 支持的 QA 通道：`pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline` -当你修改了测试，或想获得更多信心时： +当你修改了测试或希望获得更高信心时： -- 覆盖率门禁：`pnpm test:coverage` +- 覆盖率 gate：`pnpm test:coverage` - E2E 测试套件：`pnpm test:e2e` -当你在调试真实提供商/模型时（需要真实凭证）： +当你在调试真实提供商 / 模型时（需要真实凭证）： -- Live 测试套件（模型 + Gateway 网关工具/图像探测）：`pnpm test:live` -- 安静地只运行一个 live 文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` +- live 测试套件（模型 + Gateway 网关工具 / 图像探测）：`pnpm test:live` +- 静默运行单个 live 文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` -提示：当你只需要一个失败用例时，优先通过下面描述的 allowlist 环境变量来缩小 live 测试范围。 +提示：如果你只需要一个失败用例，优先通过下面描述的 allowlist 环境变量缩小 live 测试范围。 ## QA 专用运行器 -当你需要接近 QA lab 的真实环境时，这些命令与主测试套件配合使用： +当你需要接近 QA-lab 的真实环境时，这些命令与主测试套件配合使用： - `pnpm openclaw qa suite` - - 直接在主机上运行基于仓库的 QA 场景。 - - 默认会使用隔离的 Gateway 网关 worker 并行运行多个选定场景，最多 64 个 worker，或以所选场景数为上限。使用 `--concurrency ` 调整 worker 数量，或使用 `--concurrency 1` 切换为旧的串行通道。 + - 直接在主机上运行仓库支持的 QA 场景。 + - 默认并行运行多个已选场景，并为每个场景使用隔离的 Gateway 网关 worker，最多 64 个 worker，或与所选场景数相同。使用 `--concurrency ` 调整 worker 数，或使用 `--concurrency 1` 回退到旧的串行通道。 - `pnpm openclaw qa suite --runner multipass` - - 在一次性的 Multipass Linux VM 中运行同一套 QA 测试。 + - 在一次性的 Multipass Linux VM 中运行相同的 QA 测试套件。 - 保持与主机上 `qa suite` 相同的场景选择行为。 - - 复用与 `qa suite` 相同的提供商/模型选择标志。 - - Live 运行会转发对来宾机实用的受支持 QA 凭证输入：基于环境变量的提供商密钥、QA live 提供商配置路径，以及存在时的 `CODEX_HOME`。 - - 输出目录必须保留在仓库根目录下，以便来宾机能够通过挂载的工作区回写内容。 - - 将常规 QA 报告 + 摘要以及 Multipass 日志写入 `.artifacts/qa-e2e/...`。 + - 复用与 `qa suite` 相同的提供商 / 模型选择参数。 + - live 运行会向来宾转发受支持且适合在该环境中使用的 QA 凭证输入： + 基于环境变量的提供商密钥、QA live 提供商配置路径，以及存在时的 `CODEX_HOME`。 + - 输出目录必须位于仓库根目录下，这样来宾才能通过挂载的工作区写回结果。 + - 会将常规 QA 报告 + 摘要以及 Multipass 日志写入 + `.artifacts/qa-e2e/...`。 - `pnpm qa:lab:up` - - 启动由 Docker 支持的 QA 站点，供操作型 QA 工作使用。 + - 启动基于 Docker 的 QA 站点，供偏操作员风格的 QA 工作使用。 - `pnpm openclaw qa matrix` - - 针对一次性的 Docker 支持 Tuwunel homeserver 运行 Matrix live QA 通道。 - - 配置三个临时 Matrix 用户（`driver`、`sut`、`observer`）和一个私有房间，然后启动一个使用真实 Matrix 插件作为 SUT 传输层的 QA Gateway 网关子进程。 - - 默认使用固定稳定版 Tuwunel 镜像 `ghcr.io/matrix-construct/tuwunel:v1.5.1`。如果你需要测试其他镜像，可通过 `OPENCLAW_QA_MATRIX_TUWUNEL_IMAGE` 覆盖。 - - 由于该通道会在本地配置临时用户，Matrix 目前只支持 `--credential-source env`。 - - 将 Matrix QA 报告、摘要和 observed-events 工件写入 `.artifacts/qa-e2e/...`。 + - 针对一个一次性的、基于 Docker 的 Tuwunel homeserver 运行 Matrix live QA 通道。 + - 这个 QA 主机当前仅用于仓库 / 开发环境。打包后的 OpenClaw 安装不会附带 + `qa-lab`，因此也不会暴露 `openclaw qa`。 + - 仓库检出可以直接链接树内插件： + `openclaw plugins install -l ./extensions/qa-matrix`。 + - 预置三个临时 Matrix 用户（`driver`、`sut`、`observer`）以及一个私有房间，然后使用真实 Matrix 插件作为 SUT 传输层启动一个 QA Gateway 网关子进程。 + - 默认使用固定的稳定版 Tuwunel 镜像 `ghcr.io/matrix-construct/tuwunel:v1.5.1`。如需测试其他镜像，可用 `OPENCLAW_QA_MATRIX_TUWUNEL_IMAGE` 覆盖。 + - Matrix 不暴露共享的凭证来源参数，因为该通道会在本地预置一次性用户。 + - 会将 Matrix QA 报告、摘要和观测到的事件产物写入 `.artifacts/qa-e2e/...`。 - `pnpm openclaw qa telegram` - - 使用环境变量中的 driver 和 SUT bot token，针对真实私有群组运行 Telegram live QA 通道。 + - 使用环境变量中的 driver 和 SUT 机器人令牌，针对真实私有群组运行 Telegram live QA 通道。 - 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。群组 id 必须是 Telegram 聊天的数字 id。 - - 支持 `--credential-source convex` 以使用共享池化凭证。默认使用 env 模式，或者设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用池化租约。 - - 需要两个位于同一私有群组中的不同 bot，并且 SUT bot 需要公开一个 Telegram 用户名。 - - 为了稳定观察 bot 间通信，请在 `@BotFather` 中为两个 bot 启用 Bot-to-Bot Communication Mode，并确保 driver bot 能观察群组中的 bot 流量。 - - 将 Telegram QA 报告、摘要和 observed-messages 工件写入 `.artifacts/qa-e2e/...`。 + - 支持 `--credential-source convex` 以使用共享的池化凭证。默认使用 env 模式，或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用池化租约。 + - 需要两个不同的机器人位于同一个私有群组中，并且 SUT 机器人需要公开一个 Telegram 用户名。 + - 为了稳定地观察机器人与机器人之间的通信，请在 `@BotFather` 中为两个机器人都启用 Bot-to-Bot Communication Mode，并确保 driver 机器人可以观察群组中的机器人流量。 + - 会将 Telegram QA 报告、摘要和观测到的消息产物写入 `.artifacts/qa-e2e/...`。 -Live 传输通道共享一份标准契约，以防新传输方式发生漂移： +live 传输通道共享同一份标准契约，以避免新增传输方式出现漂移： -`qa-channel` 仍然是覆盖范围较广的合成 QA 测试套件，不属于 live 传输覆盖矩阵的一部分。 +`qa-channel` 仍然是覆盖面较广的合成 QA 测试套件，不属于 live +传输覆盖矩阵的一部分。 -| 通道 | Canary | 提及门控 | Allowlist 屏蔽 | 顶层回复 | 重启恢复 | 线程后续跟进 | 线程隔离 | Reaction 观察 | 帮助命令 | -| ---- | ------ | -------- | -------------- | -------- | -------- | ------------ | -------- | -------------- | -------- | -| Matrix | x | x | x | x | x | x | x | x | | -| Telegram | x | | | | | | | | x | +| 通道 | Canary | 提及门控 | Allowlist 阻止 | 顶层回复 | 重启恢复 | 线程跟进 | 线程隔离 | Reaction 观察 | 帮助命令 | +| ---- | ------ | -------- | -------------- | -------- | -------- | -------- | -------- | ------------- | -------- | +| Matrix | x | x | x | x | x | x | x | x | | +| Telegram | x | | | | | | | | x | ### 通过 Convex 共享 Telegram 凭证（v1） -当为 `openclaw qa telegram` 启用 `--credential-source convex`（或 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex`）时，QA lab 会从 Convex 支持的池中获取一个独占租约，在通道运行期间对该租约发送心跳，并在关闭时释放该租约。 +当为 `openclaw qa telegram` 启用 `--credential-source convex`（或 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex`）时， +QA lab 会从一个由 Convex 支持的凭证池中获取独占租约，在该通道运行期间为该租约发送心跳，并在关闭时释放租约。 参考 Convex 项目脚手架： @@ -99,12 +107,12 @@ Live 传输通道共享一份标准契约，以防新传输方式发生漂移： 必需的环境变量： - `OPENCLAW_QA_CONVEX_SITE_URL`（例如 `https://your-deployment.convex.site`） -- 为所选角色提供一个 secret： - - `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` 用于 `maintainer` - - `OPENCLAW_QA_CONVEX_SECRET_CI` 用于 `ci` +- 为所选角色提供一个密钥： + - `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` 对应 `maintainer` + - `OPENCLAW_QA_CONVEX_SECRET_CI` 对应 `ci` - 凭证角色选择： - CLI：`--credential-role maintainer|ci` - - 环境变量默认值：`OPENCLAW_QA_CREDENTIAL_ROLE`（默认是 `maintainer`） + - 环境变量默认值：`OPENCLAW_QA_CREDENTIAL_ROLE`（默认为 `maintainer`） 可选环境变量： @@ -113,14 +121,15 @@ Live 传输通道共享一份标准契约，以防新传输方式发生漂移： - `OPENCLAW_QA_CREDENTIAL_ACQUIRE_TIMEOUT_MS`（默认 `90000`） - `OPENCLAW_QA_CREDENTIAL_HTTP_TIMEOUT_MS`（默认 `15000`） - `OPENCLAW_QA_CONVEX_ENDPOINT_PREFIX`（默认 `/qa-credentials/v1`） -- `OPENCLAW_QA_CREDENTIAL_OWNER_ID`（可选追踪 id） +- `OPENCLAW_QA_CREDENTIAL_OWNER_ID`（可选跟踪 id） - `OPENCLAW_QA_ALLOW_INSECURE_HTTP=1` 允许在仅限本地开发时使用 loopback `http://` Convex URL。 正常运行时，`OPENCLAW_QA_CONVEX_SITE_URL` 应使用 `https://`。 -维护者管理命令（池添加/删除/列出）必须明确使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`。 +维护者管理命令（池添加 / 移除 / 列表）需要 +专门使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`。 -为维护者准备的 CLI 辅助命令： +面向维护者的 CLI 辅助命令： ```bash pnpm openclaw qa credentials add --kind telegram --payload-file qa/telegram-credential.json @@ -135,73 +144,78 @@ pnpm openclaw qa credentials remove --credential-id - `POST /acquire` - 请求：`{ kind, ownerId, actorRole, leaseTtlMs, heartbeatIntervalMs }` - 成功：`{ status: "ok", credentialId, leaseToken, payload, leaseTtlMs?, heartbeatIntervalMs? }` - - 耗尽/可重试：`{ status: "error", code: "POOL_EXHAUSTED" | "NO_CREDENTIAL_AVAILABLE", ... }` + - 耗尽 / 可重试：`{ status: "error", code: "POOL_EXHAUSTED" | "NO_CREDENTIAL_AVAILABLE", ... }` - `POST /heartbeat` - 请求：`{ kind, ownerId, actorRole, credentialId, leaseToken, leaseTtlMs }` - 成功：`{ status: "ok" }`（或空的 `2xx`） - `POST /release` - 请求：`{ kind, ownerId, actorRole, credentialId, leaseToken }` - 成功：`{ status: "ok" }`（或空的 `2xx`） -- `POST /admin/add`（仅限 maintainer secret） +- `POST /admin/add`（仅限 maintainer 密钥） - 请求：`{ kind, actorId, payload, note?, status? }` - 成功：`{ status: "ok", credential }` -- `POST /admin/remove`（仅限 maintainer secret） +- `POST /admin/remove`（仅限 maintainer 密钥） - 请求：`{ credentialId, actorId }` - 成功：`{ status: "ok", changed, credential }` - 活跃租约保护：`{ status: "error", code: "LEASE_ACTIVE", ... }` -- `POST /admin/list`（仅限 maintainer secret） +- `POST /admin/list`（仅限 maintainer 密钥） - 请求：`{ kind?, status?, includePayload?, limit? }` - 成功：`{ status: "ok", credentials, count }` Telegram 类型的负载结构： - `{ groupId: string, driverToken: string, sutToken: string }` -- `groupId` 必须是 Telegram 聊天数字 id 的字符串形式。 -- 对于 `kind: "telegram"`，`admin/add` 会验证该结构，并拒绝格式不正确的负载。 +- `groupId` 必须是 Telegram 聊天数字 id 的字符串。 +- 对于 `kind: "telegram"`，`admin/add` 会校验此结构，并拒绝格式错误的负载。 ### 向 QA 添加一个渠道 -要把一个渠道添加到 Markdown QA 系统中，**只需要**两样东西： +要将一个渠道添加到 Markdown QA 系统中，**只需要**两件事： 1. 该渠道的传输适配器。 -2. 用于验证该渠道契约的场景包。 +2. 一组用于验证渠道契约的场景包。 -当共享的 `qa-lab` 运行器可以承载流程时，不要添加渠道专用的 QA 运行器。 +当共享的 `qa-lab` 主机可以负责整个流程时，不要新增一个顶层 QA 命令根。 -`qa-lab` 负责共享机制： +`qa-lab` 负责共享主机机制： -- 测试套件启动与清理 +- `openclaw qa` 命令根 +- 测试套件启动与关闭 - worker 并发 -- 工件写入 +- 产物写入 - 报告生成 - 场景执行 -- 旧版 `qa-channel` 场景的兼容别名 +- 对旧版 `qa-channel` 场景的兼容别名 -渠道适配器负责传输契约： +运行器插件负责传输契约： +- `openclaw qa ` 如何挂载到共享的 `qa` 根命令下 - 如何为该传输方式配置 Gateway 网关 - 如何检查就绪状态 - 如何注入入站事件 - 如何观察出站消息 -- 如何暴露转录记录和标准化后的传输状态 -- 如何执行由传输支持的操作 -- 如何处理传输专属的重置或清理 +- 如何暴露转录内容和标准化后的传输状态 +- 如何执行基于传输的操作 +- 如何处理传输特定的重置或清理 -采用一个新渠道的最低门槛是： +新渠道的最低接入门槛是： -1. 在共享的 `qa-lab` 接缝上实现传输适配器。 -2. 在传输注册表中注册该适配器。 -3. 将传输专属机制保留在适配器或渠道 harness 内。 -4. 在 `qa/scenarios/` 下编写或改造 Markdown 场景。 -5. 为新场景使用通用场景辅助函数。 -6. 除非仓库正在进行有意的迁移，否则保持现有兼容别名可用。 +1. 保持由 `qa-lab` 拥有共享的 `qa` 根命令。 +2. 在共享的 `qa-lab` 主机接缝上实现传输运行器。 +3. 将传输特定机制保留在运行器插件或渠道 harness 内部。 +4. 将运行器挂载为 `openclaw qa `，而不是注册一个竞争性的根命令。 + 运行器插件应在 `openclaw.plugin.json` 中声明 `qaRunners`，并从 `runtime-api.ts` 导出匹配的 `qaRunnerCliRegistrations` 数组。 + 保持 `runtime-api.ts` 轻量；惰性的 CLI 和运行器执行应放在单独的入口点之后。 +5. 在 `qa/scenarios/` 下编写或适配 Markdown 场景。 +6. 对新场景使用通用场景辅助函数。 +7. 除非仓库正在进行有意的迁移，否则保持现有兼容别名继续可用。 决策规则非常严格： - 如果某个行为可以在 `qa-lab` 中统一表达一次，就把它放进 `qa-lab`。 -- 如果某个行为依赖于单一渠道传输，就把它保留在对应适配器或插件 harness 中。 -- 如果某个场景需要一种可供多个渠道使用的新能力，就添加一个通用辅助函数，而不是在 `suite.ts` 中添加渠道专属分支。 -- 如果某个行为只对一种传输有意义，就让该场景保持传输专用，并在场景契约中明确这一点。 +- 如果某个行为依赖于单一渠道传输方式，就把它保留在对应的运行器插件或插件 harness 中。 +- 如果某个场景需要一种多个渠道都可复用的新能力，就添加一个通用辅助函数，而不是在 `suite.ts` 中加入渠道特定分支。 +- 如果某个行为只对一种传输方式有意义，就让该场景保持传输特定，并在场景契约中明确说明。 新场景推荐使用的通用辅助函数名称： @@ -227,61 +241,63 @@ Telegram 类型的负载结构： - `resetBus` 新的渠道工作应使用这些通用辅助函数名称。 +兼容别名的存在是为了避免一次性迁移日，而不是作为 +新场景编写的范式。 -保留兼容别名是为了避免一次性大迁移，而不是作为新场景编写的范式。 +## 测试套件（各自运行位置） -## 测试套件（各自在哪里运行） +你可以把这些测试套件理解为“真实性逐步提升”（同时也意味着更高的脆弱性 / 成本）： -可以把这些测试套件理解为“真实度逐步提高”（同时波动性/成本也逐步增加）： - -### Unit / integration（默认） +### 单元 / 集成（默认） - 命令：`pnpm test` -- 配置：对现有分域 Vitest 项目执行十个顺序分片运行（`vitest.full-*.config.ts`） -- 文件：位于 `src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core/unit 清单，以及由 `vitest.unit.config.ts` 覆盖的已列入白名单的 `ui` node 测试 +- 配置：针对现有的作用域化 Vitest 项目，顺序运行十个分片（`vitest.full-*.config.ts`） +- 文件：位于 `src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 的 core / unit 清单，以及由 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 - 范围： - 纯单元测试 - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） - - 已知缺陷的确定性回归测试 + - 针对已知缺陷的确定性回归测试 - 预期： - 在 CI 中运行 - 不需要真实密钥 - 应该快速且稳定 - 项目说明： - - 无目标路径的 `pnpm test` 现在会运行 11 个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个庞大的原生根项目进程。这样可以降低高负载机器上的峰值 RSS，并避免 auto-reply/extension 工作拖累无关测试套件。 - - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` 项目图，因为多分片监听循环并不现实。 - - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会优先把显式文件/目录目标路由到对应的分域通道，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整根项目启动成本。 - - `pnpm test:changed` 会在差异只涉及可路由的源码/测试文件时，将变更的 git 路径扩展到同一套分域通道；配置/设置修改仍会回退到更广泛的根项目重跑。 - - 来自 agents、commands、plugins、auto-reply 辅助函数、`plugin-sdk` 以及类似纯工具区域的轻量导入单元测试，会路由到 `unit-fast` 通道，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态/运行时较重的文件仍保留在现有通道中。 - - 选定的 `plugin-sdk` 和 `commands` 辅助源码文件，也会在 changed 模式运行时映射到这些轻量通道中的显式同级测试，因此辅助函数修改无需为该目录重跑完整的重型测试套件。 - - `auto-reply` 现在有三个专用桶：顶层 core 辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以让最重的 reply harness 工作不影响廉价的 status/chunk/token 测试。 + - 无目标的 `pnpm test` 现在会运行 11 个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个巨大的原生根项目进程。这能降低繁忙机器上的峰值 RSS，并避免 auto-reply / 扩展工作拖累不相关的测试套件。 + - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` 项目图，因为多分片 watch 循环并不现实。 + - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会先通过作用域化通道路由显式文件 / 目录目标，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 无需承担完整根项目启动的开销。 + - 当变更只涉及可路由的源文件 / 测试文件时，`pnpm test:changed` 会将变更过的 Git 路径扩展到同样的作用域化通道；而配置 / setup 编辑仍会回退到更广泛的根项目重跑。 + - 来自 agents、commands、plugins、auto-reply 辅助函数、`plugin-sdk` 以及类似纯工具区域的轻导入单元测试会路由到 `unit-fast` 通道，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件则仍保留在现有通道中。 + - 一些选定的 `plugin-sdk` 和 `commands` 辅助源文件也会在 changed 模式运行中映射到这些轻量通道中的显式同级测试，因此对辅助函数的修改无需重跑该目录下的完整重型测试套件。 + - `auto-reply` 现在有三个专用桶：顶层 core 辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以让最重的 reply harness 工作不影响较轻量的 status / chunk / token 测试。 - 嵌入式运行器说明： - - 当你修改消息工具发现输入或压缩运行时上下文时，需要同时保持两层覆盖。 - - 为纯路由/标准化边界添加聚焦的辅助函数回归测试。 + - 当你修改消息工具发现输入或压缩运行时上下文时， + 要同时保留两个层级的覆盖。 + - 为纯路由 / 标准化边界添加聚焦的辅助函数回归测试。 - 同时也要保持嵌入式运行器集成测试套件健康： `src/agents/pi-embedded-runner/compact.hooks.test.ts`、 - `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts` 和 + `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts`，以及 `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`。 - - 这些测试套件会验证作用域 id 和压缩行为仍然会流经真实的 `run.ts` / `compact.ts` 路径；仅有辅助函数测试并不足以替代这些集成路径。 + - 这些测试套件会验证作用域 id 和压缩行为仍然会沿着真实的 `run.ts` / `compact.ts` 路径传递；仅有辅助函数测试并不能 + 充分替代这些集成路径。 - Pool 说明： - 基础 Vitest 配置现在默认使用 `threads`。 - - 共享 Vitest 配置还固定设置了 `isolate: false`，并在根项目、e2e 和 live 配置中使用非隔离运行器。 - - 根 UI 通道保留其 `jsdom` 设置和优化器，但现在也运行在共享的非隔离运行器上。 - - 每个 `pnpm test` 分片都从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 - - 共享的 `scripts/run-vitest.mjs` 启动器现在还会默认向 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行中的 V8 编译抖动。如果你需要与原生 V8 行为对比，可设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 -- 快速本地迭代说明： - - 当变更路径可以清晰映射到更小的测试套件时，`pnpm test:changed` 会通过分域通道运行。 + - 共享 Vitest 配置也固定使用 `isolate: false`，并在根项目、e2e 和 live 配置中使用非隔离运行器。 + - 根 UI 通道保留其 `jsdom` setup 和优化器，但现在也运行在共享的非隔离运行器上。 + - 每个 `pnpm test` 分片都会从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 + - 共享的 `scripts/run-vitest.mjs` 启动器现在默认还会为 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。如果你需要与原始 V8 行为做对比，设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 +- 本地快速迭代说明： + - 当变更路径可以清晰映射到更小的测试套件时，`pnpm test:changed` 会通过作用域化通道进行路由。 - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是使用更高的 worker 上限。 - - 本地 worker 自动扩缩容现在有意更保守，并且当主机负载平均值已经很高时也会回退，因此默认情况下多个并发 Vitest 运行对系统的影响会更小。 - - 基础 Vitest 配置将项目/配置文件标记为 `forceRerunTriggers`，以便在测试接线发生变化时，changed 模式重跑仍然正确。 - - 在受支持的主机上，配置会保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你希望为直接性能分析指定一个显式缓存位置，可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 + - 本地 worker 自动缩放现在故意更保守，并且在主机负载平均值已经较高时也会退让，因此默认情况下多个并发 Vitest 运行造成的影响更小。 + - 基础 Vitest 配置将项目 / 配置文件标记为 `forceRerunTriggers`，以便在测试接线发生变化时，changed 模式重跑仍然正确。 + - 配置会在受支持的主机上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你希望为直接性能分析指定一个明确的缓存位置，可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 - 性能调试说明： - - `pnpm test:perf:imports` 会启用 Vitest 导入时长报告以及导入分解输出。 - - `pnpm test:perf:imports:changed` 会将同样的分析视图限定到自 `origin/main` 以来发生变更的文件。 -- `pnpm test:perf:changed:bench -- --ref ` 会把已提交差异的路由 `test:changed` 与原生根项目路径进行比较，并打印墙钟时间以及 macOS 最大 RSS。 -- `pnpm test:perf:changed:bench -- --worktree` 会通过 `scripts/test-projects.mjs` 和根 Vitest 配置，将当前脏工作树中的变更文件列表进行路由，并对其进行基准测试。 - - `pnpm test:perf:profile:main` 会为 Vitest/Vite 启动和转换开销写出主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件并行时，为 unit 测试套件写出运行器 CPU + heap profile。 + - `pnpm test:perf:imports` 会启用 Vitest 导入耗时报告以及导入明细输出。 + - `pnpm test:perf:imports:changed` 会将相同的分析视图限定为自 `origin/main` 以来发生变化的文件。 +- `pnpm test:perf:changed:bench -- --ref ` 会将路由后的 `test:changed` 与针对该已提交 diff 的原生根项目路径进行比较，并打印 wall time 以及 macOS 最大 RSS。 +- `pnpm test:perf:changed:bench -- --worktree` 会通过 `scripts/test-projects.mjs` 和根 Vitest 配置，把当前未提交工作树中的变更文件列表进行路由，并对其进行基准测试。 + - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动和 transform 开销写出主线程 CPU profile。 + - `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下，为单元测试套件写出运行器 CPU + heap profile。 ### E2E（Gateway 网关冒烟测试） @@ -289,15 +305,15 @@ Telegram 类型的负载结构： - 配置：`vitest.e2e.config.ts` - 文件：`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts` - 运行时默认值： - - 使用 Vitest `threads` 且 `isolate: false`，与仓库其他部分保持一致。 + - 使用 Vitest `threads` 和 `isolate: false`，与仓库其余部分保持一致。 - 使用自适应 worker（CI：最多 2 个，本地：默认 1 个）。 - 默认以静默模式运行，以减少控制台 I/O 开销。 -- 常用覆盖项： - - `OPENCLAW_E2E_WORKERS=`：强制设置 worker 数量（上限为 16）。 - - `OPENCLAW_E2E_VERBOSE=1`：重新启用详细控制台输出。 +- 有用的覆盖项： + - `OPENCLAW_E2E_WORKERS=` 强制设置 worker 数量（上限为 16）。 + - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 - 范围： - 多实例 Gateway 网关端到端行为 - - WebSocket/HTTP 接口、节点配对以及更重的网络行为 + - WebSocket / HTTP 表面、节点配对和更重的网络交互 - 预期： - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 @@ -310,15 +326,15 @@ Telegram 类型的负载结构： - 范围： - 通过 Docker 在主机上启动一个隔离的 OpenShell Gateway 网关 - 从一个临时本地 Dockerfile 创建一个沙箱 - - 通过真实的 `sandbox ssh-config` + SSH 执行来验证 OpenClaw 的 OpenShell 后端 + - 通过真实的 `sandbox ssh-config` + SSH exec 运行 OpenClaw 的 OpenShell 后端 - 通过沙箱 fs bridge 验证远端规范化文件系统行为 - 预期： - 仅按需启用；不属于默认 `pnpm test:e2e` 运行的一部分 - - 需要本地 `openshell` CLI 和一个可用的 Docker daemon - - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，随后销毁测试 Gateway 网关和沙箱 -- 常用覆盖项： - - `OPENCLAW_E2E_OPENSHELL=1`：在手动运行更广泛的 e2e 测试套件时启用该测试 - - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell`：指向一个非默认的 CLI 二进制或包装脚本 + - 需要本地 `openshell` CLI 和可用的 Docker daemon + - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，然后销毁测试 Gateway 网关和沙箱 +- 有用的覆盖项： + - `OPENCLAW_E2E_OPENSHELL=1`：手动运行更广泛的 e2e 测试套件时启用该测试 + - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell`：指定一个非默认的 CLI 二进制或包装脚本 ### Live（真实提供商 + 真实模型） @@ -327,141 +343,141 @@ Telegram 类型的负载结构： - 文件：`src/**/*.live.test.ts` - 默认：由 `pnpm test:live` **启用**（会设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商/模型在今天配合真实凭证是否真的可用？” - - 捕获提供商格式变化、工具调用怪癖、认证问题以及速率限制行为 + - “这个提供商 / 模型**今天**在真实凭证下是否真的可用？” + - 捕获提供商格式变化、工具调用怪癖、认证问题和速率限制行为 - 预期： - - 按设计并不具备 CI 稳定性（真实网络、真实提供商策略、配额、故障） - - 会花钱 / 消耗速率限制 - - 优先运行缩小范围的子集，而不是“全部都跑” -- Live 运行会读取 `~/.profile` 以获取缺失的 API 密钥。 -- 默认情况下，live 运行仍会隔离 `HOME`，并将配置/认证材料复制到一个临时测试 home 中，这样单元测试夹具就无法修改你真实的 `~/.openclaw`。 -- 仅当你明确需要让 live 测试使用真实 home 目录时，才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 -- `pnpm test:live` 现在默认使用更安静的模式：保留 `[live] ...` 进度输出，但抑制额外的 `~/.profile` 提示，并静音 Gateway 网关启动日志/Bonjour 噪声。如果你想恢复完整启动日志，可设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 -- API 密钥轮换（提供商专属）：设置 `*_API_KEYS`（逗号/分号格式）或 `*_API_KEY_1`、`*_API_KEY_2`（例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`），或者通过 `OPENCLAW_LIVE_*_KEY` 进行每次 live 运行覆盖；测试会在遇到速率限制响应时重试。 -- 进度/心跳输出： - - Live 测试套件现在会把进度行输出到 stderr，因此即使 Vitest 控制台捕获处于安静模式，较长时间的提供商调用仍会显示为活动中。 - - `vitest.live.config.ts` 会禁用 Vitest 控制台拦截，因此在 live 运行期间，提供商/Gateway 网关进度行会立即流式输出。 + - 按设计并非 CI 稳定（真实网络、真实提供商策略、配额、故障） + - 会花钱 / 消耗速率限制额度 + - 优先运行缩小范围后的子集，而不是“全部” +- live 运行会加载 `~/.profile` 以补充缺失的 API 密钥。 +- 默认情况下，live 运行仍会隔离 `HOME`，并将配置 / 认证材料复制到临时测试 home 中，以防单元测试夹具改动你的真实 `~/.openclaw`。 +- 仅当你明确需要 live 测试使用真实 home 目录时，才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 +- `pnpm test:live` 现在默认采用更安静的模式：会保留 `[live] ...` 进度输出，但会抑制额外的 `~/.profile` 提示，并静音 Gateway 网关启动日志 / Bonjour 噪声。如果你想恢复完整启动日志，可设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 +- API 密钥轮换（按提供商区分）：可设置逗号 / 分号格式的 `*_API_KEYS`，或 `*_API_KEY_1`、`*_API_KEY_2`（例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`），也可通过 `OPENCLAW_LIVE_*_KEY` 进行每次 live 运行覆盖；测试在收到速率限制响应时会重试。 +- 进度 / 心跳输出： + - live 测试套件现在会将进度行输出到 stderr，因此即使 Vitest 控制台捕获较安静，长时间的提供商调用也能明确显示仍在运行。 + - `vitest.live.config.ts` 会禁用 Vitest 控制台拦截，以便提供商 / Gateway 网关进度行在 live 运行期间立即流式输出。 - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型心跳频率。 - - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关/探测心跳频率。 + - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / 探测心跳频率。 ## 我应该运行哪个测试套件？ -使用这个决策表： +使用这张决策表： -- 修改逻辑/测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） -- 涉及 Gateway 网关网络 / WS 协议 / 配对：补充运行 `pnpm test:e2e` -- 调试“我的 bot 挂了” / 提供商专属故障 / 工具调用：运行缩小范围的 `pnpm test:live` +- 编辑逻辑 / 测试：运行 `pnpm test`（如果你改动很多，也可加上 `pnpm test:coverage`） +- 触及 Gateway 网关网络 / WS 协议 / 配对：再加上 `pnpm test:e2e` +- 调试“我的机器人挂了” / 提供商特定故障 / 工具调用：运行缩小范围后的 `pnpm test:live` ## Live：Android 节点能力扫描 - 测试：`src/gateway/android-node.capabilities.live.test.ts` - 脚本：`pnpm android:test:integration` -- 目标：调用已连接 Android 节点当前**宣告的每一条命令**，并断言命令契约行为。 +- 目标：调用已连接 Android 节点当前公开的**每一个命令**，并断言命令契约行为。 - 范围： - - 依赖预置/手动设置（该测试套件不会安装/运行/配对应用）。 - - 针对所选 Android 节点逐条执行 Gateway 网关 `node.invoke` 验证。 -- 必需的预先设置： - - Android 应用已经连接并与 Gateway 网关配对。 + - 依赖前置 / 手动 setup（该测试套件不会安装 / 运行 / 配对应用）。 + - 针对所选 Android 节点，逐命令验证 Gateway 网关 `node.invoke`。 +- 必需的预先 setup： + - Android 应用已连接并与 Gateway 网关完成配对。 - 应用保持在前台。 - - 对于你希望通过的能力，所需权限/采集同意已授予。 + - 已授予你期望通过的能力所需的权限 / 捕获授权。 - 可选目标覆盖项： - `OPENCLAW_ANDROID_NODE_ID` 或 `OPENCLAW_ANDROID_NODE_NAME`。 - `OPENCLAW_ANDROID_GATEWAY_URL` / `OPENCLAW_ANDROID_GATEWAY_TOKEN` / `OPENCLAW_ANDROID_GATEWAY_PASSWORD`。 -- 完整 Android 设置详情：[Android App](/zh-CN/platforms/android) +- 完整 Android setup 详情：[Android App](/zh-CN/platforms/android) -## Live：模型冒烟测试（profile key） +## Live：模型冒烟测试（profile 密钥） -Live 测试拆分为两层，以便我们隔离故障： +live 测试被拆分为两层，以便我们隔离故障： -- “直接模型”告诉我们，在给定 key 下，提供商/模型是否至少能够响应。 +- “直接模型”告诉我们，提供商 / 模型在给定密钥下是否至少能够回复。 - “Gateway 网关冒烟测试”告诉我们，该模型的完整 Gateway 网关 + 智能体流水线是否正常工作（会话、历史、工具、沙箱策略等）。 ### 第 1 层：直接模型补全（无 Gateway 网关） - 测试：`src/agents/models.profiles.live.test.ts` - 目标： - - 枚举发现到的模型 - - 使用 `getApiKeyForModel` 选择你拥有凭证的模型 - - 对每个模型运行一次小型补全（以及在需要时运行有针对性的回归测试） + - 枚举已发现的模型 + - 使用 `getApiKeyForModel` 选择你有凭证的模型 + - 对每个模型运行一次小型补全（并在需要时执行有针对性的回归测试） - 启用方式： - `pnpm test:live`（或在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） -- 设置 `OPENCLAW_LIVE_MODELS=modern`（或 `all`，它是 modern 的别名）才会真正运行该测试套件；否则它会跳过，以便让 `pnpm test:live` 聚焦于 Gateway 网关冒烟测试 -- 选择模型的方式： - - `OPENCLAW_LIVE_MODELS=modern`：运行 modern allowlist（Opus/Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - - `OPENCLAW_LIVE_MODELS=all`：modern allowlist 的别名 +- 设置 `OPENCLAW_LIVE_MODELS=modern`（或 `all`，即 modern 的别名）来真正运行该测试套件；否则它会跳过，以便让 `pnpm test:live` 聚焦于 Gateway 网关冒烟测试 +- 如何选择模型： + - `OPENCLAW_LIVE_MODELS=modern` 运行 modern allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） + - `OPENCLAW_LIVE_MODELS=all` 是 modern allowlist 的别名 - 或 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） - - modern/all 扫描默认会限制在一个精心挑选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行完整的 modern 扫描，或设置一个正数作为更小的上限。 -- 选择提供商的方式： + - modern / all 扫描默认使用一组精挑细选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可进行穷尽式 modern 扫描，或设置为正数以采用更小的上限。 +- 如何选择提供商： - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔的 allowlist） - 密钥来源： - 默认：profile 存储和环境变量回退 - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制**仅**使用 profile 存储 -- 这一层存在的原因： - - 将“提供商 API 坏了 / key 无效”与“Gateway 网关智能体流水线坏了”区分开 - - 容纳小型、隔离的回归测试（例如：OpenAI Responses/Codex Responses 的 reasoning replay + tool-call 流程） +- 该层存在的原因： + - 将“提供商 API 出问题 / 密钥无效”与“Gateway 网关智能体流水线出问题”分离开 + - 容纳小而隔离的回归测试（例如：OpenAI Responses / Codex Responses 推理重放 + 工具调用流程） -### 第 2 层：Gateway 网关 + dev 智能体冒烟测试（也就是 “@openclaw” 实际执行的内容） +### 第 2 层：Gateway 网关 + 开发智能体冒烟测试（也就是 “@openclaw” 的实际行为） - 测试：`src/gateway/gateway-models.profiles.live.test.ts` - 目标： - 启动一个进程内 Gateway 网关 - - 创建/修补一个 `agent:dev:*` 会话（每次运行可覆盖模型） - - 遍历带有密钥的模型并断言： - - 有“有意义”的响应（无工具） - - 一个真实的工具调用可以工作（`read` 探针） - - 可选的额外工具探针可以工作（`exec+read` 探针） - - OpenAI 回归路径（仅 tool-call → 后续跟进）仍然可用 -- 探针细节（这样你可以快速解释故障）： - - `read` 探针：测试会在工作区中写入一个 nonce 文件，并要求智能体 `read` 它，然后把 nonce 回显出来。 - - `exec+read` 探针：测试会要求智能体通过 `exec` 将一个 nonce 写入临时文件，然后再 `read` 读回来。 - - 图像探针：测试会附加一个生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 + - 创建 / 修补一个 `agent:dev:*` 会话（每次运行都可覆盖模型） + - 遍历带有密钥的模型，并断言： + - 存在“有意义的”回复（不使用工具） + - 真实工具调用可正常工作（`read` 探测） + - 可选的额外工具探测可正常工作（`exec+read` 探测） + - OpenAI 回归路径（仅工具调用 → 后续跟进）保持正常 +- 探测细节（这样你可以快速解释故障）： + - `read` 探测：测试会在工作区中写入一个 nonce 文件，并要求智能体 `read` 该文件，再把 nonce 原样回显回来。 + - `exec+read` 探测：测试会要求智能体通过 `exec` 将一个 nonce 写入临时文件，然后再 `read` 读回来。 + - 图像探测：测试会附加一张生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 - 实现参考：`src/gateway/gateway-models.profiles.live.test.ts` 和 `src/gateway/live-image-probe.ts`。 - 启用方式： - `pnpm test:live`（或在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） -- 选择模型的方式： - - 默认：modern allowlist（Opus/Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） +- 如何选择模型： + - 默认：modern allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是 modern allowlist 的别名 - - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号列表）以缩小范围 - - modern/all Gateway 网关扫描默认会限制在一个精心挑选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可执行完整的 modern 扫描，或设置一个正数作为更小的上限。 -- 选择提供商的方式（避免“把 OpenRouter 全部跑一遍”）： + - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号分隔列表）来缩小范围 + - modern / all Gateway 网关扫描默认使用经过挑选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可进行穷尽式 modern 扫描，或设置为正数以采用更小的上限。 +- 如何选择提供商（避免“把 OpenRouter 全部跑一遍”）： - `OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔的 allowlist） -- 在这个 live 测试中，工具 + 图像探针始终开启： - - `read` 探针 + `exec+read` 探针（工具压力测试） - - 当模型宣告支持图像输入时，会运行图像探针 - - 流程（高层说明）： - - 测试生成一个带有 “CAT” + 随机代码的小 PNG（`src/gateway/live-image-probe.ts`） +- 工具 + 图像探测在这个 live 测试中始终开启： + - `read` 探测 + `exec+read` 探测（工具压力测试） + - 当模型声明支持图像输入时，会运行图像探测 + - 流程（高层）： + - 测试生成一个带有 “CAT” + 随机代码的小型 PNG（`src/gateway/live-image-probe.ts`） - 通过 `agent` 的 `attachments: [{ mimeType: "image/png", content: "" }]` 发送 - - Gateway 网关将附件解析为 `images[]`（`src/gateway/server-methods/agent.ts` + `src/gateway/chat-attachments.ts`） - - 嵌入式智能体向模型转发一条多模态用户消息 - - 断言：回复包含 `cat` + 该代码（OCR 容错：允许轻微错误） + - Gateway 网关会将附件解析为 `images[]`（`src/gateway/server-methods/agent.ts` + `src/gateway/chat-attachments.ts`） + - 嵌入式智能体会将一条多模态用户消息转发给模型 + - 断言：回复中包含 `cat` + 该代码（OCR 容错：允许轻微错误） -提示：如果你想查看在你的机器上可以测试什么（以及精确的 `provider/model` id），运行： +提示：如果你想查看你的机器上可以测试什么（以及精确的 `provider/model` id），请运行： ```bash openclaw models list openclaw models list --json ``` -## Live：CLI 后端冒烟测试（Claude、Codex、Gemini 或其他本地 CLI） +## Live：CLI 后端冒烟测试（Claude、Codex、Gemini，或其他本地 CLI） - 测试：`src/gateway/gateway-cli-backend.live.test.ts` -- 目标：使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线，而不触碰你的默认配置。 -- 后端专属的默认冒烟设置位于对应扩展的 `cli-backend.ts` 定义中。 +- 目标：在不触碰默认配置的前提下，使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线。 +- 后端特定的冒烟测试默认值定义在所属扩展的 `cli-backend.ts` 中。 - 启用： - `pnpm test:live`（或在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） - `OPENCLAW_LIVE_CLI_BACKEND=1` - 默认值： - - 默认提供商/模型：`claude-cli/claude-sonnet-4-6` - - 命令/参数/图像行为来自对应 CLI 后端插件的元数据。 + - 默认提供商 / 模型：`claude-cli/claude-sonnet-4-6` + - 命令 / 参数 / 图像行为来自所属 CLI 后端插件元数据。 - 覆盖项（可选）： - `OPENCLAW_LIVE_CLI_BACKEND_MODEL="codex-cli/gpt-5.4"` - `OPENCLAW_LIVE_CLI_BACKEND_COMMAND="/full/path/to/codex"` - `OPENCLAW_LIVE_CLI_BACKEND_ARGS='["exec","--json","--color","never","--sandbox","read-only","--skip-git-repo-check"]'` - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1` 发送真实图像附件（路径会注入到提示中）。 - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_ARG="--image"` 通过 CLI 参数传递图像文件路径，而不是通过提示注入。 - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_MODE="repeat"`（或 `"list"`）控制在设置 `IMAGE_ARG` 时如何传递图像参数。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1` 发送真实图像附件（路径会注入到提示词中）。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_ARG="--image"` 通过 CLI 参数传递图像文件路径，而不是注入到提示词中。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_MODE="repeat"`（或 `"list"`）控制在设置 `IMAGE_ARG` 时图像参数的传递方式。 - `OPENCLAW_LIVE_CLI_BACKEND_RESUME_PROBE=1` 发送第二轮消息并验证恢复流程。 - - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 关闭默认的 Claude Sonnet -> Opus 同会话连续性探针（当所选模型支持切换目标时，设置为 `1` 可强制启用）。 + - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 禁用默认的 Claude Sonnet -> Opus 同会话连续性探测（当所选模型支持切换目标时，设为 `1` 可强制启用）。 示例： @@ -471,13 +487,13 @@ OPENCLAW_LIVE_CLI_BACKEND=1 \ pnpm test:live src/gateway/gateway-cli-backend.live.test.ts ``` -Docker 配方： +Docker 用法： ```bash pnpm test:docker:live-cli-backend ``` -单提供商 Docker 配方： +单提供商 Docker 用法： ```bash pnpm test:docker:live-cli-backend:claude @@ -489,27 +505,27 @@ pnpm test:docker:live-cli-backend:gemini 说明： - Docker 运行器位于 `scripts/test-live-cli-backend-docker.sh`。 -- 它会在仓库 Docker 镜像内以非 root 的 `node` 用户运行 live CLI 后端冒烟测试。 -- 它会从对应扩展解析 CLI 冒烟元数据，然后将匹配的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到一个可缓存、可写的前缀 `OPENCLAW_DOCKER_CLI_TOOLS_DIR` 中（默认：`~/.cache/openclaw/docker-cli-tools`）。 -- `pnpm test:docker:live-cli-backend:claude-subscription` 需要可移植的 Claude Code 订阅 OAuth，可通过 `~/.claude/.credentials.json` 中的 `claudeAiOauth.subscriptionType`，或来自 `claude setup-token` 的 `CLAUDE_CODE_OAUTH_TOKEN` 提供。它会先证明 Docker 中直接 `claude -p` 可用，然后在不保留 Anthropic API key 环境变量的情况下运行两轮 Gateway 网关 CLI 后端测试。该订阅通道默认禁用 Claude MCP/工具和图像探针，因为 Claude 目前会将第三方应用用量计入额外使用计费，而不是正常的订阅方案限额。 -- Live CLI 后端冒烟测试现在会对 Claude、Codex 和 Gemini 执行相同的端到端流程：文本轮次、图像分类轮次，然后通过 Gateway 网关 CLI 验证 MCP `cron` 工具调用。 -- Claude 的默认冒烟测试还会将会话从 Sonnet 修补为 Opus，并验证恢复后的会话仍然记得更早的一条备注。 +- 它会在仓库 Docker 镜像内以非 root 的 `node` 用户身份运行 live CLI 后端冒烟测试。 +- 它会从所属扩展解析 CLI 冒烟测试元数据，然后将匹配的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到可缓存、可写的前缀 `OPENCLAW_DOCKER_CLI_TOOLS_DIR` 中（默认：`~/.cache/openclaw/docker-cli-tools`）。 +- `pnpm test:docker:live-cli-backend:claude-subscription` 需要可移植的 Claude Code 订阅 OAuth，可通过带有 `claudeAiOauth.subscriptionType` 的 `~/.claude/.credentials.json`，或 `claude setup-token` 提供的 `CLAUDE_CODE_OAUTH_TOKEN`。它会先在 Docker 中验证直接执行 `claude -p`，然后在不保留 Anthropic API 密钥环境变量的前提下运行两轮 Gateway 网关 CLI 后端测试。这个订阅通道默认禁用 Claude MCP / 工具和图像探测，因为 Claude 当前会将第三方应用用量计入额外用量计费，而不是普通订阅计划限额。 +- live CLI 后端冒烟测试现在会对 Claude、Codex 和 Gemini 运行相同的端到端流程：文本轮次、图像分类轮次，然后通过 Gateway 网关 CLI 验证 MCP `cron` 工具调用。 +- Claude 的默认冒烟测试还会将会话从 Sonnet 切换到 Opus，并验证恢复后的会话仍记得先前的备注。 ## Live：ACP 绑定冒烟测试（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` - 目标：使用 live ACP 智能体验证真实 ACP 会话绑定流程： - 发送 `/acp spawn --bind here` - - 就地绑定一个合成的消息渠道会话 - - 在同一会话上发送普通后续消息 - - 验证该后续消息会落入已绑定的 ACP 会话转录中 + - 原地绑定一个合成的消息渠道会话 + - 在同一会话上发送一次普通后续消息 + - 验证该后续消息落入已绑定 ACP 会话的转录中 - 启用： - `pnpm test:live src/gateway/gateway-acp-bind.live.test.ts` - `OPENCLAW_LIVE_ACP_BIND=1` - 默认值： - Docker 中的 ACP 智能体：`claude,codex,gemini` - - 直接 `pnpm test:live ...` 使用的 ACP 智能体：`claude` - - 合成渠道：Slack 私信风格的会话上下文 + - 用于直接 `pnpm test:live ...` 的 ACP 智能体：`claude` + - 合成渠道：Slack 私信风格会话上下文 - ACP 后端：`acpx` - 覆盖项： - `OPENCLAW_LIVE_ACP_BIND_AGENT=claude` @@ -518,8 +534,8 @@ pnpm test:docker:live-cli-backend:gemini - `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude,codex,gemini` - `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND='npx -y @agentclientprotocol/claude-agent-acp@'` - 说明： - - 该通道使用 Gateway 网关 `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，使测试能够附加消息渠道上下文，而不必假装对外实际投递。 - - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件中为所选 ACP harness 智能体提供的内置智能体注册表。 + - 该通道使用 Gateway 网关 `chat.send` 表面，并带有仅管理员可用的合成 originating-route 字段，因此测试可以附加消息渠道上下文，而无需伪装成外部投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件的内建智能体注册表来处理所选 ACP harness 智能体。 示例： @@ -529,13 +545,13 @@ OPENCLAW_LIVE_ACP_BIND=1 \ pnpm test:live src/gateway/gateway-acp-bind.live.test.ts ``` -Docker 配方： +Docker 用法： ```bash pnpm test:docker:live-acp-bind ``` -单智能体 Docker 配方： +单智能体 Docker 用法： ```bash pnpm test:docker:live-acp-bind:claude @@ -546,30 +562,33 @@ pnpm test:docker:live-acp-bind:gemini Docker 说明： - Docker 运行器位于 `scripts/test-live-acp-bind-docker.sh`。 -- 默认情况下，它会按顺序针对所有受支持的 live CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后 `gemini`。 -- 使用 `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude`、`OPENCLAW_LIVE_ACP_BIND_AGENTS=codex` 或 `OPENCLAW_LIVE_ACP_BIND_AGENTS=gemini` 可缩小矩阵范围。 -- 它会读取 `~/.profile`，将匹配的 CLI 认证材料暂存到容器中，把 `acpx` 安装到一个可写 npm 前缀中，然后在缺失时安装所请求的 live CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 -- 在 Docker 内，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，这样 `acpx` 就能让从 profile 中读取到的提供商环境变量继续提供给子 harness CLI。 +- 默认情况下，它会按顺序对所有受支持的 live CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后 `gemini`。 +- 使用 `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude`、`OPENCLAW_LIVE_ACP_BIND_AGENTS=codex` 或 `OPENCLAW_LIVE_ACP_BIND_AGENTS=gemini` 可以缩小矩阵。 +- 它会加载 `~/.profile`，把匹配的 CLI 认证材料暂存到容器中，将 `acpx` 安装到可写 npm 前缀中，然后在缺失时安装所请求的 live CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 +- 在 Docker 内，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，这样 `acpx` 就能让来自所加载 profile 的提供商环境变量继续对其子 harness CLI 可见。 ## Live：Codex app-server harness 冒烟测试 - 目标：通过常规 Gateway 网关 - `agent` 方法验证插件自有的 Codex harness： - - 加载内置的 `codex` 插件 + `agent` 方法验证插件所属的 Codex harness： + - 加载内置 `codex` 插件 - 选择 `OPENCLAW_AGENT_RUNTIME=codex` - 向 `codex/gpt-5.4` 发送第一轮 Gateway 网关智能体消息 - - 向同一个 OpenClaw 会话发送第二轮消息，并验证 app-server 线程可以恢复 - - 通过同一条 Gateway 网关命令路径运行 `/codex status` 和 `/codex models` + - 向同一个 OpenClaw 会话发送第二轮消息，并验证 app-server + 线程可以恢复 + - 通过同一 Gateway 网关命令 + 路径运行 `/codex status` 和 `/codex models` - 测试：`src/gateway/gateway-codex-harness.live.test.ts` - 启用：`OPENCLAW_LIVE_CODEX_HARNESS=1` - 默认模型：`codex/gpt-5.4` -- 可选图像探针：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` -- 可选 MCP/工具探针：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` -- 该冒烟测试会设置 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，以避免一个损坏的 Codex harness 因静默回退到 PI 而误判为通过。 -- 认证：来自 shell/profile 的 `OPENAI_API_KEY`，以及可选复制的 +- 可选图像探测：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` +- 可选 MCP / 工具探测：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` +- 该冒烟测试会设置 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，这样损坏的 Codex + harness 就无法通过静默回退到 PI 而蒙混过关。 +- 认证：来自 shell / profile 的 `OPENAI_API_KEY`，以及可选复制的 `~/.codex/auth.json` 和 `~/.codex/config.toml` -本地配方： +本地用法： ```bash source ~/.profile @@ -580,7 +599,7 @@ OPENCLAW_LIVE_CODEX_HARNESS=1 \ pnpm test:live -- src/gateway/gateway-codex-harness.live.test.ts ``` -Docker 配方： +Docker 用法： ```bash source ~/.profile @@ -590,15 +609,21 @@ pnpm test:docker:live-codex-harness Docker 说明： - Docker 运行器位于 `scripts/test-live-codex-harness-docker.sh`。 -- 它会读取挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI 认证文件，将 `@openai/codex` 安装到一个可写的挂载 npm 前缀中，准备源码树，然后只运行 Codex harness live 测试。 -- Docker 默认启用图像和 MCP/工具探针。当你需要更窄范围的调试运行时，可设置 `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 `OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=0`。 -- Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与 live 测试配置保持一致，因此 `openai-codex/*` 或 PI 回退无法掩盖 Codex harness 回归问题。 +- 它会加载挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI + 认证文件，将 `@openai/codex` 安装到可写的挂载 npm + 前缀中，暂存源码树，然后仅运行 Codex harness live 测试。 +- Docker 默认启用图像和 MCP / 工具探测。需要更窄的调试运行时，可设置 + `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 + `OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=0`。 +- Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与 live + 测试配置保持一致，因此 `openai-codex/*` 或 PI 回退都无法掩盖 Codex harness + 回归问题。 -### 推荐的 live 配方 +### 推荐的 live 用法 -范围窄、显式的 allowlist 最快，也最不容易波动： +范围窄、显式的 allowlist 速度最快，也最不容易出现脆弱问题： -- 单模型，直接模式（无 Gateway 网关）： +- 单模型，直接测试（无 Gateway 网关）： - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` - 单模型，Gateway 网关冒烟测试： @@ -607,26 +632,26 @@ Docker 说明： - 跨多个提供商测试工具调用： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3-flash-preview,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- Google 聚焦（Gemini API key + Antigravity）： - - Gemini（API key）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` +- 聚焦 Google（Gemini API 密钥 + Antigravity）： + - Gemini（API 密钥）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` - Antigravity（OAuth）：`OPENCLAW_LIVE_GATEWAY_MODELS="google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-pro-high" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` 说明： -- `google/...` 使用 Gemini API（API key）。 -- `google-antigravity/...` 使用 Antigravity OAuth bridge（Cloud Code Assist 风格的智能体端点）。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（独立的认证 + 工具行为差异）。 +- `google/...` 使用 Gemini API（API 密钥）。 +- `google-antigravity/...` 使用 Antigravity OAuth bridge（类似 Cloud Code Assist 风格的智能体端点）。 +- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（单独的认证 + 工具行为差异）。 - Gemini API 与 Gemini CLI： - - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API key / profile 认证）；这通常是大多数用户所说的 “Gemini”。 - - CLI：OpenClaw 会调用本地 `gemini` 二进制；它有自己的认证方式，并且行为可能不同（流式传输/工具支持/版本偏差）。 + - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；这通常就是大多数用户所说的 “Gemini”。 + - CLI：OpenClaw 会 shell out 到本地 `gemini` 二进制；它有自己的认证方式，并且在流式传输 / 工具支持 / 版本偏差方面可能表现不同。 ## Live：模型矩阵（我们覆盖什么） -没有固定的“CI 模型列表”（live 是按需启用的），但下面这些是在带有密钥的开发机器上**建议**定期覆盖的模型。 +没有固定的“CI 模型列表”（live 是按需启用的），但以下是在带有密钥的开发机器上建议定期覆盖的**推荐**模型。 -### Modern 冒烟集合（工具调用 + 图像） +### 现代冒烟集（工具调用 + 图像） -这是我们预期应持续保持可用的“常见模型”运行集合： +这是我们预期需要持续保持正常工作的“常见模型”运行集： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` @@ -636,7 +661,7 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -运行带有工具 + 图像的 Gateway 网关冒烟测试： +运行带工具 + 图像的 Gateway 网关冒烟测试： `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,openai-codex/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3.1-pro-preview,google/gemini-3-flash-preview,google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-flash,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` ### 基线：工具调用（Read + 可选 Exec） @@ -649,64 +674,64 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -可选的额外覆盖（有更好，没有也行）： +可选的额外覆盖（有的话更好）： -- xAI：`xai/grok-4`（或当前可用的最新版本） +- xAI：`xai/grok-4`（或当前最新可用版本） - Mistral：`mistral/`…（选择一个你已启用、支持工具的模型） - Cerebras：`cerebras/`…（如果你有访问权限） - LM Studio：`lmstudio/`…（本地；工具调用取决于 API 模式） -### Vision：图像发送（附件 → 多模态消息） +### 视觉：发送图像（附件 → 多模态消息） -在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude/Gemini/OpenAI 的视觉变体等），以覆盖图像探针。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude / Gemini / OpenAI 的视觉变体等），以触发图像探测。 ### 聚合器 / 替代 Gateway 网关 -如果你已启用相应密钥，我们也支持通过以下方式进行测试： +如果你已启用相关密钥，我们也支持通过以下方式测试： - OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选项） -- OpenCode：`opencode/...` 用于 Zen，`opencode-go/...` 用于 Go（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） +- OpenCode：Zen 使用 `opencode/...`，Go 使用 `opencode-go/...`（认证通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY`） -如果你有凭证/配置，还可以把更多提供商纳入 live 矩阵： +如果你有凭证 / 配置，也可以将更多提供商加入 live 矩阵： - 内置：`openai`、`openai-codex`、`anthropic`、`google`、`google-vertex`、`google-antigravity`、`google-gemini-cli`、`zai`、`openrouter`、`opencode`、`opencode-go`、`xai`、`groq`、`cerebras`、`mistral`、`github-copilot` -- 通过 `models.providers`（自定义端点）：`minimax`（云/API），以及任何兼容 OpenAI/Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） +- 通过 `models.providers`（自定义端点）：`minimax`（云 / API），以及任何兼容 OpenAI / Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） -提示：不要试图在文档中硬编码“所有模型”。权威列表始终是你机器上的 `discoverModels(...)` 返回结果，再加上当前可用的密钥。 +提示：不要试图在文档中硬编码“所有模型”。权威列表应当以你机器上 `discoverModels(...)` 的返回结果 + 当前可用密钥为准。 ## 凭证（绝不要提交） -Live 测试发现凭证的方式与 CLI 相同。实际含义如下： +live 测试发现凭证的方式与 CLI 相同。实际含义是： -- 如果 CLI 可用，live 测试通常也应该找到相同的密钥。 -- 如果 live 测试提示“没有凭证”，就像调试 `openclaw models list` / 模型选择那样去排查。 +- 如果 CLI 可用，live 测试应该也能找到相同的密钥。 +- 如果某个 live 测试提示“no creds”，就用你调试 `openclaw models list` / 模型选择的同样方式来调试。 -- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试中 “profile key” 的含义） +- 按智能体划分的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试中 “profile keys” 的含义） - 配置：`~/.openclaw/openclaw.json`（或 `OPENCLAW_CONFIG_PATH`） -- 旧版状态目录：`~/.openclaw/credentials/`（如果存在，会复制到暂存的 live home 中，但它不是主 profile key 存储） -- 默认情况下，本地 live 运行会把当前活动配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到一个临时测试 home 中；暂存的 live home 会跳过 `workspace/` 和 `sandboxes/`，并去除 `agents.*.workspace` / `agentDir` 路径覆盖项，以确保探针不会触及你真实主机上的工作区。 +- 旧版状态目录：`~/.openclaw/credentials/`（存在时会复制到暂存的 live home 中，但它不是主 profile-key 存储） +- 本地 live 运行默认会将当前活动配置、按智能体划分的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到一个临时测试 home 中；暂存的 live home 会跳过 `workspace/` 和 `sandboxes/`，并会去除 `agents.*.workspace` / `agentDir` 路径覆盖，这样探测就不会落到你的真实主机工作区上。 -如果你想依赖环境变量密钥（例如在 `~/.profile` 中导出的密钥），请在本地测试前运行 `source ~/.profile`，或者使用下面的 Docker 运行器（它们可以把 `~/.profile` 挂载到容器中）。 +如果你希望依赖环境变量密钥（例如在 `~/.profile` 中导出的密钥），请在本地运行测试前执行 `source ~/.profile`，或者使用下面的 Docker 运行器（它们可以把 `~/.profile` 挂载到容器中）。 ## Deepgram live（音频转录） - 测试：`src/media-understanding/providers/deepgram/audio.live.test.ts` - 启用：`DEEPGRAM_API_KEY=... DEEPGRAM_LIVE_TEST=1 pnpm test:live src/media-understanding/providers/deepgram/audio.live.test.ts` -## BytePlus coding plan live +## BytePlus 编码计划 live - 测试：`src/agents/byteplus.live.test.ts` - 启用：`BYTEPLUS_API_KEY=... BYTEPLUS_LIVE_TEST=1 pnpm test:live src/agents/byteplus.live.test.ts` - 可选模型覆盖：`BYTEPLUS_CODING_MODEL=ark-code-latest` -## ComfyUI workflow media live +## ComfyUI 工作流媒体 live - 测试：`extensions/comfy/comfy.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts` - 范围： - 覆盖内置 comfy 图像、视频和 `music_generate` 路径 - - 如果未配置 `models.providers.comfy.`，则跳过每项能力 - - 在修改 comfy 工作流提交、轮询、下载或插件注册后很有用 + - 若未配置 `models.providers.comfy.`，则会跳过相应能力 + - 在修改 comfy 工作流提交、轮询、下载或插件注册后尤其有用 ## 图像生成 live @@ -714,10 +739,10 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义如下： - 命令：`pnpm test:live src/image-generation/runtime.live.test.ts` - Harness：`pnpm test:live:media image` - 范围： - - 枚举每个已注册的图像生成 provider 插件 + - 枚举每一个已注册的图像生成提供商插件 - 在探测前从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 - - 默认优先使用 live/env API key，而不是已存储的认证 profile，这样 `auth-profiles.json` 中陈旧的测试密钥就不会掩盖真实 shell 凭证 - - 跳过没有可用认证/profile/模型的提供商 + - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` @@ -731,7 +756,7 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义如下： - `OPENCLAW_LIVE_IMAGE_GENERATION_MODELS="openai/gpt-image-1,google/gemini-3.1-flash-image-preview"` - `OPENCLAW_LIVE_IMAGE_GENERATION_CASES="google:flash-generate,google:pro-edit"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅环境变量的覆盖项 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅来自环境变量的覆盖 ## 音乐生成 live @@ -739,23 +764,23 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义如下： - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts` - Harness：`pnpm test:live:media music` - 范围： - - 覆盖共享的内置音乐生成 provider 路径 + - 覆盖共享的内置音乐生成提供商路径 - 当前覆盖 Google 和 MiniMax - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live/env API key，而不是已存储的认证 profile，这样 `auth-profiles.json` 中陈旧的测试密钥就不会掩盖真实 shell 凭证 - - 跳过没有可用认证/profile/模型的提供商 - - 在可用时运行两个声明的运行时模式： + - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 + - 在可用时运行两种已声明的运行时模式： - `generate`：仅提示词输入 - `edit`：当提供商声明 `capabilities.edit.enabled` 时 - 当前共享通道覆盖： - `google`：`generate`、`edit` - `minimax`：`generate` - - `comfy`：使用单独的 Comfy live 文件，不在此共享扫描中 + - `comfy`：单独的 Comfy live 文件，不在这个共享扫描中 - 可选缩小范围： - `OPENCLAW_LIVE_MUSIC_GENERATION_PROVIDERS="google,minimax"` - `OPENCLAW_LIVE_MUSIC_GENERATION_MODELS="google/lyria-3-clip-preview,minimax/music-2.5+"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅环境变量的覆盖项 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅来自环境变量的覆盖 ## 视频生成 live @@ -763,42 +788,42 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义如下： - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/video-generation-providers.live.test.ts` - Harness：`pnpm test:live:media video` - 范围： - - 覆盖共享的内置视频生成 provider 路径 - - 默认走发布安全的冒烟路径：排除 FAL 提供商、每个提供商执行一次 text-to-video 请求、使用一秒龙虾提示词，并使用来自 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 的每提供商操作上限（默认 `180000`） - - 默认跳过 FAL，因为提供商端队列延迟可能主导发布时间；传入 `--video-providers fal` 或 `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="fal"` 可显式运行它 + - 覆盖共享的内置视频生成提供商路径 + - 默认使用对发布安全的冒烟路径：非 FAL 提供商、每个提供商一个文生视频请求、一秒钟的龙虾提示词，以及来自 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 的每个提供商操作上限（默认 `180000`） + - 默认跳过 FAL，因为提供商侧队列延迟可能主导发布时间；显式传入 `--video-providers fal` 或 `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="fal"` 才会运行它 - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live/env API key，而不是已存储的认证 profile，这样 `auth-profiles.json` 中陈旧的测试密钥就不会掩盖真实 shell 凭证 - - 跳过没有可用认证/profile/模型的提供商 + - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 默认只运行 `generate` - - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 后，如果可用，还会运行声明的转换模式： - - `imageToVideo`：当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商/模型在共享扫描中接受基于 buffer 的本地图像输入时 - - `videoToVideo`：当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商/模型在共享扫描中接受基于 buffer 的本地视频输入时 - - 当前在共享扫描中声明但跳过的 `imageToVideo` 提供商： - - `vydra`，因为内置的 `veo3` 仅支持文本，而内置的 `kling` 需要远程图像 URL - - Vydra 的提供商专属覆盖： + - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 后，在可用时也会运行已声明的转换模式： + - `imageToVideo`：当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时 + - `videoToVideo`：当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时 + - 当前在共享扫描中已声明但跳过的 `imageToVideo` 提供商： + - `vydra`，因为内置 `veo3` 仅支持文本，内置 `kling` 需要远程图像 URL + - 提供商特定的 Vydra 覆盖： - `OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_VYDRA_VIDEO=1 pnpm test:live -- extensions/vydra/vydra.live.test.ts` - - 该文件会运行 `veo3` text-to-video，以及一个默认使用远程图像 URL 夹具的 `kling` 通道 + - 该文件会运行 `veo3` 文生视频，以及一个默认使用远程图像 URL fixture 的 `kling` 通道 - 当前 `videoToVideo` live 覆盖： - - 仅 `runway`，并且所选模型为 `runway/gen4_aleph` 时 - - 当前在共享扫描中声明但跳过的 `videoToVideo` 提供商： - - `alibaba`、`qwen`、`xai`，因为这些路径目前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享 Gemini/Veo 通道使用的是本地基于 buffer 的输入，而该路径在共享扫描中不被接受 - - `openai`，因为当前共享通道无法保证具备组织专属的视频修补/混编访问权限 + - 仅 `runway`，且所选模型为 `runway/gen4_aleph` 时 + - 当前在共享扫描中已声明但跳过的 `videoToVideo` 提供商： + - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL + - `google`，因为当前共享 Gemini / Veo 通道使用基于本地 buffer 的输入，而该路径在共享扫描中不被接受 + - `openai`，因为当前共享通道缺乏组织特定的视频修补 / remix 访问保证 - 可选缩小范围： - `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="google,openai,runway"` - `OPENCLAW_LIVE_VIDEO_GENERATION_MODELS="google/veo-3.1-fast-generate-preview,openai/sora-2,runway/gen4_aleph"` - - `OPENCLAW_LIVE_VIDEO_GENERATION_SKIP_PROVIDERS=""` 以在默认扫描中包含所有提供商，包括 FAL - - `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS=60000` 将每个提供商的操作上限缩短，用于更激进的冒烟运行 + - `OPENCLAW_LIVE_VIDEO_GENERATION_SKIP_PROVIDERS=""` 以便在默认扫描中包含所有提供商，包括 FAL + - `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS=60000` 以在激进的冒烟测试中降低每个提供商的操作上限 - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅环境变量的覆盖项 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅来自环境变量的覆盖 -## 媒体 live Harness +## 媒体 live harness - 命令：`pnpm test:live:media` -- 目的： +- 用途： - 通过一个仓库原生入口点运行共享的图像、音乐和视频 live 测试套件 - 自动从 `~/.profile` 加载缺失的提供商环境变量 - - 默认自动将每个测试套件缩小到当前具有可用认证的提供商 + - 默认自动将每个测试套件缩小到当前拥有可用认证的提供商 - 复用 `scripts/test-live.mjs`，因此心跳和静默模式行为保持一致 - 示例： - `pnpm test:live:media` @@ -806,111 +831,129 @@ Live 测试发现凭证的方式与 CLI 相同。实际含义如下： - `pnpm test:live:media video --video-providers openai,runway --all-providers` - `pnpm test:live:media music --quiet` -## Docker 运行器（可选的“在 Linux 中可用”检查） +## Docker 运行器（可选的“在 Linux 中可运行”检查） -这些 Docker 运行器分为两类： +这些 Docker 运行器分成两类： -- Live 模型运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 只会在仓库 Docker 镜像中运行各自匹配的 profile key live 文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如果挂载了 `~/.profile`，也会读取它）。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 -- Docker live 运行器默认使用更小的冒烟上限，以确保完整 Docker 扫描仍然可行： +- live 模型运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 只会在仓库 Docker 镜像中运行各自匹配的 profile-key live 文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如果已挂载，还会加载 `~/.profile`）。对应的本地入口是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 +- Docker live 运行器默认采用更小的冒烟测试上限，以便完整的 Docker 扫描仍然可行： `test:docker:live-models` 默认设置 `OPENCLAW_LIVE_MAX_MODELS=12`，而 `test:docker:live-gateway` 默认设置 `OPENCLAW_LIVE_GATEWAY_SMOKE=1`、 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=8`、 - `OPENCLAW_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000` 和 - `OPENCLAW_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`。当你明确需要更大、更加穷尽的扫描时，可以覆盖这些环境变量。 -- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次 live Docker 镜像，然后在两个 live Docker 通道中复用该镜像。 + `OPENCLAW_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000`，以及 + `OPENCLAW_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`。当你 + 明确希望进行更大的穷尽扫描时，可覆盖这些环境变量。 +- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次 live Docker 镜像，然后将其复用于两个 live Docker 通道。 - 容器冒烟运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:gateway-network`、`test:docker:mcp-channels` 和 `test:docker:plugins` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -这些 live 模型 Docker 运行器还会只 bind-mount 必需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持项），然后在运行前把它们复制到容器 home 中，这样外部 CLI OAuth 就能刷新 token，而不会修改主机上的认证存储： +live 模型 Docker 运行器还会只绑定挂载所需的 CLI 认证主目录（如果运行未缩小范围，则挂载所有受支持的认证目录），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就可以刷新令牌，而不会改动主机上的认证存储： - 直接模型：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） - ACP 绑定冒烟测试：`pnpm test:docker:live-acp-bind`（脚本：`scripts/test-live-acp-bind-docker.sh`） - CLI 后端冒烟测试：`pnpm test:docker:live-cli-backend`（脚本：`scripts/test-live-cli-backend-docker.sh`） - Codex app-server harness 冒烟测试：`pnpm test:docker:live-codex-harness`（脚本：`scripts/test-live-codex-harness-docker.sh`） -- Gateway 网关 + dev 智能体：`pnpm test:docker:live-gateway`（脚本：`scripts/test-live-gateway-models-docker.sh`） +- Gateway 网关 + 开发智能体：`pnpm test:docker:live-gateway`（脚本：`scripts/test-live-gateway-models-docker.sh`） - Open WebUI live 冒烟测试：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） - 新手引导向导（TTY，完整脚手架）：`pnpm test:docker:onboard`（脚本：`scripts/e2e/onboard-docker.sh`） - Gateway 网关网络（两个容器，WS 认证 + 健康检查）：`pnpm test:docker:gateway-network`（脚本：`scripts/e2e/gateway-network-docker.sh`） -- MCP 渠道桥接（预置 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 冒烟测试）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） +- MCP 渠道桥接（带预置数据的 Gateway 网关 + stdio bridge + 原始 Claude 通知帧冒烟测试）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） - 插件（安装冒烟测试 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） -这些 live 模型 Docker 运行器还会将当前 checkout 以只读方式 bind-mount，并在容器内暂存到一个临时工作目录中。这样既能保持运行时镜像精简，又能让 Vitest 针对你本地的精确源码/配置运行。 -暂存步骤会跳过大型本地专用缓存和应用构建输出，例如 +live 模型 Docker 运行器还会以只读方式绑定挂载当前检出的代码，并在容器内将其暂存到一个临时工作目录中。这样可以让运行时镜像保持精简，同时仍能针对你当前本地的源代码 / 配置准确运行 Vitest。 +暂存步骤会跳过体积较大的本地专用缓存和应用构建输出，例如 `.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地的 `.build` 或 -Gradle 输出目录，因此 Docker live 运行不会花数分钟去复制机器专属工件。 -它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关 live 探针就不会在容器中启动真实的 Telegram/Discord 等渠道 worker。 -`test:docker:live-models` 仍然会运行 `pnpm test:live`，因此当你需要缩小范围或排除该 Docker 通道中的 Gateway 网关 live 覆盖时，也要传递 `OPENCLAW_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器，对接一个固定版本的 Open WebUI 容器，通过 Open WebUI 登录，验证 `/api/models` 暴露了 `openclaw/default`，然后通过 Open WebUI 的 `/api/chat/completions` 代理发送一次真实聊天请求。 -第一次运行可能会明显更慢，因为 Docker 可能需要拉取 Open WebUI 镜像，而 Open WebUI 也可能需要完成自身的冷启动设置。 -该通道需要一个可用的 live 模型 key，而 `OPENCLAW_PROFILE_FILE` -（默认是 `~/.profile`）是在 Docker 化运行中提供该 key 的主要方式。 -成功运行会打印一个小型 JSON 负载，例如 `{ "ok": true, "model": +Gradle 输出目录，这样 Docker live 运行就不会花费数分钟去复制 +机器特定的产物。 +它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关 live 探测就不会在容器内启动 +真实的 Telegram / Discord / 等渠道 worker。 +`test:docker:live-models` 仍然运行 `pnpm test:live`，因此当你需要 +缩小范围或从该 Docker 通道中排除 Gateway 网关 live 覆盖时，也请一并传入 +`OPENCLAW_LIVE_GATEWAY_*`。 +`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个 +启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器，再启动一个固定版本的 +Open WebUI 容器并将其指向该 Gateway 网关，然后通过 +Open WebUI 登录，验证 `/api/models` 暴露了 `openclaw/default`，接着通过 +Open WebUI 的 `/api/chat/completions` 代理发送一个真实聊天请求。 +首次运行可能明显更慢，因为 Docker 可能需要拉取 +Open WebUI 镜像，而且 Open WebUI 也可能需要完成其自身的冷启动 setup。 +这个通道需要可用的 live 模型密钥，而 `OPENCLAW_PROFILE_FILE` +（默认 `~/.profile`）是在 Docker 化运行中提供该密钥的主要方式。 +成功运行时会打印一个简短的 JSON 负载，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 是刻意保持确定性的，不需要真实的 Telegram、Discord 或 iMessage 账号。它会启动一个预置的 Gateway 网关容器，启动第二个容器来运行 `openclaw mcp serve`，然后通过真实的 stdio MCP bridge 验证路由会话发现、转录读取、附件元数据、live 事件队列行为、出站发送路由，以及 Claude 风格的渠道 + 权限通知。通知检查会直接检查原始 stdio MCP frame，因此该冒烟测试验证的是 bridge 实际发出的内容，而不仅仅是某个特定客户端 SDK 恰好暴露出来的内容。 +`test:docker:mcp-channels` 是故意设计为确定性的，不需要 +真实的 Telegram、Discord 或 iMessage 账号。它会启动一个带预置数据的 Gateway 网关 +容器，再启动第二个容器来运行 `openclaw mcp serve`，然后 +验证路由后的会话发现、转录读取、附件元数据、 +live 事件队列行为、出站发送路由，以及通过真实 stdio MCP bridge 传输的 Claude 风格渠道 + +权限通知。通知检查会直接检视原始 stdio MCP 帧，因此该冒烟测试验证的是 +bridge 实际发出的内容，而不只是某个特定客户端 SDK 恰好暴露出来的内容。 手动 ACP 自然语言线程冒烟测试（非 CI）： - `bun scripts/dev/discord-acp-plain-language-smoke.ts --channel ...` -- 保留这个脚本用于回归/调试工作流。将来可能还会再次需要它来验证 ACP 线程路由，所以不要删除它。 +- 为回归 / 调试工作流保留这个脚本。未来它可能还会再次用于 ACP 线程路由验证，因此不要删除它。 -常用环境变量： +有用的环境变量： - `OPENCLAW_CONFIG_DIR=...`（默认：`~/.openclaw`）挂载到 `/home/node/.openclaw` - `OPENCLAW_WORKSPACE_DIR=...`（默认：`~/.openclaw/workspace`）挂载到 `/home/node/.openclaw/workspace` -- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile`，并在运行测试前读取 -- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于 Docker 内缓存 CLI 安装 -- `$HOME` 下的外部 CLI 认证目录/文件会以只读方式挂载到 `/host-auth...` 下，然后在测试开始前复制到 `/home/node/...` +- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile`，并在运行测试前加载 +- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于缓存 Docker 内的 CLI 安装 +- `$HOME` 下的外部 CLI 认证目录 / 文件会以只读方式挂载到 `/host-auth...` 下，然后在测试启动前复制到 `/home/node/...` - 默认目录：`.minimax` - 默认文件：`~/.codex/auth.json`、`~/.codex/config.toml`、`.claude.json`、`~/.claude/.credentials.json`、`~/.claude/settings.json`、`~/.claude/settings.local.json` - - 缩小提供商范围的运行只会挂载根据 `OPENCLAW_LIVE_PROVIDERS` / `OPENCLAW_LIVE_GATEWAY_PROVIDERS` 推断出的必需目录/文件 - - 可通过 `OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none`，或逗号列表手动覆盖，例如 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex` + - 缩小范围后的提供商运行只会挂载由 `OPENCLAW_LIVE_PROVIDERS` / `OPENCLAW_LIVE_GATEWAY_PROVIDERS` 推断出的所需目录 / 文件 + - 可通过 `OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none` 或类似 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex` 的逗号列表手动覆盖 - `OPENCLAW_LIVE_GATEWAY_MODELS=...` / `OPENCLAW_LIVE_MODELS=...` 用于缩小运行范围 -- `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...` 用于在容器中过滤提供商 -- `OPENCLAW_SKIP_DOCKER_BUILD=1` 用于复用现有 `openclaw:local-live` 镜像，以便在不需要重建时进行重跑 -- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 用于确保凭证来自 profile 存储（而不是环境变量） -- `OPENCLAW_OPENWEBUI_MODEL=...` 用于选择 Gateway 网关向 Open WebUI 冒烟测试暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试使用的 nonce 检查提示词 -- `OPENWEBUI_IMAGE=...` 用于覆盖固定版本的 Open WebUI 镜像标签 +- `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...` 用于在容器内筛选提供商 +- `OPENCLAW_SKIP_DOCKER_BUILD=1` 复用已有的 `openclaw:local-live` 镜像，适用于无需重新构建的重跑 +- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 确保凭证来自 profile 存储（而不是环境变量） +- `OPENCLAW_OPENWEBUI_MODEL=...` 选择在 Open WebUI 冒烟测试中由 Gateway 网关暴露的模型 +- `OPENCLAW_OPENWEBUI_PROMPT=...` 覆盖 Open WebUI 冒烟测试中使用的 nonce 检查提示词 +- `OPENWEBUI_IMAGE=...` 覆盖固定的 Open WebUI 镜像标签 -## 文档完整性检查 +## 文档健全性检查 修改文档后运行文档检查：`pnpm check:docs`。 -当你还需要完整的 Mintlify 锚点验证（包括页内标题检查）时，运行：`pnpm docs:check-links:anchors`。 +当你还需要检查页内标题锚点时，运行完整的 Mintlify 锚点验证：`pnpm docs:check-links:anchors`。 ## 离线回归测试（CI 安全） -这些是“不依赖真实提供商”的“真实流水线”回归测试： +这些是在不依赖真实提供商的情况下，对“真实流水线”进行的回归测试： -- Gateway 网关工具调用（mock OpenAI，真实 Gateway 网关 + 智能体循环）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） -- Gateway 网关向导（WS `wizard.start`/`wizard.next`，强制写入配置 + 认证）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） +- Gateway 网关工具调用（模拟 OpenAI，真实 Gateway 网关 + 智能体循环）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） +- Gateway 网关向导（WS `wizard.start` / `wizard.next`，强制写入配置 + 认证）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） ## 智能体可靠性评估（Skills） -我们已经有一些 CI 安全的测试，其行为类似“智能体可靠性评估”： +我们已经有一些 CI 安全的测试，它们的行为类似“智能体可靠性评估”： -- 通过真实的 Gateway 网关 + 智能体循环执行 mock 工具调用（`src/gateway/gateway.test.ts`）。 +- 通过真实 Gateway 网关 + 智能体循环进行模拟工具调用（`src/gateway/gateway.test.ts`）。 - 验证会话接线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 -对于 Skills（见 [Skills](/zh-CN/tools/skills)），目前仍然缺少的内容： +对于 Skills（见 [Skills](/zh-CN/tools/skills)），目前仍然缺少的是： -- **决策能力：** 当 Skills 被列在提示中时，智能体是否会选择正确的 Skills（或避免选择无关项）？ -- **合规性：** 智能体是否会在使用前读取 `SKILL.md`，并遵循要求的步骤/参数？ -- **工作流契约：** 用多轮场景断言工具顺序、会话历史延续，以及沙箱边界。 +- **决策能力：** 当提示词中列出了 Skills 时，智能体是否会选择正确的 Skill（或避免选择不相关的 Skill）？ +- **遵从性：** 智能体在使用前是否会读取 `SKILL.md` 并遵循要求的步骤 / 参数？ +- **工作流契约：** 能断言工具顺序、会话历史延续和沙箱边界的多轮场景。 未来的评估应优先保持确定性： -- 一个使用 mock 提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取以及会话接线。 -- 一小套聚焦 skill 的场景（使用 vs 避免、门控、提示注入）。 -- 仅在 CI 安全测试套件到位之后，再添加可选的 live 评估（按需启用、由环境变量门控）。 +- 一个使用模拟提供商的场景运行器，用来断言工具调用 + 顺序、Skill 文件读取以及会话接线。 +- 一小组聚焦 Skill 的场景（使用 vs 避免、门控、提示词注入）。 +- 只有在 CI 安全的测试套件到位之后，才考虑可选的 live 评估（按需启用、由环境变量门控）。 -## 契约测试（插件和渠道形状） +## 契约测试（插件与渠道形状） -契约测试用于验证每个已注册的插件和渠道都符合其接口契约。它们会遍历所有已发现的插件，并运行一套关于结构和行为的断言。默认的 `pnpm test` unit 通道会刻意跳过这些共享接缝和冒烟测试文件；当你修改共享渠道或提供商接口时，请显式运行契约命令。 +契约测试用于验证每个已注册的插件和渠道都符合其 +接口契约。它们会遍历所有已发现的插件，并运行一组关于结构和行为的断言。默认的 `pnpm test` 单元测试通道会刻意 +跳过这些共享接缝和冒烟测试文件；当你修改共享渠道或提供商表面时，请显式运行契约命令。 ### 命令 - 所有契约：`pnpm test:contracts` - 仅渠道契约：`pnpm test:contracts:channels` -- 仅 provider 契约：`pnpm test:contracts:plugins` +- 仅提供商契约：`pnpm test:contracts:plugins` ### 渠道契约 @@ -922,47 +965,47 @@ Gradle 输出目录，因此 Docker live 运行不会花数分钟去复制机器 - **outbound-payload** - 消息负载结构 - **inbound** - 入站消息处理 - **actions** - 渠道动作处理器 -- **threading** - 线程 id 处理 -- **directory** - 目录/名册 API +- **threading** - 线程 ID 处理 +- **directory** - 目录 / roster API - **group-policy** - 群组策略执行 -### Provider 状态契约 +### 提供商状态契约 位于 `src/plugins/contracts/*.contract.test.ts`。 - **status** - 渠道状态探测 - **registry** - 插件注册表结构 -### Provider 契约 +### 提供商契约 位于 `src/plugins/contracts/*.contract.test.ts`： - **auth** - 认证流程契约 -- **auth-choice** - 认证选择 +- **auth-choice** - 认证选择 / 选择逻辑 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 -- **runtime** - provider 运行时 -- **shape** - 插件结构/接口 +- **runtime** - 提供商运行时 +- **shape** - 插件结构 / 接口 - **wizard** - 设置向导 ### 何时运行 - 修改 `plugin-sdk` 导出或子路径之后 -- 新增或修改渠道或 provider 插件之后 +- 添加或修改渠道插件或提供商插件之后 - 重构插件注册或发现逻辑之后 -契约测试会在 CI 中运行，不需要真实 API key。 +契约测试会在 CI 中运行，并且不需要真实 API 密钥。 ## 添加回归测试（指南） -当你修复了在 live 中发现的提供商/模型问题时： +当你修复一个在 live 中发现的提供商 / 模型问题时： -- 如果可能，添加一个 CI 安全的回归测试（mock/stub 提供商，或捕获精确的请求形状转换） -- 如果该问题天生只能在 live 中复现（速率限制、认证策略），就让 live 测试保持范围窄，并通过环境变量按需启用 -- 优先针对能捕获该 bug 的最小层级： - - provider 请求转换/重放 bug → 直接模型测试 - - Gateway 网关会话/历史/工具流水线 bug → Gateway 网关 live 冒烟测试或 CI 安全的 Gateway 网关 mock 测试 -- SecretRef 遍历保护规则： - - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言遍历段 exec id 会被拒绝。 - - 如果你在 `src/secrets/target-registry-data.ts` 中新增一个 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会在遇到未分类的目标 id 时故意失败，以避免新类别被静默跳过。 +- 如果可能，添加一个 CI 安全的回归测试（模拟 / stub 提供商，或捕获精确的请求结构转换） +- 如果它天然只能通过 live 复现（速率限制、认证策略），那就让 live 测试保持范围狭窄，并通过环境变量按需启用 +- 优先锁定能捕获该缺陷的最小层级： + - 提供商请求转换 / 重放缺陷 → 直接模型测试 + - Gateway 网关会话 / 历史 / 工具流水线缺陷 → Gateway 网关 live 冒烟测试或 CI 安全的 Gateway 网关模拟测试 +- SecretRef 遍历防护栏： + - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言遍历片段 exec id 会被拒绝。 + - 如果你在 `src/secrets/target-registry-data.ts` 中添加新的 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会故意在遇到未分类目标 id 时失败，这样新的类就不能被悄悄跳过。 diff --git a/docs/zh-CN/plugins/manifest.md b/docs/zh-CN/plugins/manifest.md index 4fe4ee93e..b13f5d28c 100644 --- a/docs/zh-CN/plugins/manifest.md +++ b/docs/zh-CN/plugins/manifest.md @@ -1,14 +1,14 @@ --- read_when: - 你正在构建一个 OpenClaw 插件 - - 你需要提供插件配置 schema，或调试插件校验错误 -summary: 插件清单 + JSON schema 要求（严格配置校验） + - 你需要发布一个插件配置模式，或调试插件校验错误 +summary: 插件清单 + JSON 模式要求（严格配置校验） title: 插件清单 x-i18n: - generated_at: "2026-04-12T16:25:36Z" + generated_at: "2026-04-14T20:31:10Z" model: gpt-5.4 provider: openai - source_hash: 93b57c7373e4ccd521b10945346db67991543bd2bed4cc8b6641e1f215b48579 + source_hash: ba2183bfa8802871e4ef33a0ebea290606e8351e9e83e25ee72456addb768730 source_path: plugins/manifest.md workflow: 15 --- @@ -17,7 +17,7 @@ x-i18n: 本页仅适用于**原生 OpenClaw 插件清单**。 -关于兼容的 bundle 布局，请参见 [插件 bundle](/zh-CN/plugins/bundles)。 +关于兼容的 bundle 布局，请参见 [Plugin bundles](/zh-CN/plugins/bundles)。 兼容的 bundle 格式使用不同的清单文件： @@ -25,40 +25,41 @@ x-i18n: - Claude bundle：`.claude-plugin/plugin.json`，或不带清单的默认 Claude 组件布局 - Cursor bundle：`.cursor-plugin/plugin.json` -OpenClaw 也会自动检测这些 bundle 布局，但它们不会根据此处描述的 `openclaw.plugin.json` schema 进行校验。 +OpenClaw 也会自动检测这些 bundle 布局，但不会根据此处描述的 `openclaw.plugin.json` 模式对它们进行校验。 -对于兼容 bundle，OpenClaw 当前会在布局符合 OpenClaw 运行时预期时，读取 bundle 元数据，以及已声明的 skill 根目录、Claude 命令根目录、Claude bundle `settings.json` 默认值、Claude bundle LSP 默认值和支持的 hook pack。 +对于兼容的 bundle，只要布局符合 OpenClaw 运行时预期，OpenClaw 当前会读取 bundle 元数据，以及已声明的 skill 根目录、Claude 命令根目录、Claude bundle 的 `settings.json` 默认值、Claude bundle 的 LSP 默认值，以及受支持的 hook 包。 -每个原生 OpenClaw 插件**都必须**在**插件根目录**中提供一个 `openclaw.plugin.json` 文件。OpenClaw 使用此清单在**不执行插件代码**的情况下校验配置。缺失或无效的清单会被视为插件错误，并阻止配置校验。 +每个原生 OpenClaw 插件**必须**在**插件根目录**中提供一个 `openclaw.plugin.json` 文件。OpenClaw 使用此清单在**不执行插件代码的情况下**校验配置。缺失或无效的清单会被视为插件错误，并阻止配置校验。 -请参见完整的插件系统指南：[插件](/zh-CN/tools/plugin)。 -关于原生能力模型和当前外部兼容性指引，请参见： -[能力模型](/zh-CN/plugins/architecture#public-capability-model)。 +完整的插件系统指南请参见：[Plugins](/zh-CN/tools/plugin)。 +关于原生能力模型以及当前的外部兼容性指导，请参见： +[Capability model](/zh-CN/plugins/architecture#public-capability-model)。 -## 此文件的作用 +## 这个文件的作用 `openclaw.plugin.json` 是 OpenClaw 在加载你的插件代码之前读取的元数据。 -将它用于： +用途包括： -- 插件标识 +- 插件身份标识 - 配置校验 -- 在无需启动插件运行时的情况下即可使用的认证和新手引导元数据 -- 控制平面可在运行时加载前检查的轻量激活提示 +- 无需启动插件运行时即可使用的凭证和新手引导元数据 +- 控制平面界面可在运行时加载前检查的轻量激活提示 - 设置 / 新手引导界面可在运行时加载前检查的轻量设置描述符 - 应在插件运行时加载前解析的别名和自动启用元数据 -- 应在插件运行时加载前自动激活插件的简写模型家族归属元数据 +- 应在运行时加载前自动激活插件的模型族简写归属元数据 - 用于内置兼容性接线和契约覆盖的静态能力归属快照 -- 应在不加载运行时的情况下合并到目录和校验界面中的渠道特定配置元数据 +- 共享 `openclaw qa` 主机可在插件运行时加载前检查的轻量 QA 运行器元数据 +- 应在不加载运行时的情况下合并到目录和校验界面中的渠道专用配置元数据 - 配置 UI 提示 -不要将它用于： +不要用于： - 注册运行时行为 - 声明代码入口点 - npm 安装元数据 -这些内容属于你的插件代码和 `package.json`。 +这些应放在你的插件代码和 `package.json` 中。 ## 最小示例 @@ -79,7 +80,7 @@ OpenClaw 也会自动检测这些 bundle 布局，但它们不会根据此处描 { "id": "openrouter", "name": "OpenRouter", - "description": "OpenRouter provider plugin", + "description": "OpenRouter 提供商插件", "version": "1.0.0", "providers": ["openrouter"], "modelSupport": { @@ -100,19 +101,19 @@ OpenClaw 也会自动检测这些 bundle 布局，但它们不会根据此处描 "provider": "openrouter", "method": "api-key", "choiceId": "openrouter-api-key", - "choiceLabel": "OpenRouter API key", + "choiceLabel": "OpenRouter API 密钥", "groupId": "openrouter", "groupLabel": "OpenRouter", "optionKey": "openrouterApiKey", "cliFlag": "--openrouter-api-key", "cliOption": "--openrouter-api-key ", - "cliDescription": "OpenRouter API key", + "cliDescription": "OpenRouter API 密钥", "onboardingScopes": ["text-inference"] } ], "uiHints": { "apiKey": { - "label": "API key", + "label": "API 密钥", "placeholder": "sk-or-v1-...", "sensitive": true } @@ -131,60 +132,61 @@ OpenClaw 也会自动检测这些 bundle 布局，但它们不会根据此处描 ## 顶层字段参考 -| Field | Required | Type | What it means | +| Field | Required | Type | 含义 | | ----------------------------------- | -------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `id` | Yes | `string` | 规范插件 id。这是在 `plugins.entries.` 中使用的 id。 | -| `configSchema` | Yes | `object` | 此插件配置的内联 JSON Schema。 | -| `enabledByDefault` | No | `true` | 将内置插件标记为默认启用。省略此字段，或将其设置为任何非 `true` 的值，以使插件默认保持禁用。 | -| `legacyPluginIds` | No | `string[]` | 会规范化为此规范插件 id 的旧版 id。 | -| `autoEnableWhenConfiguredProviders` | No | `string[]` | 当认证、配置或模型引用提到这些提供商 id 时，应自动启用此插件。 | -| `kind` | No | `"memory"` \| `"context-engine"` | 声明由 `plugins.slots.*` 使用的独占插件类型。 | -| `channels` | No | `string[]` | 此插件拥有的渠道 id。用于设备发现和配置校验。 | -| `providers` | No | `string[]` | 此插件拥有的提供商 id。 | -| `modelSupport` | No | `object` | 由清单拥有的简写模型家族元数据，用于在运行时之前自动加载插件。 | -| `cliBackends` | No | `string[]` | 此插件拥有的 CLI 推理后端 id。用于根据显式配置引用在启动时自动激活。 | -| `commandAliases` | No | `object[]` | 此插件拥有的命令名称，应在运行时加载前生成具备插件感知能力的配置和 CLI 诊断信息。 | -| `providerAuthEnvVars` | No | `Record` | OpenClaw 可在不加载插件代码的情况下检查的轻量提供商认证环境变量元数据。 | -| `providerAuthAliases` | No | `Record` | 应复用另一个提供商 id 进行认证查找的提供商 id，例如共享基础提供商 API key 和认证配置文件的 coding 提供商。 | -| `channelEnvVars` | No | `Record` | OpenClaw 可在不加载插件代码的情况下检查的轻量渠道环境变量元数据。将其用于由环境变量驱动的渠道设置或认证界面，以便通用的启动 / 配置辅助工具能够识别。 | -| `providerAuthChoices` | No | `object[]` | 用于新手引导选择器、首选提供商解析和简单 CLI flag 接线的轻量认证选项元数据。 | -| `activation` | No | `object` | 用于由提供商、命令、渠道、路由和能力触发加载的轻量激活提示。仅元数据；插件运行时仍拥有实际行为。 | -| `setup` | No | `object` | 设备发现和设置界面可在不加载插件运行时的情况下检查的轻量设置 / 新手引导描述符。 | -| `contracts` | No | `object` | 用于语音、实时转录、实时语音、媒体理解、图像生成、音乐生成、视频生成、web 获取、web 搜索和工具归属的静态内置能力快照。 | -| `channelConfigs` | No | `Record` | 由清单拥有的渠道配置元数据，在运行时加载前合并到设备发现和校验界面中。 | -| `skills` | No | `string[]` | 要加载的 Skills 目录，相对于插件根目录。 | -| `name` | No | `string` | 人类可读的插件名称。 | -| `description` | No | `string` | 在插件界面中显示的简短摘要。 | -| `version` | No | `string` | 信息性插件版本。 | -| `uiHints` | No | `Record` | 配置字段的 UI 标签、占位符和敏感性提示。 | +| `id` | 是 | `string` | 规范插件 id。这是在 `plugins.entries.` 中使用的 id。 | +| `configSchema` | 是 | `object` | 该插件配置的内联 JSON Schema。 | +| `enabledByDefault` | 否 | `true` | 将内置插件标记为默认启用。省略此字段，或设置为任何非 `true` 的值，都会使插件默认保持禁用。 | +| `legacyPluginIds` | 否 | `string[]` | 会规范化为此规范插件 id 的旧版 id。 | +| `autoEnableWhenConfiguredProviders` | 否 | `string[]` | 当凭证、配置或模型引用提到这些 provider id 时，应自动启用此插件。 | +| `kind` | 否 | `"memory"` \| `"context-engine"` | 声明一个供 `plugins.slots.*` 使用的排他性插件类型。 | +| `channels` | 否 | `string[]` | 由此插件拥有的渠道 id。用于设备发现和配置校验。 | +| `providers` | 否 | `string[]` | 由此插件拥有的 provider id。 | +| `modelSupport` | 否 | `object` | 由清单拥有的模型族简写元数据，用于在运行时之前自动加载插件。 | +| `cliBackends` | 否 | `string[]` | 由此插件拥有的 CLI 推理后端 id。用于基于显式配置引用的启动自动激活。 | +| `commandAliases` | 否 | `object[]` | 由此插件拥有的命令名称，应在运行时加载前生成具备插件感知能力的配置和 CLI 诊断信息。 | +| `providerAuthEnvVars` | 否 | `Record` | OpenClaw 可在不加载插件代码的情况下检查的轻量 provider 凭证环境变量元数据。 | +| `providerAuthAliases` | 否 | `Record` | 应复用另一个 provider id 进行凭证查找的 provider id，例如与基础 provider 共享 API 密钥和凭证配置文件的编码 provider。 | +| `channelEnvVars` | 否 | `Record` | OpenClaw 可在不加载插件代码的情况下检查的轻量渠道环境变量元数据。用于基于环境变量的渠道设置或凭证界面，以便通用启动 / 配置辅助逻辑能够识别。 | +| `providerAuthChoices` | 否 | `object[]` | 适用于新手引导选择器、首选 provider 解析和简单 CLI 标志接线的轻量凭证选项元数据。 | +| `activation` | 否 | `object` | 面向 provider、命令、渠道、路由和能力触发加载的轻量激活提示。仅为元数据；实际行为仍由插件运行时负责。 | +| `setup` | 否 | `object` | 设备发现和设置界面可在不加载插件运行时的情况下检查的轻量设置 / 新手引导描述符。 | +| `qaRunners` | 否 | `object[]` | 共享 `openclaw qa` 主机在插件运行时加载前使用的轻量 QA 运行器描述符。 | +| `contracts` | 否 | `object` | 针对语音、实时转录、实时语音、媒体理解、图像生成、音乐生成、视频生成、web 抓取、web 搜索和工具归属的静态内置能力快照。 | +| `channelConfigs` | 否 | `Record` | 由清单拥有的渠道配置元数据，会在运行时加载前合并到设备发现和校验界面中。 | +| `skills` | 否 | `string[]` | 要加载的 Skills 目录，相对于插件根目录。 | +| `name` | 否 | `string` | 人类可读的插件名称。 | +| `description` | 否 | `string` | 显示在插件界面中的简短摘要。 | +| `version` | 否 | `string` | 仅供参考的插件版本。 | +| `uiHints` | 否 | `Record` | 配置字段的 UI 标签、占位符和敏感性提示。 | ## `providerAuthChoices` 参考 -每个 `providerAuthChoices` 条目描述一个新手引导或认证选项。 -OpenClaw 会在提供商运行时加载前读取这些信息。 +每个 `providerAuthChoices` 条目描述一个新手引导或凭证选项。 +OpenClaw 会在 provider 运行时加载前读取这些内容。 -| Field | Required | Type | What it means | -| --------------------- | -------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `provider` | Yes | `string` | 此选项所属的提供商 id。 | -| `method` | Yes | `string` | 要分发到的认证方法 id。 | -| `choiceId` | Yes | `string` | 由新手引导和 CLI 流程使用的稳定认证选项 id。 | -| `choiceLabel` | No | `string` | 面向用户的标签。如果省略，OpenClaw 会回退到 `choiceId`。 | -| `choiceHint` | No | `string` | 选择器中显示的简短辅助文本。 | -| `assistantPriority` | No | `number` | 在由助手驱动的交互式选择器中，值越小排序越靠前。 | -| `assistantVisibility` | No | `"visible"` \| `"manual-only"` | 在助手选择器中隐藏该选项，但仍允许手动通过 CLI 选择。 | -| `deprecatedChoiceIds` | No | `string[]` | 应将用户重定向到此替代选项的旧版选项 id。 | -| `groupId` | No | `string` | 用于对相关选项进行分组的可选分组 id。 | -| `groupLabel` | No | `string` | 该分组面向用户的标签。 | -| `groupHint` | No | `string` | 该分组的简短辅助文本。 | -| `optionKey` | No | `string` | 用于简单单 flag 认证流程的内部选项键。 | -| `cliFlag` | No | `string` | CLI flag 名称，例如 `--openrouter-api-key`。 | -| `cliOption` | No | `string` | 完整的 CLI 选项形式，例如 `--openrouter-api-key `。 | -| `cliDescription` | No | `string` | 用于 CLI 帮助信息中的描述。 | -| `onboardingScopes` | No | `Array<"text-inference" \| "image-generation">` | 此选项应出现在哪些新手引导界面中。如果省略，默认值为 `["text-inference"]`。 | +| Field | Required | Type | 含义 | +| --------------------- | -------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `provider` | 是 | `string` | 此选项所属的 provider id。 | +| `method` | 是 | `string` | 要分发到的凭证方法 id。 | +| `choiceId` | 是 | `string` | 供新手引导和 CLI 流程使用的稳定凭证选项 id。 | +| `choiceLabel` | 否 | `string` | 面向用户的标签。如果省略，OpenClaw 会回退到 `choiceId`。 | +| `choiceHint` | 否 | `string` | 选择器中的简短辅助文本。 | +| `assistantPriority` | 否 | `number` | 在智能体驱动的交互式选择器中，值越小排序越靠前。 | +| `assistantVisibility` | 否 | `"visible"` \| `"manual-only"` | 在智能体选择器中隐藏此选项，但仍允许通过手动 CLI 选择。 | +| `deprecatedChoiceIds` | 否 | `string[]` | 应将用户重定向到此替代选项的旧版选项 id。 | +| `groupId` | 否 | `string` | 用于对相关选项进行分组的可选组 id。 | +| `groupLabel` | 否 | `string` | 该分组面向用户的标签。 | +| `groupHint` | 否 | `string` | 该分组的简短辅助文本。 | +| `optionKey` | 否 | `string` | 用于简单单标志凭证流程的内部选项键。 | +| `cliFlag` | 否 | `string` | CLI 标志名称，例如 `--openrouter-api-key`。 | +| `cliOption` | 否 | `string` | 完整的 CLI 选项形式，例如 `--openrouter-api-key `。 | +| `cliDescription` | 否 | `string` | CLI 帮助中使用的描述。 | +| `onboardingScopes` | 否 | `Array<"text-inference" \| "image-generation">` | 此选项应出现在哪些新手引导界面中。如果省略，默认值为 `["text-inference"]`。 | ## `commandAliases` 参考 -当插件拥有某个运行时命令名称，而用户可能会误将其放入 `plugins.allow` 或尝试将其作为根 CLI 命令运行时，请使用 `commandAliases`。OpenClaw 使用这些元数据在不导入插件运行时代码的情况下提供诊断信息。 +当插件拥有一个运行时命令名称，而用户可能错误地将其放入 `plugins.allow`，或尝试将其作为根 CLI 命令运行时，请使用 `commandAliases`。OpenClaw 使用这些元数据进行诊断，而无需导入插件运行时代码。 ```json { @@ -198,18 +200,37 @@ OpenClaw 会在提供商运行时加载前读取这些信息。 } ``` -| Field | Required | Type | What it means | -| ------------ | -------- | ----------------- | -------------------------------------------------------------- | -| `name` | Yes | `string` | 属于此插件的命令名称。 | -| `kind` | No | `"runtime-slash"` | 将该别名标记为聊天斜杠命令，而不是根 CLI 命令。 | -| `cliCommand` | No | `string` | 若存在相关根 CLI 命令，则建议用于 CLI 操作的对应根 CLI 命令。 | +| Field | Required | Type | 含义 | +| ------------ | -------- | ----------------- | ----------------------------------------------------------------------- | +| `name` | 是 | `string` | 属于此插件的命令名称。 | +| `kind` | 否 | `"runtime-slash"` | 将该别名标记为聊天斜杠命令，而不是根 CLI 命令。 | +| `cliCommand` | 否 | `string` | 如存在，用于建议 CLI 操作的相关根 CLI 命令。 | ## `activation` 参考 -当插件可以以低成本声明哪些控制平面事件应在之后激活它时，请使用 `activation`。 +当插件可以低成本地声明哪些控制平面事件应在稍后激活它时，请使用 `activation`。 -此块仅为元数据。它不会注册运行时行为，也不会替代 `register(...)`、`setupEntry` 或其他运行时 / 插件入口点。 -当前使用方会在更广泛的插件加载之前将其作为收窄提示，因此缺少激活元数据通常只会带来性能损耗；在旧版清单归属回退机制仍存在时，它不应改变正确性。 +## `qaRunners` 参考 + +当插件在共享的 `openclaw qa` 根命令下贡献一个或多个传输运行器时，请使用 `qaRunners`。保持这些元数据轻量且静态；插件运行时仍然通过轻量的 `runtime-api.ts` 接口导出的 `qaRunnerCliRegistrations` 来负责实际的 CLI 注册。 + +```json +{ + "qaRunners": [ + { + "commandName": "matrix", + "description": "针对一次性 homeserver 运行由 Docker 支持的 Matrix 实时 QA 通道" + } + ] +} +``` + +| Field | Required | Type | 含义 | +| ------------- | -------- | -------- | ------------------------------------------------------------------ | +| `commandName` | 是 | `string` | 挂载在 `openclaw qa` 下的子命令，例如 `matrix`。 | +| `description` | 否 | `string` | 当共享主机需要一个占位命令时使用的回退帮助文本。 | + +此块仅为元数据。它不会注册运行时行为，也不会替代 `register(...)`、`setupEntry` 或其他运行时 / 插件入口点。当前使用方将其作为更广泛插件加载之前的收窄提示，因此缺少激活元数据通常只会带来性能成本；在旧版清单归属回退机制仍然存在时，它不应改变正确性。 ```json { @@ -223,26 +244,27 @@ OpenClaw 会在提供商运行时加载前读取这些信息。 } ``` -| Field | Required | Type | What it means | -| ---------------- | -------- | ---------------------------------------------------- | ----------------------------------------------------- | -| `onProviders` | No | `string[]` | 请求这些提供商 id 时应激活此插件。 | -| `onCommands` | No | `string[]` | 这些命令 id 应激活此插件。 | -| `onChannels` | No | `string[]` | 这些渠道 id 应激活此插件。 | -| `onRoutes` | No | `string[]` | 这些路由类型应激活此插件。 | -| `onCapabilities` | No | `Array<"provider" \| "channel" \| "tool" \| "hook">` | 控制平面激活规划使用的广义能力提示。 | +| Field | Required | Type | 含义 | +| ---------------- | -------- | ---------------------------------------------------- | ----------------------------------------------------------------- | +| `onProviders` | 否 | `string[]` | 请求这些 provider id 时应激活此插件。 | +| `onCommands` | 否 | `string[]` | 应激活此插件的命令 id。 | +| `onChannels` | 否 | `string[]` | 应激活此插件的渠道 id。 | +| `onRoutes` | 否 | `string[]` | 应激活此插件的路由类型。 | +| `onCapabilities` | 否 | `Array<"provider" \| "channel" \| "tool" \| "hook">` | 控制平面激活规划使用的宽泛能力提示。 | -当前在线使用方： +当前的实际使用方： -- 由命令触发的 CLI 规划会回退到旧版 +- 由命令触发的 CLI 规划会回退到旧版的 `commandAliases[].cliCommand` 或 `commandAliases[].name` -- 由渠道触发的设置 / 渠道规划会在缺少显式渠道激活元数据时，回退到旧版 `channels[]` - 归属信息 -- 由提供商触发的设置 / 运行时规划会在缺少显式提供商激活元数据时，回退到旧版 - `providers[]` 和顶层 `cliBackends[]` 归属信息 +- 由渠道触发的设置 / 渠道规划在缺少显式渠道激活元数据时，会回退到旧版 `channels[]` + 归属 +- 由 provider 触发的设置 / 运行时规划在缺少显式 provider + 激活元数据时，会回退到旧版 `providers[]` 和顶层 `cliBackends[]` + 归属 ## `setup` 参考 -当设置和新手引导界面需要在运行时加载前获取由插件拥有的轻量元数据时，请使用 `setup`。 +当设置和新手引导界面需要在运行时加载前读取由插件拥有的轻量元数据时，请使用 `setup`。 ```json { @@ -261,28 +283,28 @@ OpenClaw 会在提供商运行时加载前读取这些信息。 } ``` -顶层 `cliBackends` 仍然有效，并继续描述 CLI 推理后端。`setup.cliBackends` 是面向控制平面 / 设置流程的设置专用描述符界面，应保持为纯元数据。 +顶层的 `cliBackends` 仍然有效，并继续描述 CLI 推理后端。`setup.cliBackends` 是面向控制平面 / 设置流程的、专用于设置的描述符界面，应保持为纯元数据。 -当存在 `setup.providers` 和 `setup.cliBackends` 时，它们是设置发现过程中优先使用的描述符优先查找界面。如果该描述符仅用于收窄候选插件，而设置仍需要更丰富的设置时运行时 hook，请设置 `requiresRuntime: true`，并保留 `setup-api` 作为回退执行路径。 +当存在时，`setup.providers` 和 `setup.cliBackends` 是用于设置发现的首选“描述符优先”查找界面。如果描述符只能将候选插件范围缩小，而设置流程仍需要更丰富的设置期运行时 hook，请设置 `requiresRuntime: true`，并保留 `setup-api` 作为回退执行路径。 -由于设置查找可能会执行由插件拥有的 `setup-api` 代码，因此规范化后的 `setup.providers[].id` 和 `setup.cliBackends[]` 值在所有已发现插件中必须保持唯一。归属不明确时会默认失败关闭，而不是按发现顺序选择一个赢家。 +由于设置查找可能会执行由插件拥有的 `setup-api` 代码，因此，规范化后的 `setup.providers[].id` 和 `setup.cliBackends[]` 值在所有已发现插件之间必须保持唯一。归属不明确时会以安全关闭方式失败，而不是根据发现顺序选出一个“胜者”。 ### `setup.providers` 参考 -| Field | Required | Type | What it means | -| ------------- | -------- | ---------- | ------------------------------------------------------------------------------ | -| `id` | Yes | `string` | 在设置或新手引导期间公开的提供商 id。请确保规范化 id 在全局范围内唯一。 | -| `authMethods` | No | `string[]` | 此提供商在不加载完整运行时的情况下支持的设置 / 认证方法 id。 | -| `envVars` | No | `string[]` | 通用设置 / 状态界面可在插件运行时加载前检查的环境变量。 | +| Field | Required | Type | 含义 | +| ------------- | -------- | ---------- | ------------------------------------------------------------------------------------ | +| `id` | 是 | `string` | 在设置或新手引导期间暴露的 provider id。请保持规范化 id 在全局唯一。 | +| `authMethods` | 否 | `string[]` | 此 provider 在不加载完整运行时的情况下支持的设置 / 凭证方法 id。 | +| `envVars` | 否 | `string[]` | 通用设置 / 状态界面可在插件运行时加载前检查的环境变量。 | ### `setup` 字段 -| Field | Required | Type | What it means | -| ------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------- | -| `providers` | No | `object[]` | 在设置和新手引导期间公开的提供商设置描述符。 | -| `cliBackends` | No | `string[]` | 用于描述符优先设置查找的设置时后端 id。请确保规范化 id 在全局范围内唯一。 | -| `configMigrations` | No | `string[]` | 由此插件的设置界面拥有的配置迁移 id。 | -| `requiresRuntime` | No | `boolean` | 描述符查找后，设置是否仍需要执行 `setup-api`。 | +| Field | Required | Type | 含义 | +| ------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------------- | +| `providers` | 否 | `object[]` | 在设置和新手引导期间暴露的 provider 设置描述符。 | +| `cliBackends` | 否 | `string[]` | 用于“描述符优先”设置查找的设置期后端 id。请保持规范化 id 在全局唯一。 | +| `configMigrations` | 否 | `string[]` | 由此插件设置界面拥有的配置迁移 id。 | +| `requiresRuntime` | 否 | `boolean` | 在完成描述符查找后，设置流程是否仍需要执行 `setup-api`。 | ## `uiHints` 参考 @@ -292,8 +314,8 @@ OpenClaw 会在提供商运行时加载前读取这些信息。 { "uiHints": { "apiKey": { - "label": "API key", - "help": "Used for OpenRouter requests", + "label": "API 密钥", + "help": "用于 OpenRouter 请求", "placeholder": "sk-or-v1-...", "sensitive": true } @@ -303,18 +325,18 @@ OpenClaw 会在提供商运行时加载前读取这些信息。 每个字段提示可包含： -| Field | Type | What it means | -| ------------- | ---------- | ----------------------------------- | -| `label` | `string` | 面向用户的字段标签。 | -| `help` | `string` | 简短辅助文本。 | -| `tags` | `string[]` | 可选 UI 标签。 | -| `advanced` | `boolean` | 将该字段标记为高级字段。 | -| `sensitive` | `boolean` | 将该字段标记为密钥或敏感字段。 | -| `placeholder` | `string` | 表单输入的占位文本。 | +| Field | Type | 含义 | +| ------------- | ---------- | --------------------------------------- | +| `label` | `string` | 面向用户的字段标签。 | +| `help` | `string` | 简短辅助文本。 | +| `tags` | `string[]` | 可选的 UI 标签。 | +| `advanced` | `boolean` | 将该字段标记为高级项。 | +| `sensitive` | `boolean` | 将该字段标记为密钥或敏感项。 | +| `placeholder` | `string` | 表单输入框的占位文本。 | ## `contracts` 参考 -仅在 OpenClaw 可以在不导入插件运行时的情况下读取静态能力归属元数据时使用 `contracts`。 +仅在 OpenClaw 可以在不导入插件运行时的情况下读取静态能力归属元数据时，才使用 `contracts`。 ```json { @@ -334,17 +356,17 @@ OpenClaw 会在提供商运行时加载前读取这些信息。 每个列表都是可选的： -| Field | Type | What it means | -| -------------------------------- | ---------- | ------------------------------------------------------- | -| `speechProviders` | `string[]` | 此插件拥有的语音提供商 id。 | -| `realtimeTranscriptionProviders` | `string[]` | 此插件拥有的实时转录提供商 id。 | -| `realtimeVoiceProviders` | `string[]` | 此插件拥有的实时语音提供商 id。 | -| `mediaUnderstandingProviders` | `string[]` | 此插件拥有的媒体理解提供商 id。 | -| `imageGenerationProviders` | `string[]` | 此插件拥有的图像生成提供商 id。 | -| `videoGenerationProviders` | `string[]` | 此插件拥有的视频生成提供商 id。 | -| `webFetchProviders` | `string[]` | 此插件拥有的 web 获取提供商 id。 | -| `webSearchProviders` | `string[]` | 此插件拥有的 web 搜索提供商 id。 | -| `tools` | `string[]` | 此插件拥有的智能体工具名称，用于内置契约检查。 | +| Field | Type | 含义 | +| -------------------------------- | ---------- | -------------------------------------------------------------- | +| `speechProviders` | `string[]` | 此插件拥有的语音 provider id。 | +| `realtimeTranscriptionProviders` | `string[]` | 此插件拥有的实时转录 provider id。 | +| `realtimeVoiceProviders` | `string[]` | 此插件拥有的实时语音 provider id。 | +| `mediaUnderstandingProviders` | `string[]` | 此插件拥有的媒体理解 provider id。 | +| `imageGenerationProviders` | `string[]` | 此插件拥有的图像生成 provider id。 | +| `videoGenerationProviders` | `string[]` | 此插件拥有的视频生成 provider id。 | +| `webFetchProviders` | `string[]` | 此插件拥有的 web 抓取 provider id。 | +| `webSearchProviders` | `string[]` | 此插件拥有的 web 搜索 provider id。 | +| `tools` | `string[]` | 此插件拥有的智能体工具名称，用于内置契约检查。 | ## `channelConfigs` 参考 @@ -368,26 +390,26 @@ OpenClaw 会在提供商运行时加载前读取这些信息。 } }, "label": "Matrix", - "description": "Matrix homeserver connection", + "description": "Matrix homeserver 连接", "preferOver": ["matrix-legacy"] } } } ``` -每个渠道条目可包含： +每个渠道条目可以包含： -| Field | Type | What it means | -| ------------- | ------------------------ | --------------------------------------------------------------------------------------- | -| `schema` | `object` | `channels.` 的 JSON Schema。每个已声明的渠道配置条目都必须提供此字段。 | -| `uiHints` | `Record` | 该渠道配置部分可选的 UI 标签 / 占位符 / 敏感性提示。 | -| `label` | `string` | 当运行时元数据尚未就绪时，合并到选择器和检查界面中的渠道标签。 | -| `description` | `string` | 用于检查和目录界面的简短渠道描述。 | -| `preferOver` | `string[]` | 在选择界面中，此渠道应优先于的旧版或较低优先级插件 id。 | +| Field | Type | 含义 | +| ------------- | ------------------------ | ----------------------------------------------------------------------------------------- | +| `schema` | `object` | `channels.` 的 JSON Schema。每个已声明的渠道配置条目都必须提供。 | +| `uiHints` | `Record` | 该渠道配置区块可选的 UI 标签 / 占位符 / 敏感性提示。 | +| `label` | `string` | 当运行时元数据尚未准备好时，合并到选择器和检查界面中的渠道标签。 | +| `description` | `string` | 用于检查和目录界面的简短渠道描述。 | +| `preferOver` | `string[]` | 在选择界面中，此渠道应优先于其后的旧版或较低优先级插件 id。 | ## `modelSupport` 参考 -当 OpenClaw 应在插件运行时加载前，从 `gpt-5.4` 或 `claude-sonnet-4.6` 之类的简写模型 id 推断出你的提供商插件时，请使用 `modelSupport`。 +当 OpenClaw 应在插件运行时加载前，根据简写模型 id（如 `gpt-5.4` 或 `claude-sonnet-4.6`）推断你的 provider 插件时，请使用 `modelSupport`。 ```json { @@ -398,65 +420,64 @@ OpenClaw 会在提供商运行时加载前读取这些信息。 } ``` -OpenClaw 按以下优先级应用规则： +OpenClaw 按以下优先级处理： -- 显式 `provider/model` 引用使用拥有该模型的 `providers` 清单元数据 -- `modelPatterns` 的优先级高于 `modelPrefixes` -- 如果一个非内置插件和一个内置插件都匹配，则非内置插件胜出 -- 对于剩余的歧义，在用户或配置明确指定提供商之前会被忽略 +- 显式的 `provider/model` 引用使用所属 `providers` 清单元数据 +- `modelPatterns` 优先于 `modelPrefixes` +- 如果一个非内置插件和一个内置插件都匹配，则非内置插件优先 +- 剩余的歧义会被忽略，直到用户或配置明确指定 provider 字段： -| Field | Type | What it means | -| --------------- | ---------- | --------------------------------------------------------------------- | -| `modelPrefixes` | `string[]` | 使用 `startsWith` 与简写模型 id 进行匹配的前缀。 | -| `modelPatterns` | `string[]` | 在移除配置文件后缀后，与简写模型 id 进行匹配的正则表达式源码。 | +| Field | Type | 含义 | +| --------------- | ---------- | ------------------------------------------------------------------------------- | +| `modelPrefixes` | `string[]` | 使用 `startsWith` 对简写模型 id 进行匹配的前缀。 | +| `modelPatterns` | `string[]` | 在移除 profile 后缀后，用于匹配简写模型 id 的正则表达式源码。 | 旧版顶层能力键已弃用。请使用 `openclaw doctor --fix` 将 `speechProviders`、`realtimeTranscriptionProviders`、 `realtimeVoiceProviders`、`mediaUnderstandingProviders`、 `imageGenerationProviders`、`videoGenerationProviders`、 -`webFetchProviders` 和 `webSearchProviders` 移动到 `contracts` 下；正常的清单加载不再将这些顶层字段视为能力归属信息。 +`webFetchProviders` 和 `webSearchProviders` 移动到 `contracts` 下；正常的清单加载不再将这些顶层字段视为能力归属。 ## 清单与 `package.json` 的区别 这两个文件承担不同职责： -| File | Use it for | -| ---------------------- | ---------------------------------------------------------------------------------------------------- | -| `openclaw.plugin.json` | 在插件代码运行前必须存在的设备发现、配置校验、认证选项元数据和 UI 提示 | -| `package.json` | npm 元数据、依赖安装，以及用于入口点、安装门控、设置或目录元数据的 `openclaw` 配置块 | +| File | 用途 | +| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `openclaw.plugin.json` | 设备发现、配置校验、凭证选项元数据，以及必须在插件代码运行前存在的 UI 提示 | +| `package.json` | npm 元数据、依赖安装，以及用于入口点、安装门控、设置或目录元数据的 `openclaw` 配置块 | -如果你不确定某段元数据应放在哪里，请使用以下规则： +如果你不确定某条元数据应该放在哪里，请使用以下规则： -- 如果 OpenClaw 必须在加载插件代码之前知道它，就把它放在 `openclaw.plugin.json` 中 -- 如果它与打包、入口文件或 npm 安装行为有关，就把它放在 `package.json` 中 +- 如果 OpenClaw 必须在加载插件代码之前知道它，就放在 `openclaw.plugin.json` +- 如果它与打包、入口文件或 npm 安装行为有关，就放在 `package.json` -### 影响设备发现的 `package.json` 字段 +### 会影响设备发现的 `package.json` 字段 -某些运行时前插件元数据有意放在 `package.json` 的 -`openclaw` 配置块下，而不是 `openclaw.plugin.json` 中。 +某些运行时前的插件元数据，刻意放在 `package.json` 的 `openclaw` 配置块下，而不是 `openclaw.plugin.json` 中。 重要示例： -| Field | What it means | -| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `openclaw.extensions` | 声明原生插件入口点。 | -| `openclaw.setupEntry` | 在新手引导和延迟渠道启动期间使用的轻量级仅设置入口点。 | -| `openclaw.channel` | 轻量级渠道目录元数据，例如标签、文档路径、别名和选择文案。 | -| `openclaw.channel.configuredState` | 轻量级已配置状态检查器元数据，可在不加载完整渠道运行时的情况下回答“是否已存在仅由环境变量驱动的设置？”。 | -| `openclaw.channel.persistedAuthState` | 轻量级持久化认证状态检查器元数据，可在不加载完整渠道运行时的情况下回答“是否已有任何内容处于已登录状态？”。 | -| `openclaw.install.npmSpec` / `openclaw.install.localPath` | 用于内置插件和外部发布插件的安装 / 更新提示。 | -| `openclaw.install.defaultChoice` | 当存在多个安装来源时的首选安装路径。 | -| `openclaw.install.minHostVersion` | 最低支持的 OpenClaw host 版本，使用类似 `>=2026.3.22` 的 semver 下限。 | -| `openclaw.install.allowInvalidConfigRecovery` | 当配置无效时，允许使用狭义的内置插件重新安装恢复路径。 | -| `openclaw.startup.deferConfiguredChannelFullLoadUntilAfterListen` | 允许在启动期间先加载仅设置用途的渠道界面，再加载完整的渠道插件。 | +| Field | 含义 | +| ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `openclaw.extensions` | 声明原生插件入口点。 | +| `openclaw.setupEntry` | 在新手引导和延迟渠道启动期间使用的轻量、仅设置入口点。 | +| `openclaw.channel` | 轻量渠道目录元数据，如标签、文档路径、别名和选择说明文本。 | +| `openclaw.channel.configuredState` | 轻量“已配置状态”检查器元数据，可在不加载完整渠道运行时的情况下回答“是否已存在仅基于环境变量的设置？”。 | +| `openclaw.channel.persistedAuthState` | 轻量持久化凭证检查器元数据，可在不加载完整渠道运行时的情况下回答“是否已经有任何登录状态？”。 | +| `openclaw.install.npmSpec` / `openclaw.install.localPath` | 内置和外部已发布插件的安装 / 更新提示。 | +| `openclaw.install.defaultChoice` | 当存在多个安装来源时的首选安装路径。 | +| `openclaw.install.minHostVersion` | 最低支持的 OpenClaw 主机版本，使用如 `>=2026.3.22` 的 semver 下限。 | +| `openclaw.install.allowInvalidConfigRecovery` | 当配置无效时，允许一个狭义的内置插件重装恢复路径。 | +| `openclaw.startup.deferConfiguredChannelFullLoadUntilAfterListen` | 允许仅设置用的渠道界面在启动期间先于完整渠道插件加载。 | -`openclaw.install.minHostVersion` 会在安装期间和清单注册表加载期间强制执行。无效值会被拒绝；较新的但有效的值会在较旧 host 上跳过该插件。 +`openclaw.install.minHostVersion` 会在安装和清单注册表加载期间强制执行。无效值会被拒绝；值有效但要求更高版本时，该插件会在较旧主机上被跳过。 -`openclaw.install.allowInvalidConfigRecovery` 的设计范围是刻意收窄的。它不会让任意损坏的配置变为可安装。当前它仅允许安装流程从特定的陈旧内置插件升级故障中恢复，例如缺失的内置插件路径，或该内置插件对应的陈旧 `channels.` 条目。无关的配置错误仍会阻止安装，并将操作人员引导至 `openclaw doctor --fix`。 +`openclaw.install.allowInvalidConfigRecovery` 的适用范围被刻意限制。它不会让任意损坏的配置变得可安装。当前，它只允许安装流程从特定的陈旧内置插件升级失败中恢复，例如缺失的内置插件路径，或同一个内置插件的陈旧 `channels.` 条目。无关的配置错误仍会阻止安装，并将操作人员引导至 `openclaw doctor --fix`。 -`openclaw.channel.persistedAuthState` 是一个用于微型检查器模块的包元数据： +`openclaw.channel.persistedAuthState` 是针对一个微型检查模块的包元数据： ```json { @@ -472,9 +493,9 @@ OpenClaw 按以下优先级应用规则： } ``` -当设置、Doctor 或已配置状态流程需要在完整渠道插件加载前执行轻量级的是 / 否认证探测时，请使用它。目标导出应是一个仅仅读取持久化状态的小函数；不要通过完整的渠道运行时 barrel 暴露它。 +当设置、Doctor 或已配置状态流程需要在完整渠道插件加载前进行轻量的“是 / 否”凭证探测时，请使用它。目标导出应是一个只读取持久化状态的小函数；不要通过完整渠道运行时 barrel 导出它。 -`openclaw.channel.configuredState` 使用相同的结构来进行轻量级的仅环境变量已配置检查： +`openclaw.channel.configuredState` 对基于环境变量的轻量已配置检查采用相同的结构： ```json { @@ -490,45 +511,45 @@ OpenClaw 按以下优先级应用规则： } ``` -当渠道可以仅通过环境变量或其他轻量级非运行时输入来判断已配置状态时，请使用它。如果该检查需要完整配置解析或真实的渠道运行时，请改为将该逻辑保留在插件 `config.hasConfiguredState` hook 中。 +当一个渠道可以通过环境变量或其他轻量、非运行时输入回答已配置状态时，请使用它。如果检查需要完整配置解析或真实渠道运行时，请将该逻辑保留在插件 `config.hasConfiguredState` hook 中。 ## JSON Schema 要求 - **每个插件都必须提供一个 JSON Schema**，即使它不接受任何配置。 -- 可以接受空 schema（例如 `{ "type": "object", "additionalProperties": false }`）。 -- Schema 会在读取 / 写入配置时进行校验，而不是在运行时进行校验。 +- 空 schema 也是可以接受的（例如 `{ "type": "object", "additionalProperties": false }`）。 +- Schema 会在配置读取 / 写入时校验，而不是在运行时校验。 ## 校验行为 - 未知的 `channels.*` 键会被视为**错误**，除非该渠道 id 已由某个插件清单声明。 - `plugins.entries.`、`plugins.allow`、`plugins.deny` 和 `plugins.slots.*` 必须引用**可发现的**插件 id。未知 id 会被视为**错误**。 -- 如果某个插件已安装，但其清单或 schema 缺失或损坏，则校验会失败，Doctor 会报告该插件错误。 -- 如果插件配置存在，但插件处于**禁用**状态，则配置会被保留，并且 Doctor + 日志中会显示**警告**。 +- 如果插件已安装，但其清单或 schema 缺失或损坏，校验会失败，Doctor 会报告该插件错误。 +- 如果插件配置存在，但插件处于**禁用**状态，配置会被保留，并在 Doctor + 日志中显示**警告**。 -完整的 `plugins.*` schema 请参见[配置参考](/zh-CN/gateway/configuration)。 +完整的 `plugins.*` schema 请参见 [Configuration reference](/zh-CN/gateway/configuration)。 -## 注意事项 +## 说明 -- 对于原生 OpenClaw 插件，清单是**必需的**，包括从本地文件系统加载的插件。 -- 运行时仍会单独加载插件模块；清单仅用于设备发现 + 校验。 +- 对于原生 OpenClaw 插件，清单是**必需的**，包括本地文件系统加载的插件。 +- 运行时仍会单独加载插件模块；清单仅用于设备发现和校验。 - 原生清单使用 JSON5 解析，因此支持注释、尾随逗号和未加引号的键，只要最终值仍然是一个对象即可。 -- 清单加载器只会读取已文档化的清单字段。避免在此添加自定义顶层键。 -- `providerAuthEnvVars` 是用于认证探测、环境变量标记校验以及类似提供商认证界面的轻量元数据路径，这些场景不应仅为了检查环境变量名称而启动插件运行时。 -- `providerAuthAliases` 允许提供商变体复用另一个提供商的认证环境变量、认证配置文件、基于配置的认证以及 API key 新手引导选项，而无需在 core 中硬编码这种关系。 +- 清单加载器只会读取文档中列出的清单字段。避免在这里添加自定义顶层键。 +- `providerAuthEnvVars` 是用于凭证探测、环境变量标记校验以及类似 provider 凭证界面的轻量元数据路径，这些场景不应仅为了检查环境变量名称而启动插件运行时。 +- `providerAuthAliases` 允许 provider 变体复用另一个 provider 的凭证环境变量、凭证配置文件、基于配置的凭证和 API 密钥新手引导选项，而无需在核心中硬编码这种关系。 - `channelEnvVars` 是用于 shell 环境变量回退、设置提示以及类似渠道界面的轻量元数据路径，这些场景不应仅为了检查环境变量名称而启动插件运行时。 -- `providerAuthChoices` 是用于认证选项选择器、`--auth-choice` 解析、首选提供商映射以及在提供商运行时加载前注册简单新手引导 CLI flag 的轻量元数据路径。对于需要提供商代码的运行时向导元数据，请参见 - [提供商运行时 hook](/zh-CN/plugins/architecture#provider-runtime-hooks)。 -- 独占插件类型通过 `plugins.slots.*` 进行选择。 - - `kind: "memory"` 通过 `plugins.slots.memory` 选择。 - - `kind: "context-engine"` 通过 `plugins.slots.contextEngine` +- `providerAuthChoices` 是用于凭证选项选择器、`--auth-choice` 解析、首选 provider 映射以及在 provider 运行时加载前进行简单新手引导 CLI 标志注册的轻量元数据路径。关于需要 provider 代码的运行时向导元数据，请参见 + [Provider runtime hooks](/zh-CN/plugins/architecture#provider-runtime-hooks)。 +- 排他性插件类型通过 `plugins.slots.*` 进行选择。 + - `kind: "memory"` 由 `plugins.slots.memory` 选择。 + - `kind: "context-engine"` 由 `plugins.slots.contextEngine` 选择（默认值：内置 `legacy`）。 -- 当插件不需要 `channels`、`providers`、`cliBackends` 和 `skills` 时，可以省略这些字段。 +- 当插件不需要 `channels`、`providers`、`cliBackends` 和 `skills` 时，可以省略它们。 - 如果你的插件依赖原生模块，请记录构建步骤以及任何包管理器允许列表要求（例如 pnpm `allow-build-scripts` - `pnpm rebuild `）。 ## 相关内容 -- [构建插件](/zh-CN/plugins/building-plugins) — 插件入门指南 -- [插件架构](/zh-CN/plugins/architecture) — 内部架构 -- [SDK 概览](/zh-CN/plugins/sdk-overview) — 插件 SDK 参考 +- [Building Plugins](/zh-CN/plugins/building-plugins) — 插件入门指南 +- [Plugin Architecture](/zh-CN/plugins/architecture) — 内部架构 +- [SDK Overview](/zh-CN/plugins/sdk-overview) — 插件 SDK 参考