From bf8a9a215dbdd0109a626540f740134083212edb Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Tue, 14 Apr 2026 14:04:31 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/help/testing.md | 779 +++++++++++++-------------- docs/zh-CN/tools/video-generation.md | 228 ++++---- 2 files changed, 485 insertions(+), 522 deletions(-) diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index 506fe20bb..df19ea397 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -1,96 +1,96 @@ --- read_when: - 在本地或 CI 中运行测试 - - 为模型 / 提供商缺陷添加回归测试 + - 为模型/提供商缺陷添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包：单元 / e2e / 实时测试套件、Docker 运行器，以及每项测试覆盖的内容 +summary: 测试工具包：unit/e2e/live 测试套件、Docker 运行器，以及每项测试涵盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-13T03:05:05Z" + generated_at: "2026-04-14T14:00:57Z" model: gpt-5.4 provider: openai - source_hash: 3db91b4bc36f626cd014958ec66b08b9cecd9faaa20a5746cd3a49ad4b0b1c38 + source_hash: ba64fd19580b8064078fcf885a2c7d99db70fc03de6d59c64cdcc31ab8ea4c43 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及一小组 Docker 运行器。 +OpenClaw 有三套 Vitest 测试套件（unit/integration、e2e、live）以及一小组 Docker 运行器。 本文档是一份“我们如何测试”的指南： -- 每个测试套件覆盖什么（以及它明确 _不_ 覆盖什么） +- 每个测试套件覆盖什么内容（以及它刻意**不**覆盖什么） - 常见工作流应运行哪些命令（本地、推送前、调试） -- 实时测试如何发现凭证并选择模型 / 提供商 -- 如何为真实世界中的模型 / 提供商问题添加回归测试 +- live 测试如何发现凭证并选择模型/提供商 +- 如何为真实世界中的模型/提供商问题添加回归测试 ## 快速开始 -大多数时候： +大多数情况下： - 完整门禁（推送前的预期要求）：`pnpm build && pnpm check && pnpm test` -- 在配置充裕的机器上更快地运行本地完整测试套件：`pnpm test:max` +- 在配置宽裕的机器上更快地运行本地完整测试套件：`pnpm test:max` - 直接进入 Vitest 监听循环：`pnpm test:watch` -- 现在直接指定文件路径也会路由到扩展 / 渠道路径：`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` +- 现在也支持直接按文件路径定位 extension/channel 路径：`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` - E2E 测试套件：`pnpm test:e2e` -当你在调试真实提供商 / 模型时（需要真实凭证）： +当你在调试真实提供商/模型时（需要真实凭证）： -- 实时测试套件（模型 + Gateway 网关工具 / 图像探测）：`pnpm test: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 环境变量来缩小实时测试范围。 +提示：当你只需要一个失败用例时，优先通过下面描述的 allowlist 环境变量来缩小 live 测试范围。 ## QA 专用运行器 -当你需要接近 QA-lab 真实环境的测试时，这些命令与主测试套件并列使用： +当你需要接近 QA lab 的真实环境时，这些命令与主测试套件配合使用： - `pnpm openclaw qa suite` - 直接在主机上运行基于仓库的 QA 场景。 - - 默认并行运行多个选定场景，并使用隔离的 Gateway 网关工作进程，最多 64 个工作进程或选定场景数量。使用 `--concurrency ` 调整工作进程数量，或使用 `--concurrency 1` 回到旧的串行通道。 + - 默认会使用隔离的 Gateway 网关 worker 并行运行多个选定场景，最多 64 个 worker，或以所选场景数为上限。使用 `--concurrency ` 调整 worker 数量，或使用 `--concurrency 1` 切换为旧的串行通道。 - `pnpm openclaw qa suite --runner multipass` - - 在一次性 Multipass Linux VM 中运行同一个 QA 测试套件。 - - 保持与主机上的 `qa suite` 相同的场景选择行为。 - - 复用与 `qa suite` 相同的提供商 / 模型选择标志。 - - 实时运行会转发适合来宾环境的受支持 QA 凭证输入：基于环境变量的提供商密钥、QA 实时提供商配置路径，以及存在时的 `CODEX_HOME`。 - - 输出目录必须保持在仓库根目录下，以便来宾可通过挂载的工作区回写内容。 - - 会在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告 + 摘要以及 Multipass 日志。 + - 在一次性的 Multipass Linux VM 中运行同一套 QA 测试。 + - 保持与主机上 `qa suite` 相同的场景选择行为。 + - 复用与 `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 实时 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`，因为该通道会在本地预配一次性用户。 - - 会在 `.artifacts/qa-e2e/...` 下写入 Matrix QA 报告、摘要和 observed-events 制品。 + - 针对一次性的 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/...`。 - `pnpm openclaw qa telegram` - - 使用来自环境变量的 driver 和 SUT 机器人令牌，针对真实私有群组运行 Telegram 实时 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` 以启用池化租约。 - - 要求同一私有群组中有两个不同的机器人，并且 SUT 机器人公开一个 Telegram 用户名。 - - 为了实现稳定的机器人到机器人观测，请在 `@BotFather` 中为两个机器人启用 Bot-to-Bot Communication Mode，并确保 driver 机器人可以观测群组中的机器人流量。 - - 会在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要和 observed-messages 制品。 + - 使用环境变量中的 driver 和 SUT bot token，针对真实私有群组运行 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/...`。 -实时传输协议通道共享一份标准契约，以防新传输协议发生漂移： +Live 传输通道共享一份标准契约，以防新传输方式发生漂移： -`qa-channel` 仍然是广义的合成 QA 测试套件，不属于实时传输协议覆盖矩阵的一部分。 +`qa-channel` 仍然是覆盖范围较广的合成 QA 测试套件，不属于 live 传输覆盖矩阵的一部分。 -| 通道 | Canary | 提及门控 | Allowlist 阻止 | 顶层回复 | 重启恢复 | 线程跟进 | 线程隔离 | 反应观测 | 帮助命令 | -| -------- | ------ | -------------- | --------------- | --------------- | -------------- | ---------------- | ---------------- | -------------------- | ------------ | -| 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 项目脚手架： @@ -100,11 +100,11 @@ OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及 - `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`） 可选环境变量： @@ -116,12 +116,11 @@ OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及 - `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_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 @@ -129,14 +128,14 @@ pnpm openclaw qa credentials list --kind telegram pnpm openclaw qa credentials remove --credential-id ``` -在脚本和 CI 工具中，可使用 `--json` 获取机器可读输出。 +在脚本和 CI 工具中使用 `--json` 可获得机器可读输出。 默认端点契约（`OPENCLAW_QA_CONVEX_SITE_URL` + `/qa-credentials/v1`）： - `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`） @@ -154,57 +153,57 @@ pnpm openclaw qa credentials remove --credential-id - 请求：`{ kind?, status?, includePayload?, limit? }` - 成功：`{ status: "ok", credentials, count }` -Telegram 类型的 payload 结构： +Telegram 类型的负载结构： - `{ groupId: string, driverToken: string, sutToken: string }` -- `groupId` 必须是数值型 Telegram 聊天 id 字符串。 -- `admin/add` 会对 `kind: "telegram"` 验证该结构，并拒绝格式错误的 payload。 +- `groupId` 必须是 Telegram 聊天数字 id 的字符串形式。 +- 对于 `kind: "telegram"`，`admin/add` 会验证该结构，并拒绝格式不正确的负载。 ### 向 QA 添加一个渠道 -将一个渠道添加到 Markdown QA 系统中，严格只需要两项内容： +要把一个渠道添加到 Markdown QA 系统中，**只需要**两样东西： -1. 该渠道的传输协议适配器。 -2. 一个用于验证渠道契约的场景包。 +1. 该渠道的传输适配器。 +2. 用于验证该渠道契约的场景包。 当共享的 `qa-lab` 运行器可以承载流程时，不要添加渠道专用的 QA 运行器。 `qa-lab` 负责共享机制： -- 测试套件启动和关闭 -- 工作进程并发 -- 制品写入 +- 测试套件启动与清理 +- worker 并发 +- 工件写入 - 报告生成 - 场景执行 -- 旧版 `qa-channel` 场景的兼容性别名 +- 旧版 `qa-channel` 场景的兼容别名 -渠道适配器负责传输协议契约： +渠道适配器负责传输契约： -- 如何为该传输协议配置 Gateway 网关 +- 如何为该传输方式配置 Gateway 网关 - 如何检查就绪状态 - 如何注入入站事件 -- 如何观测出站消息 -- 如何暴露转录记录和标准化后的传输协议状态 -- 如何执行基于传输协议的操作 -- 如何处理传输协议专用的重置或清理 +- 如何观察出站消息 +- 如何暴露转录记录和标准化后的传输状态 +- 如何执行由传输支持的操作 +- 如何处理传输专属的重置或清理 -新渠道的最低接入门槛是： +采用一个新渠道的最低门槛是： -1. 在共享的 `qa-lab` 接缝上实现传输协议适配器。 -2. 在传输协议注册表中注册该适配器。 -3. 将传输协议专用机制保留在适配器或渠道测试框架中。 +1. 在共享的 `qa-lab` 接缝上实现传输适配器。 +2. 在传输注册表中注册该适配器。 +3. 将传输专属机制保留在适配器或渠道 harness 内。 4. 在 `qa/scenarios/` 下编写或改造 Markdown 场景。 -5. 对新场景使用通用场景辅助工具。 -6. 除非仓库正在进行有意迁移，否则保持现有兼容性别名继续可用。 +5. 为新场景使用通用场景辅助函数。 +6. 除非仓库正在进行有意的迁移，否则保持现有兼容别名可用。 决策规则非常严格： -- 如果某个行为可以在 `qa-lab` 中统一表达一次，就放到 `qa-lab` 中。 -- 如果某个行为依赖单一渠道传输协议，就保留在该适配器或插件测试框架中。 -- 如果某个场景需要一个可被多个渠道使用的新能力，应添加一个通用辅助工具，而不是在 `suite.ts` 中加入渠道专用分支。 -- 如果某个行为仅对一种传输协议有意义，就让该场景保持传输协议专用，并在场景契约中明确说明。 +- 如果某个行为可以在 `qa-lab` 中统一表达一次，就把它放进 `qa-lab`。 +- 如果某个行为依赖于单一渠道传输，就把它保留在对应适配器或插件 harness 中。 +- 如果某个场景需要一种可供多个渠道使用的新能力，就添加一个通用辅助函数，而不是在 `suite.ts` 中添加渠道专属分支。 +- 如果某个行为只对一种传输有意义，就让该场景保持传输专用，并在场景契约中明确这一点。 -新场景推荐使用的通用辅助工具名称是： +新场景推荐使用的通用辅助函数名称： - `waitForTransportReady` - `waitForChannelReady` @@ -219,7 +218,7 @@ Telegram 类型的 payload 结构： - `formatTransportTranscript` - `resetTransport` -现有场景仍可使用兼容性别名，包括： +现有场景仍可使用兼容别名，包括： - `waitForQaChannelReady` - `waitForOutboundMessage` @@ -227,18 +226,19 @@ Telegram 类型的 payload 结构： - `formatConversationTranscript` - `resetBus` -新的渠道工作应使用这些通用辅助工具名称。 -兼容性别名的存在是为了避免一次性迁移，不应作为新场景编写的范式。 +新的渠道工作应使用这些通用辅助函数名称。 -## 测试套件（每种场景运行什么） +保留兼容别名是为了避免一次性大迁移，而不是作为新场景编写的范式。 -可以将这些测试套件理解为“真实度逐步提高”（同时也更容易波动 / 成本更高）： +## 测试套件（各自在哪里运行） -### 单元 / 集成（默认） +可以把这些测试套件理解为“真实度逐步提高”（同时波动性/成本也逐步增加）： + +### Unit / integration（默认） - 命令：`pnpm test` - 配置：对现有分域 Vitest 项目执行十个顺序分片运行（`vitest.full-*.config.ts`） -- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的核心 / 单元测试清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 +- 文件：位于 `src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core/unit 清单，以及由 `vitest.unit.config.ts` 覆盖的已列入白名单的 `ui` node 测试 - 范围： - 纯单元测试 - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） @@ -248,41 +248,40 @@ Telegram 类型的 payload 结构： - 不需要真实密钥 - 应该快速且稳定 - 项目说明： - - 现在，无定向的 `pnpm test` 会运行十一个更小的分片配置（`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`），而不是一个巨大的原生 root-project 进程。这可以降低繁忙机器上的峰值 RSS，并避免 auto-reply / extension 工作拖慢无关测试套件。 + - 无目标路径的 `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` 不需要承担完整 root project 启动的成本。 - - `pnpm test:changed` 会在 diff 仅触及可路由的源码 / 测试文件时，将变更的 git 路径扩展到相同的分域通道；而配置 / setup 修改仍会回退到更广泛的 root-project 重新运行。 - - 来自 agents、commands、plugins、auto-reply 辅助工具、`plugin-sdk` 以及类似纯工具区域的轻导入单元测试，会通过 `unit-fast` 通道运行，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件则保留在现有通道中。 - - 选定的 `plugin-sdk` 和 `commands` 辅助源码文件也会让 changed 模式运行映射到这些轻量通道中的显式同级测试，因此辅助工具改动无需为该目录重新运行完整的重型测试套件。 - - `auto-reply` 现在有三个专用桶：顶层核心辅助工具、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这让最重的 reply 测试框架工作不会影响便宜的 status / chunk / token 测试。 + - `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 测试。 - 嵌入式运行器说明： - - 当你修改消息工具发现输入或压缩运行时上下文时， - 请同时保持两个层级的覆盖。 - - 为纯路由 / 标准化边界添加聚焦的辅助工具回归测试。 - - 同时保持嵌入式运行器集成测试套件健康： + - 当你修改消息工具发现输入或压缩运行时上下文时，需要同时保持两层覆盖。 + - 为纯路由/标准化边界添加聚焦的辅助函数回归测试。 + - 同时也要保持嵌入式运行器集成测试套件健康： `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 和实时配置中使用非隔离运行器。 - - 根 UI 通道保留了它的 `jsdom` setup 和优化器，但现在也运行在共享的非隔离运行器上。 + - 共享 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`。 + - 共享的 `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` 保持相同的路由行为，只是使用更高的工作进程上限。 - - 现在本地工作进程自动扩缩容策略刻意更保守，并且当宿主机负载平均值已偏高时也会回退，因此默认情况下多个并发 Vitest 运行造成的影响更小。 - - 基础 Vitest 配置将这些项目 / 配置文件标记为 `forceRerunTriggers`，以便测试接线发生变化时，changed 模式重跑仍然正确。 - - 该配置会在受支持的宿主机上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你想为直接分析指定一个明确的缓存位置，可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 + - `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`。 - 性能调试说明： - - `pnpm test:perf:imports` 会启用 Vitest 导入耗时报告以及导入拆分输出。 - - `pnpm test:perf:imports:changed` 会将相同的分析视图限定为自 `origin/main` 以来变更的文件。 -- `pnpm test:perf:changed:bench -- --ref ` 会针对该已提交 diff，将路由后的 `test:changed` 与原生 root-project 路径进行比较，并输出墙钟时间以及 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 + 堆 profile。 + - `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。 ### E2E（Gateway 网关冒烟测试） @@ -290,91 +289,91 @@ Telegram 类型的 payload 结构： - 配置：`vitest.e2e.config.ts` - 文件：`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts` - 运行时默认值： - - 使用 Vitest `threads` 且 `isolate: false`，与仓库其余部分保持一致。 - - 使用自适应工作进程（CI：最多 2 个，本地：默认 1 个）。 + - 使用 Vitest `threads` 且 `isolate: false`，与仓库其他部分保持一致。 + - 使用自适应 worker（CI：最多 2 个，本地：默认 1 个）。 - 默认以静默模式运行，以减少控制台 I/O 开销。 -- 常用覆盖： - - `OPENCLAW_E2E_WORKERS=` 强制指定工作进程数量（上限 16）。 - - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 +- 常用覆盖项： + - `OPENCLAW_E2E_WORKERS=`：强制设置 worker 数量（上限为 16）。 + - `OPENCLAW_E2E_VERBOSE=1`：重新启用详细控制台输出。 - 范围： - 多实例 Gateway 网关端到端行为 - - WebSocket / HTTP 表面、节点配对和更重的网络行为 + - WebSocket/HTTP 接口、节点配对以及更重的网络行为 - 预期： - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 - - 比单元测试有更多活动部件（可能更慢） + - 比单元测试涉及更多活动部件（可能更慢） ### E2E：OpenShell 后端冒烟测试 - 命令：`pnpm test:e2e:openshell` - 文件：`test/openshell-sandbox.e2e.test.ts` - 范围： - - 通过 Docker 在宿主机上启动一个隔离的 OpenShell Gateway 网关 - - 从一个临时本地 Dockerfile 创建沙箱 + - 通过 Docker 在主机上启动一个隔离的 OpenShell Gateway 网关 + - 从一个临时本地 Dockerfile 创建一个沙箱 - 通过真实的 `sandbox ssh-config` + SSH 执行来验证 OpenClaw 的 OpenShell 后端 - - 通过沙箱 fs bridge 验证远端规范文件系统行为 + - 通过沙箱 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（真实提供商 + 真实模型） - 命令：`pnpm test:live` - 配置：`vitest.live.config.ts` - 文件：`src/**/*.live.test.ts` -- 默认：由 `pnpm test:live` **启用**（设置 `OPENCLAW_LIVE_TEST=1`） +- 默认：由 `pnpm test:live` **启用**（会设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商 / 模型在 _今天_ 配合真实凭证时是否真的可用？” + - “这个提供商/模型在今天配合真实凭证是否真的可用？” - 捕获提供商格式变化、工具调用怪癖、认证问题以及速率限制行为 - 预期： - - 按设计不具备 CI 稳定性（真实网络、真实提供商策略、配额、故障） - - 需要花钱 / 会消耗速率限制 - - 优先运行缩小范围后的子集，而不是“全部” -- 实时运行会 source `~/.profile`，以便补齐缺失的 API 密钥。 -- 默认情况下，实时运行仍会隔离 `HOME`，并将配置 / 认证材料复制到临时测试 home 中，以避免单元测试 fixture 修改你真实的 `~/.openclaw`。 -- 只有当你明确需要实时测试使用真实 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` 进行每次实时运行覆盖；测试在收到速率限制响应时会重试。 -- 进度 / 心跳输出： - - 实时测试套件现在会向 stderr 输出进度行，因此即使 Vitest 控制台捕获处于安静模式，长时间的提供商调用也能显示为活跃状态。 - - `vitest.live.config.ts` 禁用了 Vitest 控制台拦截，因此提供商 / Gateway 网关进度行会在实时运行期间立即流式输出。 - - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型心跳。 - - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / probe 心跳。 + - 按设计并不具备 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 网关进度行会立即流式输出。 + - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型心跳频率。 + - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关/探测心跳频率。 ## 我应该运行哪个测试套件？ 使用这个决策表： -- 修改逻辑 / 测试：运行 `pnpm test`（如果改动很多，再加上 `pnpm test:coverage`） -- 修改 Gateway 网关网络 / WS 协议 / 配对：再加上 `pnpm test:e2e` -- 调试“我的机器人挂了” / 提供商特定故障 / 工具调用：运行缩小范围后的 `pnpm test:live` +- 修改逻辑/测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） +- 涉及 Gateway 网关网络 / WS 协议 / 配对：补充运行 `pnpm test:e2e` +- 调试“我的 bot 挂了” / 提供商专属故障 / 工具调用：运行缩小范围的 `pnpm test:live` -## 实时测试：Android 节点能力扫描 +## Live：Android 节点能力扫描 - 测试：`src/gateway/android-node.capabilities.live.test.ts` - 脚本：`pnpm android:test:integration` -- 目标：调用已连接 Android 节点当前声明的**每一条命令**，并断言命令契约行为。 +- 目标：调用已连接 Android 节点当前**宣告的每一条命令**，并断言命令契约行为。 - 范围： - - 预设条件 / 手动 setup（测试套件不会安装 / 运行 / 配对应用） - - 针对所选 Android 节点逐命令验证 Gateway 网关 `node.invoke` -- 必需的预先 setup： - - Android 应用已连接并与 Gateway 网关配对。 - - 应用保持前台运行。 - - 已授予你期望通过的能力所需的权限 / 捕获同意。 -- 可选目标覆盖： + - 依赖预置/手动设置（该测试套件不会安装/运行/配对应用）。 + - 针对所选 Android 节点逐条执行 Gateway 网关 `node.invoke` 验证。 +- 必需的预先设置： + - 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 设置详情：[Android App](/zh-CN/platforms/android) -## 实时测试：模型冒烟测试（profile keys） +## Live：模型冒烟测试（profile key） -实时测试被拆分为两层，以便隔离故障： +Live 测试拆分为两层，以便我们隔离故障： -- “直接模型”告诉我们，给定密钥时提供商 / 模型本身是否能回答。 +- “直接模型”告诉我们，在给定 key 下，提供商/模型是否至少能够响应。 - “Gateway 网关冒烟测试”告诉我们，该模型的完整 Gateway 网关 + 智能体流水线是否正常工作（会话、历史、工具、沙箱策略等）。 ### 第 1 层：直接模型补全（无 Gateway 网关） @@ -382,87 +381,87 @@ Telegram 类型的 payload 结构： - 测试：`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` 运行现代 allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - - `OPENCLAW_LIVE_MODELS=all` 是现代 allowlist 的别名 + - `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="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 已损坏 / 密钥无效”和“Gateway 网关智能体流水线已损坏”分离开 - - 容纳小型、隔离的回归测试（例如：OpenAI Responses / Codex Responses 推理重放 + 工具调用流程） + - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制**仅**使用 profile 存储 +- 这一层存在的原因： + - 将“提供商 API 坏了 / key 无效”与“Gateway 网关智能体流水线坏了”区分开 + - 容纳小型、隔离的回归测试（例如：OpenAI Responses/Codex Responses 的 reasoning replay + tool-call 流程） -### 第 2 层：Gateway 网关 + 开发智能体冒烟测试（也就是 “@openclaw” 实际执行的内容） +### 第 2 层：Gateway 网关 + dev 智能体冒烟测试（也就是 “@openclaw” 实际执行的内容） - 测试：`src/gateway/gateway-models.profiles.live.test.ts` - 目标： - 启动一个进程内 Gateway 网关 - - 创建 / 修补一个 `agent:dev:*` 会话（每次运行覆盖模型） - - 遍历带密钥的模型并断言： - - “有意义”的回复（无工具） - - 真实的工具调用可用（read 探针） - - 可选的额外工具探针（exec+read 探针） - - OpenAI 回归路径（仅工具调用 → 后续跟进）持续可用 -- 探针细节（便于你快速解释失败原因）： - - `read` 探针：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 该文件，然后将 nonce 回显。 - - `exec+read` 探针：测试会要求智能体通过 `exec` 将一个 nonce 写入临时文件，然后再 `read` 回来。 - - image 探针：测试会附加一个生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 + - 创建/修补一个 `agent:dev:*` 会话（每次运行可覆盖模型） + - 遍历带有密钥的模型并断言： + - 有“有意义”的响应（无工具） + - 一个真实的工具调用可以工作（`read` 探针） + - 可选的额外工具探针可以工作（`exec+read` 探针） + - OpenAI 回归路径（仅 tool-call → 后续跟进）仍然可用 +- 探针细节（这样你可以快速解释故障）： + - `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`） -- 如何选择模型： - - 默认：现代 allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是现代 allowlist 的别名 - - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号列表）来缩小范围 - - modern / all Gateway 网关扫描默认使用一个经过筛选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可执行完整的 modern 扫描，或设置一个正数以指定更小的上限。 -- 如何选择提供商（避免“OpenRouter 全都测”）： + - `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） + - `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_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔的 allowlist） -- 工具 + image 探针在此实时测试中始终开启： +- 在这个 live 测试中，工具 + 图像探针始终开启： - `read` 探针 + `exec+read` 探针（工具压力测试） - - 当模型声明支持图像输入时，会运行 image 探针 - - 流程（高层概述）： - - 测试生成一个带有 “CAT” + 随机代码的小型 PNG（`src/gateway/live-image-probe.ts`） - - 通过 `agent` `attachments: [{ mimeType: "image/png", content: "" }]` 发送 + - 当模型宣告支持图像输入时，会运行图像探针 + - 流程（高层说明）： + - 测试生成一个带有 “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 容错：允许轻微错误） -提示：如果你想查看你的机器上可以测试哪些内容（以及精确的 `provider/model` id），请运行： +提示：如果你想查看在你的机器上可以测试什么（以及精确的 `provider/model` id），运行： ```bash openclaw models list openclaw models list --json ``` -## 实时测试：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`） + - `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_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_RESUME_PROBE=1` 发送第二轮消息并验证恢复流程。 + - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 关闭默认的 Claude Sonnet -> Opus 同会话连续性探针（当所选模型支持切换目标时，设置为 `1` 可强制启用）。 示例： @@ -490,26 +489,26 @@ pnpm test:docker:live-cli-backend:gemini 说明： - Docker 运行器位于 `scripts/test-live-cli-backend-docker.sh`。 -- 它会在仓库 Docker 镜像中以非 root 的 `node` 用户身份运行 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 key 环境变量的情况下运行两轮 Gateway 网关 CLI 后端测试。该订阅通道默认禁用 Claude MCP / 工具和图像探针，因为 Claude 当前会将第三方应用使用路由到额外用量计费，而不是普通订阅计划限额。 -- 现在，实时 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，可通过 `~/.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，并验证恢复后的会话仍然记得更早的一条备注。 -## 实时测试：ACP 绑定冒烟测试（`/acp spawn ... --bind here`） +## Live：ACP 绑定冒烟测试（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` -- 目标：通过实时 ACP 智能体验证真实 ACP 会话绑定流程： +- 目标：使用 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` + - 直接 `pnpm test:live ...` 使用的 ACP 智能体：`claude` - 合成渠道：Slack 私信风格的会话上下文 - ACP 后端：`acpx` - 覆盖项： @@ -519,8 +518,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 测试框架智能体。 + - 该通道使用 Gateway 网关 `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，使测试能够附加消息渠道上下文，而不必假装对外实际投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件中为所选 ACP harness 智能体提供的内置智能体注册表。 示例： @@ -547,30 +546,27 @@ pnpm test:docker:live-acp-bind:gemini Docker 说明： - Docker 运行器位于 `scripts/test-live-acp-bind-docker.sh`。 -- 默认情况下，它会按顺序对所有受支持的实时 CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`、`gemini`。 +- 默认情况下，它会按顺序针对所有受支持的 live CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后 `gemini`。 - 使用 `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude`、`OPENCLAW_LIVE_ACP_BIND_AGENTS=codex` 或 `OPENCLAW_LIVE_ACP_BIND_AGENTS=gemini` 可缩小矩阵范围。 -- 它会 source `~/.profile`，将匹配的 CLI 认证材料暂存到容器中，把 `acpx` 安装到可写 npm 前缀中，然后在缺失时安装所请求的实时 CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 -- 在 Docker 内，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，这样 acpx 就能让来自已 source profile 的提供商环境变量继续对其子测试框架 CLI 可用。 +- 它会读取 `~/.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。 -## 实时测试：Codex app-server 测试框架冒烟测试 +## Live：Codex app-server harness 冒烟测试 - 目标：通过常规 Gateway 网关 - `agent` 方法验证插件自有的 Codex 测试框架： - - 加载内置 `codex` 插件 + `agent` 方法验证插件自有的 Codex harness： + - 加载内置的 `codex` 插件 - 选择 `OPENCLAW_AGENT_RUNTIME=codex` - - 向 `codex/gpt-5.4` 发送第一轮 Gateway 网关智能体请求 - - 向同一个 OpenClaw 会话发送第二轮请求，并验证 app-server - 线程可以恢复 - - 通过同一个 Gateway 网关命令 - 路径运行 `/codex status` 和 `/codex models` + - 向 `codex/gpt-5.4` 发送第一轮 Gateway 网关智能体消息 + - 向同一个 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` -- 可选 image 探针：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` -- 可选 MCP / 工具探针：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` -- 该冒烟测试会设置 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，因此故障的 Codex - 测试框架不能通过静默回退到 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` 本地配方： @@ -594,27 +590,21 @@ pnpm test:docker:live-codex-harness Docker 说明： - Docker 运行器位于 `scripts/test-live-codex-harness-docker.sh`。 -- 它会 source 挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI - 认证文件，将 `@openai/codex` 安装到可写的挂载 npm - 前缀中，暂存源码树，然后仅运行 Codex-harness 实时测试。 -- Docker 默认启用 image 和 MCP / 工具探针。当你需要更窄的调试运行时，可设置 - `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 - `OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=0`。 -- Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与实时 - 测试配置保持一致，因此 `openai-codex/*` 或 PI 回退无法掩盖 Codex 测试框架 - 回归问题。 +- 它会读取挂载的 `~/.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 配方 范围窄、显式的 allowlist 最快，也最不容易波动： -- 单模型，直接测试（无 Gateway 网关）： +- 单模型，直接模式（无 Gateway 网关）： - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` - 单模型，Gateway 网关冒烟测试： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 跨多个提供商的工具调用： +- 跨多个提供商测试工具调用： - `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）： @@ -625,18 +615,18 @@ Docker 说明： - `google/...` 使用 Gemini API（API key）。 - `google-antigravity/...` 使用 Antigravity OAuth bridge（Cloud Code Assist 风格的智能体端点）。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（单独的认证 + 工具行为差异）。 +- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（独立的认证 + 工具行为差异）。 - Gemini API 与 Gemini CLI： - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API key / profile 认证）；这通常是大多数用户所说的 “Gemini”。 - - CLI：OpenClaw 会 shell out 到本地 `gemini` 二进制；它有自己的认证方式，行为也可能不同（流式传输 / 工具支持 / 版本偏差）。 + - CLI：OpenClaw 会调用本地 `gemini` 二进制；它有自己的认证方式，并且行为可能不同（流式传输/工具支持/版本偏差）。 -## 实时测试：模型矩阵（我们覆盖什么） +## Live：模型矩阵（我们覆盖什么） -这里没有固定的“CI 模型列表”（实时测试是按需启用的），但以下是在开发机器上有密钥时，**建议**定期覆盖的模型。 +没有固定的“CI 模型列表”（live 是按需启用的），但下面这些是在带有密钥的开发机器上**建议**定期覆盖的模型。 -### 现代冒烟测试集（工具调用 + 图像） +### Modern 冒烟集合（工具调用 + 图像） -这是我们期望持续保持可用的“常用模型”运行集： +这是我们预期应持续保持可用的“常见模型”运行集合： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` @@ -646,12 +636,12 @@ 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） -每个提供商系列至少选一个： +每个提供商家族至少选一个： - OpenAI：`openai/gpt-5.4`（或 `openai/gpt-5.4-mini`） - Anthropic：`anthropic/claude-opus-4-6`（或 `anthropic/claude-sonnet-4-6`） @@ -661,73 +651,73 @@ Docker 说明： 可选的额外覆盖（有更好，没有也行）： -- xAI：`xai/grok-4`（或最新可用版本） -- Mistral：`mistral/`…（选择一个你已启用、支持 “tools” 的模型） +- 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：Zen 使用 `opencode/...`，Go 使用 `opencode-go/...`（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） +- OpenCode：`opencode/...` 用于 Zen，`opencode-go/...` 用于 Go（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） -如果你有凭证 / 配置，还可以将更多提供商纳入实时矩阵： +如果你有凭证/配置，还可以把更多提供商纳入 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(...)` 返回结果，再加上当前可用的密钥。 -## 凭证（切勿提交） +## 凭证（绝不要提交） -实时测试发现凭证的方式与 CLI 相同。实际影响如下： +Live 测试发现凭证的方式与 CLI 相同。实际含义如下： -- 如果 CLI 可用，实时测试应能找到相同的密钥。 -- 如果实时测试提示 “no creds”，请用你调试 `openclaw models list` / 模型选择时的同样方法来排查。 +- 如果 CLI 可用，live 测试通常也应该找到相同的密钥。 +- 如果 live 测试提示“没有凭证”，就像调试 `openclaw models list` / 模型选择那样去排查。 -- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是实时测试中 “profile keys” 的含义） +- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试中 “profile key” 的含义） - 配置：`~/.openclaw/openclaw.json`（或 `OPENCLAW_CONFIG_PATH`） -- 旧版状态目录：`~/.openclaw/credentials/`（存在时会复制到暂存的实时测试 home 中，但它不是主要的 profile-key 存储） -- 默认情况下，本地实时运行会将当前激活的配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到一个临时测试 home 中；暂存的实时 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 实时测试（音频转录） +## 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 编码计划实时测试 +## BytePlus coding plan 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 工作流媒体实时测试 +## ComfyUI workflow media 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 图像、视频和 `music_generate` 路径 + - 如果未配置 `models.providers.comfy.`，则跳过每项能力 - 在修改 comfy 工作流提交、轮询、下载或插件注册后很有用 -## 图像生成实时测试 +## 图像生成 live - 测试：`src/image-generation/runtime.live.test.ts` - 命令：`pnpm test:live src/image-generation/runtime.live.test.ts` -- 测试框架：`pnpm test:live:media image` +- Harness：`pnpm test:live:media image` - 范围： - - 枚举每个已注册的图像生成提供商插件 + - 枚举每个已注册的图像生成 provider 插件 - 在探测前从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 - - 默认优先使用 live / env API key，而不是存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 + - 默认优先使用 live/env API key，而不是已存储的认证 profile，这样 `auth-profiles.json` 中陈旧的测试密钥就不会掩盖真实 shell 凭证 + - 跳过没有可用认证/profile/模型的提供商 - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` @@ -741,71 +731,75 @@ Docker 说明： - `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 - 测试：`extensions/music-generation-providers.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts` -- 测试框架：`pnpm test:live:media music` +- Harness：`pnpm test:live:media music` - 范围： - - 验证共享的内置音乐生成提供商路径 + - 覆盖共享的内置音乐生成 provider 路径 - 当前覆盖 Google 和 MiniMax - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live / env API key，而不是存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 + - 默认优先使用 live/env API key，而不是已存储的认证 profile，这样 `auth-profiles.json` 中陈旧的测试密钥就不会掩盖真实 shell 凭证 + - 跳过没有可用认证/profile/模型的提供商 - 在可用时运行两个声明的运行时模式： - `generate`：仅提示词输入 - `edit`：当提供商声明 `capabilities.edit.enabled` 时 - 当前共享通道覆盖： - `google`：`generate`、`edit` - `minimax`：`generate` - - `comfy`：单独的 Comfy 实时测试文件，不在这个共享扫描中 + - `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 - 测试：`extensions/video-generation-providers.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/video-generation-providers.live.test.ts` -- 测试框架：`pnpm test:live:media video` +- 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"` 可显式运行它 - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live / env API key，而不是存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 - - 在可用时运行两个声明的运行时模式： - - `generate`：仅提示词输入 - - `imageToVideo`：当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时 - - `videoToVideo`：当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时 - - 当前在共享扫描中已声明但被跳过的 `imageToVideo` 提供商： - - `vydra`，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL - - 提供商特定的 Vydra 覆盖： + - 默认优先使用 live/env API key，而不是已存储的认证 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_TEST=1 OPENCLAW_LIVE_VYDRA_VIDEO=1 pnpm test:live -- extensions/vydra/vydra.live.test.ts` - - 该文件会运行 `veo3` 文本转视频，以及默认使用远程图像 URL fixture 的 `kling` 通道 - - 当前 `videoToVideo` 实时覆盖： - - 仅 `runway`，且所选模型为 `runway/gen4_aleph` - - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商： - - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享的 Gemini / Veo 通道使用基于本地 buffer 的输入，而该路径在共享扫描中不被接受 - - `openai`，因为当前共享通道缺少组织特定的视频修补 / remix 访问保证 + - 该文件会运行 `veo3` text-to-video，以及一个默认使用远程图像 URL 夹具的 `kling` 通道 + - 当前 `videoToVideo` live 覆盖： + - 仅 `runway`，并且所选模型为 `runway/gen4_aleph` 时 + - 当前在共享扫描中声明但跳过的 `videoToVideo` 提供商： + - `alibaba`、`qwen`、`xai`，因为这些路径目前需要远程 `http(s)` / MP4 参考 URL + - `google`，因为当前共享 Gemini/Veo 通道使用的是本地基于 buffer 的输入，而该路径在共享扫描中不被接受 + - `openai`，因为当前共享通道无法保证具备组织专属的视频修补/混编访问权限 - 可选缩小范围： - `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_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅来自环境变量的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅环境变量的覆盖项 -## 媒体实时测试框架 +## 媒体 live Harness - 命令：`pnpm test:live:media` - 目的： - - 通过一个仓库原生入口运行共享的图像、音乐和视频实时测试套件 + - 通过一个仓库原生入口点运行共享的图像、音乐和视频 live 测试套件 - 自动从 `~/.profile` 加载缺失的提供商环境变量 - 默认自动将每个测试套件缩小到当前具有可用认证的提供商 - - 复用 `scripts/test-live.mjs`，因此心跳和安静模式行为保持一致 + - 复用 `scripts/test-live.mjs`，因此心跳和静默模式行为保持一致 - 示例： - `pnpm test:live:media` - `pnpm test:live:media image video --providers openai,google,minimax` @@ -816,162 +810,159 @@ Docker 说明： 这些 Docker 运行器分为两类： -- 实时模型运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 仅在仓库 Docker 镜像内运行各自匹配的 profile-key 实时测试文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如果已挂载，也会 source `~/.profile`）。对应的本地入口分别是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 -- 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 扫描仍然可行： `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` 构建一次实时 Docker 镜像，然后在两个实时 Docker 通道中复用它。 -- 容器冒烟测试运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:gateway-network`、`test:docker:mcp-channels` 和 `test:docker:plugins` 会启动一个或多个真实容器，并验证更高层级的集成路径。 + `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` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -实时模型 Docker 运行器还会只对所需的 CLI 认证 home 目录执行 bind-mount（若运行未缩小范围，则挂载所有受支持的目录），然后在运行前将其复制到容器 home 中，以便外部 CLI OAuth 可以刷新令牌，而不修改宿主机认证存储： +这些 live 模型 Docker 运行器还会只 bind-mount 必需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持项），然后在运行前把它们复制到容器 home 中，这样外部 CLI OAuth 就能刷新 token，而不会修改主机上的认证存储： - 直接模型：`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 测试框架冒烟测试：`pnpm test:docker:live-codex-harness`（脚本：`scripts/test-live-codex-harness-docker.sh`） -- Gateway 网关 + 开发智能体：`pnpm test:docker:live-gateway`（脚本：`scripts/test-live-gateway-models-docker.sh`） -- Open WebUI 实时冒烟测试：`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 通知帧冒烟测试）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） -- 插件（安装冒烟测试 + `/plugin` 别名 + Claude 内置包重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-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`） +- 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`） +- 插件（安装冒烟测试 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） -实时模型 Docker 运行器还会以只读方式 bind-mount 当前检出内容，并将其暂存到容器内的临时工作目录中。这样既能保持运行时镜像精简，又能确保 Vitest 针对你当前本地精确的源码 / 配置运行。 +这些 live 模型 Docker 运行器还会将当前 checkout 以只读方式 bind-mount，并在容器内暂存到一个临时工作目录中。这样既能保持运行时镜像精简，又能让 Vitest 针对你本地的精确源码/配置运行。 暂存步骤会跳过大型本地专用缓存和应用构建输出，例如 `.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地的 `.build` 或 -Gradle 输出目录，因此 Docker 实时运行不会浪费数分钟去复制机器专属制品。 -它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，因此 Gateway 网关实时探针不会在容器中启动真实的 Telegram / Discord / 等渠道工作进程。 -`test:docker:live-models` 仍会运行 `pnpm test:live`，因此当你需要缩小范围或从该 Docker 通道中排除 Gateway 网关实时覆盖时，也要一并传入 -`OPENCLAW_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器，针对该 Gateway 网关启动一个固定版本的 Open WebUI 容器，通过 Open WebUI 登录，验证 `/api/models` 暴露 `openclaw/default`，然后通过 Open WebUI 的 `/api/chat/completions` 代理发送一条真实聊天请求。 -首次运行可能明显更慢，因为 Docker 可能需要拉取 Open WebUI 镜像，而 Open WebUI 也可能需要完成自身的冷启动 setup。 -该通道需要一个可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认为 `~/.profile`）是在 Docker 化运行中提供它的主要方式。 -成功运行会输出一个简短的 JSON payload，例如 `{ "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 容器，通过 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": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 刻意设计为确定性测试，不需要真实的 -Telegram、Discord 或 iMessage 账号。它会启动一个带预置数据的 Gateway 网关 -容器，再启动第二个容器来执行 `openclaw mcp serve`，然后通过真实的 stdio MCP bridge 验证路由后的会话发现、转录读取、附件元数据、实时事件队列行为、出站发送路由，以及 Claude 风格的渠道 + 权限通知。通知检查会直接检查原始 stdio MCP 帧，因此该冒烟测试验证的是 bridge 实际发出的内容，而不仅仅是某个特定客户端 SDK 恰好暴露出来的内容。 +`test:docker:mcp-channels` 是刻意保持确定性的，不需要真实的 Telegram、Discord 或 iMessage 账号。它会启动一个预置的 Gateway 网关容器，启动第二个容器来运行 `openclaw mcp serve`，然后通过真实的 stdio MCP bridge 验证路由会话发现、转录读取、附件元数据、live 事件队列行为、出站发送路由，以及 Claude 风格的渠道 + 权限通知。通知检查会直接检查原始 stdio MCP frame，因此该冒烟测试验证的是 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`，并在运行测试前 source +- `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/...` +- `$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=...` 用于选择 Gateway 网关向 Open WebUI 冒烟测试暴露的模型 +- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试使用的 nonce 检查提示词 +- `OPENWEBUI_IMAGE=...` 用于覆盖固定版本的 Open WebUI 镜像标签 ## 文档完整性检查 -编辑文档后运行文档检查：`pnpm check:docs`。 -当你还需要检查页内标题锚点时，运行完整的 Mintlify 锚点校验：`pnpm docs:check-links:anchors`。 +修改文档后运行文档检查：`pnpm check:docs`。 +当你还需要完整的 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 网关工具调用（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”） ## 智能体可靠性评估（Skills） -我们已经有一些 CI 安全的测试，其行为类似于“智能体可靠性评估”： +我们已经有一些 CI 安全的测试，其行为类似“智能体可靠性评估”： -- 通过真实 Gateway 网关 + 智能体循环进行 mock 工具调用（`src/gateway/gateway.test.ts`）。 +- 通过真实的 Gateway 网关 + 智能体循环执行 mock 工具调用（`src/gateway/gateway.test.ts`）。 - 验证会话接线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 -针对 Skills 仍然缺少的部分（见 [Skills](/zh-CN/tools/skills)）： +对于 Skills（见 [Skills](/zh-CN/tools/skills)），目前仍然缺少的内容： -- **决策能力：** 当 Skills 列在提示中时，智能体是否会选择正确的 skill（或避免选择无关的 skill）？ -- **合规性：** 智能体在使用前是否会读取 `SKILL.md`，并遵循要求的步骤 / 参数？ -- **工作流契约：** 断言工具顺序、会话历史延续和沙箱边界的多轮场景。 +- **决策能力：** 当 Skills 被列在提示中时，智能体是否会选择正确的 Skills（或避免选择无关项）？ +- **合规性：** 智能体是否会在使用前读取 `SKILL.md`，并遵循要求的步骤/参数？ +- **工作流契约：** 用多轮场景断言工具顺序、会话历史延续，以及沙箱边界。 -未来的评估应首先保持确定性： +未来的评估应优先保持确定性： -- 一个使用 mock 提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话接线。 -- 一小组聚焦于 skill 的场景（使用 vs 避免、门控、提示注入）。 -- 只有在 CI 安全测试套件到位之后，才考虑加入可选的实时评估（按需启用、由环境变量门控）。 +- 一个使用 mock 提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取以及会话接线。 +- 一小套聚焦 skill 的场景（使用 vs 避免、门控、提示注入）。 +- 仅在 CI 安全测试套件到位之后，再添加可选的 live 评估（按需启用、由环境变量门控）。 ## 契约测试（插件和渠道形状） -契约测试用于验证每个已注册插件和渠道都符合其接口契约。它们会遍历所有已发现的插件，并运行一组形状和行为断言。默认的 `pnpm test` 单元测试通道会刻意跳过这些共享接缝和冒烟测试文件；当你修改共享渠道或提供商表面时，请显式运行契约测试命令。 +契约测试用于验证每个已注册的插件和渠道都符合其接口契约。它们会遍历所有已发现的插件，并运行一套关于结构和行为的断言。默认的 `pnpm test` unit 通道会刻意跳过这些共享接缝和冒烟测试文件；当你修改共享渠道或提供商接口时，请显式运行契约命令。 ### 命令 -- 所有契约测试：`pnpm test:contracts` +- 所有契约：`pnpm test:contracts` - 仅渠道契约：`pnpm test:contracts:channels` -- 仅提供商契约：`pnpm test:contracts:plugins` +- 仅 provider 契约：`pnpm test:contracts:plugins` ### 渠道契约 位于 `src/channels/plugins/contracts/*.contract.test.ts`： -- **plugin** - 基本插件形状（id、name、capabilities） +- **plugin** - 基本插件结构（id、name、capabilities） - **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 -- **outbound-payload** - 消息 payload 结构 +- **outbound-payload** - 消息负载结构 - **inbound** - 入站消息处理 -- **actions** - 渠道操作处理器 -- **threading** - 线程 ID 处理 -- **directory** - 目录 / roster API +- **actions** - 渠道动作处理器 +- **threading** - 线程 id 处理 +- **directory** - 目录/名册 API - **group-policy** - 群组策略执行 -### 提供商状态契约 +### Provider 状态契约 位于 `src/plugins/contracts/*.contract.test.ts`。 - **status** - 渠道状态探测 -- **registry** - 插件注册表形状 +- **registry** - 插件注册表结构 -### 提供商契约 +### Provider 契约 位于 `src/plugins/contracts/*.contract.test.ts`： - **auth** - 认证流程契约 -- **auth-choice** - 认证选择 / 选择逻辑 +- **auth-choice** - 认证选择 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 -- **runtime** - 提供商运行时 -- **shape** - 插件形状 / 接口 +- **runtime** - provider 运行时 +- **shape** - 插件结构/接口 - **wizard** - 设置向导 ### 何时运行 -- 修改 plugin-sdk 导出或子路径之后 -- 添加或修改渠道或提供商插件之后 +- 修改 `plugin-sdk` 导出或子路径之后 +- 新增或修改渠道或 provider 插件之后 - 重构插件注册或发现逻辑之后 -契约测试会在 CI 中运行，不需要真实 API 密钥。 +契约测试会在 CI 中运行，不需要真实 API key。 ## 添加回归测试（指南） -当你修复一个在实时测试中发现的提供商 / 模型问题时： +当你修复了在 live 中发现的提供商/模型问题时： -- 如果可能，添加一个 CI 安全的回归测试（mock / stub 提供商，或捕获精确的请求形状转换） -- 如果问题本质上只能在实时环境中重现（速率限制、认证策略），请保持实时测试范围窄，并通过环境变量按需启用 -- 优先定位能捕获该缺陷的最小层级： - - 提供商请求转换 / 重放缺陷 → 直接模型测试 - - Gateway 网关会话 / 历史 / 工具流水线缺陷 → Gateway 网关实时冒烟测试或 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 安全的回归测试（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 时故意失败，以避免新类别被静默跳过。 diff --git a/docs/zh-CN/tools/video-generation.md b/docs/zh-CN/tools/video-generation.md index f3d968990..ba9735335 100644 --- a/docs/zh-CN/tools/video-generation.md +++ b/docs/zh-CN/tools/video-generation.md @@ -3,23 +3,23 @@ read_when: - 通过智能体生成视频 - 配置视频生成提供商和模型 - 了解 `video_generate` 工具参数 -summary: 使用 14 个提供商后端，从文本、图像或现有视频生成视频 +summary: 使用 14 个提供商后端从文本、图像或现有视频生成视频 title: 视频生成 x-i18n: - generated_at: "2026-04-11T09:24:44Z" + generated_at: "2026-04-14T14:00:54Z" model: gpt-5.4 provider: openai - source_hash: 0ec159a0bbb6b8a030e68828c0a8bcaf40c8538ecf98bc8ff609dab9d0068263 + source_hash: c182f24b25e44f157a820e82a1f7422247f26125956944b5eb98613774268cfe source_path: tools/video-generation.md workflow: 15 --- # 视频生成 -OpenClaw 智能体可以根据文本提示、参考图像或现有视频生成视频。当前支持 14 个提供商后端，每个后端都有不同的模型选项、输入模式和功能集。智能体会根据你的配置和可用的 API 密钥自动选择合适的提供商。 +OpenClaw 智能体可以根据文本提示、参考图像或现有视频生成视频。支持 14 个提供商后端，每个后端都有不同的模型选项、输入模式和功能集。智能体会根据你的配置和可用的 API 密钥自动选择合适的提供商。 -只有在至少有一个视频生成提供商可用时，`video_generate` 工具才会出现。如果你在智能体工具中看不到它，请设置提供商 API 密钥，或配置 `agents.defaults.videoGenerationModel`。 +只有在至少有一个视频生成提供商可用时，`video_generate` 工具才会出现。如果你没有在智能体工具中看到它，请设置提供商 API 密钥或配置 `agents.defaults.videoGenerationModel`。 OpenClaw 将视频生成视为三种运行时模式： @@ -28,18 +28,17 @@ OpenClaw 将视频生成视为三种运行时模式： - `imageToVideo`：当请求包含一个或多个参考图像时使用 - `videoToVideo`：当请求包含一个或多个参考视频时使用 -提供商可以支持这些模式中的任意子集。该工具会在提交前验证当前 -模式，并在 `action=list` 中报告支持的模式。 +提供商可以支持这些模式中的任意子集。工具会在提交前校验当前激活的模式，并在 `action=list` 中报告支持的模式。 ## 快速开始 -1. 为任一受支持的提供商设置 API 密钥： +1. 为任意受支持的提供商设置 API 密钥： ```bash export GEMINI_API_KEY="your-key" ``` -2. 可选：固定一个默认模型： +2. 可选：固定默认模型： ```bash openclaw config set agents.defaults.videoGenerationModel.primary "google/veo-3.1-fast-generate-preview" @@ -49,31 +48,31 @@ openclaw config set agents.defaults.videoGenerationModel.primary "google/veo-3.1 > 生成一个 5 秒钟的电影感视频，内容是一只友好的龙虾在日落时分冲浪。 -智能体会自动调用 `video_generate`。不需要配置工具白名单。 +智能体会自动调用 `video_generate`。不需要进行工具 allowlist 配置。 -## 生成视频时会发生什么 +## 当你生成视频时会发生什么 -视频生成是异步的。当智能体在某个会话中调用 `video_generate` 时： +视频生成是异步的。当智能体在一个会话中调用 `video_generate` 时： 1. OpenClaw 将请求提交给提供商，并立即返回一个任务 ID。 -2. 提供商在后台处理该任务（通常需要 30 秒到 5 分钟，取决于提供商和分辨率）。 -3. 视频准备就绪后，OpenClaw 会通过内部完成事件唤醒同一个会话。 -4. 智能体会将最终生成的视频发布回原始对话中。 +2. 提供商在后台处理该作业（通常需要 30 秒到 5 分钟，具体取决于提供商和分辨率）。 +3. 当视频准备好后，OpenClaw 会通过一个内部完成事件唤醒同一个会话。 +4. 智能体会将完成的视频发回原始对话中。 -当某个任务正在处理中时，同一会话中的重复 `video_generate` 调用不会再次启动新的生成任务，而是返回当前任务状态。你可以使用 `openclaw tasks list` 或 `openclaw tasks show ` 在 CLI 中检查进度。 +当任务正在进行时，同一会话中的重复 `video_generate` 调用会返回当前任务状态，而不是再次启动生成。使用 `openclaw tasks list` 或 `openclaw tasks show ` 可从 CLI 检查进度。 -在不依赖会话的智能体运行场景之外（例如，直接调用工具），该工具会回退为内联生成，并在同一轮中返回最终媒体路径。 +在不依赖会话的智能体运行之外（例如直接调用工具），该工具会回退为内联生成，并在同一轮中返回最终媒体路径。 ### 任务生命周期 -每个 `video_generate` 请求都会经历四种状态： +每个 `video_generate` 请求会经历四个状态： -1. **queued** -- 任务已创建，正在等待提供商接受。 -2. **running** -- 提供商正在处理（通常需要 30 秒到 5 分钟，取决于提供商和分辨率）。 -3. **succeeded** -- 视频已准备就绪；智能体会被唤醒并将其发布到对话中。 -4. **failed** -- 提供商错误或超时；智能体会携带错误详情被唤醒。 +1. **queued** -- 任务已创建，等待提供商接受。 +2. **running** -- 提供商正在处理（通常需要 30 秒到 5 分钟，具体取决于提供商和分辨率）。 +3. **succeeded** -- 视频已准备好；智能体被唤醒并将其发送到对话中。 +4. **failed** -- 提供商错误或超时；智能体被唤醒并附带错误详情。 -可通过 CLI 检查状态： +通过 CLI 检查状态： ```bash openclaw tasks list @@ -81,7 +80,7 @@ openclaw tasks show openclaw tasks cancel ``` -防止重复：如果当前会话中已经有一个视频任务处于 `queued` 或 `running` 状态，`video_generate` 会返回现有任务状态，而不是启动新任务。使用 `action: "status"` 可以显式检查状态，而不会触发新的生成。 +重复防护：如果当前会话已经存在一个 `queued` 或 `running` 状态的视频任务，`video_generate` 会返回现有任务状态，而不是启动新任务。使用 `action: "status"` 可以显式检查状态，而不会触发新的生成。 ## 支持的提供商 @@ -102,130 +101,103 @@ openclaw tasks cancel | Vydra | `veo3` | 是 | 1 张图像（`kling`） | 否 | `VYDRA_API_KEY` | | xAI | `grok-imagine-video` | 是 | 1 张图像 | 1 个视频 | `XAI_API_KEY` | -某些提供商还接受额外或替代的 API 密钥环境变量。详见各个[提供商页面](#related)。 +某些提供商接受额外的或替代的 API 密钥环境变量。详情请参阅各个[提供商页面](#related)。 -运行 `video_generate action=list` 以在运行时检查可用的提供商、模型和 -运行时模式。 +运行 `video_generate action=list` 可在运行时检查可用的提供商、模型和运行时模式。 ### 声明的能力矩阵 -这是 `video_generate`、契约测试 -以及共享实时扫描所使用的显式模式契约。 +这是 `video_generate`、契约测试以及共享实时扫测所使用的显式模式契约。 | 提供商 | `generate` | `imageToVideo` | `videoToVideo` | 当前共享实时通道 | | ------ | ---------- | -------------- | -------------- | ---------------- | -| Alibaba | 是 | 是 | 是 | `generate`、`imageToVideo`；`videoToVideo` 被跳过，因为该提供商需要远程 `http(s)` 视频 URL | +| Alibaba | 是 | 是 | 是 | `generate`、`imageToVideo`；`videoToVideo` 已跳过，因为该提供商需要远程 `http(s)` 视频 URL | | BytePlus | 是 | 是 | 否 | `generate`、`imageToVideo` | -| ComfyUI | 是 | 是 | 否 | 不在共享扫描中；特定于 workflow 的覆盖由 Comfy 测试承担 | +| ComfyUI | 是 | 是 | 否 | 不在共享扫测中；特定于 workflow 的覆盖由 Comfy 测试负责 | | fal | 是 | 是 | 否 | `generate`、`imageToVideo` | -| Google | 是 | 是 | 是 | `generate`、`imageToVideo`；共享 `videoToVideo` 被跳过，因为当前基于缓冲区的 Gemini/Veo 扫描不接受该输入 | +| Google | 是 | 是 | 是 | `generate`、`imageToVideo`；共享 `videoToVideo` 已跳过，因为当前基于缓冲区的 Gemini/Veo 扫测不接受该输入 | | MiniMax | 是 | 是 | 否 | `generate`、`imageToVideo` | -| OpenAI | 是 | 是 | 是 | `generate`、`imageToVideo`；共享 `videoToVideo` 被跳过，因为当前此组织/输入路径需要提供商侧的 inpaint/remix 访问能力 | -| Qwen | 是 | 是 | 是 | `generate`、`imageToVideo`；`videoToVideo` 被跳过，因为该提供商需要远程 `http(s)` 视频 URL | +| OpenAI | 是 | 是 | 是 | `generate`、`imageToVideo`；共享 `videoToVideo` 已跳过，因为当前这个组织/输入路径需要提供商侧的 inpaint/remix 访问 | +| Qwen | 是 | 是 | 是 | `generate`、`imageToVideo`；`videoToVideo` 已跳过，因为该提供商需要远程 `http(s)` 视频 URL | | Runway | 是 | 是 | 是 | `generate`、`imageToVideo`；仅当所选模型为 `runway/gen4_aleph` 时才运行 `videoToVideo` | | Together | 是 | 是 | 否 | `generate`、`imageToVideo` | -| Vydra | 是 | 是 | 否 | `generate`；共享 `imageToVideo` 被跳过，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL | -| xAI | 是 | 是 | 是 | `generate`、`imageToVideo`；`videoToVideo` 被跳过，因为该提供商当前需要远程 MP4 URL | +| Vydra | 是 | 是 | 否 | `generate`；共享 `imageToVideo` 已跳过，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL | +| xAI | 是 | 是 | 是 | `generate`、`imageToVideo`；`videoToVideo` 已跳过，因为该提供商当前需要远程 MP4 URL | ## 工具参数 ### 必填 -| 参数 | 类型 | 说明 | +| 参数 | 类型 | 描述 | | ---- | ---- | ---- | | `prompt` | string | 要生成的视频的文本描述（`action: "generate"` 时必填） | ### 内容输入 -| 参数 | 类型 | 说明 | +| 参数 | 类型 | 描述 | | ---- | ---- | ---- | | `image` | string | 单个参考图像（路径或 URL） | | `images` | string[] | 多个参考图像（最多 9 张） | -| `imageRoles` | string[] | 与合并后图像列表按位置对应的可选角色提示。规范值：`first_frame`、`last_frame`、`reference_image` | +| `imageRoles` | string[] | 与合并后图像列表按位置一一对应的可选角色提示。规范值：`first_frame`、`last_frame`、`reference_image` | | `video` | string | 单个参考视频（路径或 URL） | | `videos` | string[] | 多个参考视频（最多 4 个） | -| `videoRoles` | string[] | 与合并后视频列表按位置对应的可选角色提示。规范值：`reference_video` | -| `audioRef` | string | 单个参考音频（路径或 URL）。例如，当提供商支持音频输入时，可用于背景音乐或语音参考 | +| `videoRoles` | string[] | 与合并后视频列表按位置一一对应的可选角色提示。规范值：`reference_video` | +| `audioRef` | string | 单个参考音频（路径或 URL）。例如在提供商支持音频输入时，用于背景音乐或声音参考 | | `audioRefs` | string[] | 多个参考音频（最多 3 个） | -| `audioRoles` | string[] | 与合并后音频列表按位置对应的可选角色提示。规范值：`reference_audio` | +| `audioRoles` | string[] | 与合并后音频列表按位置一一对应的可选角色提示。规范值：`reference_audio` | -角色提示会按原样转发给提供商。规范值来自 -`VideoGenerationAssetRole` 联合类型，但提供商也可能接受额外的 -角色字符串。`*Roles` 数组的条目数不能多于对应的 -参考列表；如果出现数量偏差，会返回清晰的错误。 -使用空字符串可使某个位置保持未设置。 +角色提示会按原样转发给提供商。规范值来自 `VideoGenerationAssetRole` 联合类型，但提供商也可能接受额外的角色字符串。`*Roles` 数组的条目数不得多于对应的参考列表；如果出现数量偏差，系统会返回清晰的错误。使用空字符串可让某个位置保持未设置。 ### 风格控制 -| 参数 | 类型 | 说明 | +| 参数 | 类型 | 描述 | | ---- | ---- | ---- | | `aspectRatio` | string | `1:1`、`2:3`、`3:2`、`3:4`、`4:3`、`4:5`、`5:4`、`9:16`、`16:9`、`21:9` 或 `adaptive` | | `resolution` | string | `480P`、`720P`、`768P` 或 `1080P` | -| `durationSeconds` | number | 目标时长（秒）（会四舍五入到最接近的提供商支持值） | +| `durationSeconds` | number | 目标时长（秒），会四舍五入到最接近的提供商支持值 | | `size` | string | 当提供商支持时使用的尺寸提示 | -| `audio` | boolean | 在支持时为输出启用生成音频。与 `audioRef*`（输入）不同 | +| `audio` | boolean | 在支持时为输出启用生成的音频。与 `audioRef*`（输入）不同 | | `watermark` | boolean | 在支持时切换提供商水印 | -`adaptive` 是一个提供商特定的哨兵值：它会被原样转发给 -在其能力声明中包含 `adaptive` 的提供商（例如 BytePlus -Seedance 会使用它根据输入图像 -尺寸自动检测比例）。对于未声明该值的提供商， -该值会通过工具结果中的 -`details.ignoredOverrides` 暴露出来，以便明确看到它被忽略。 +`adaptive` 是一个提供商特定的哨兵值：对于在其能力声明中包含 `adaptive` 的提供商，该值会按原样转发（例如 BytePlus Seedance 会用它根据输入图像尺寸自动检测比例）。对于未声明该值的提供商，工具结果会通过 `details.ignoredOverrides` 暴露这个值，以便明确显示它已被忽略。 -### 高级 +### 高级参数 -| 参数 | 类型 | 说明 | +| 参数 | 类型 | 描述 | | ---- | ---- | ---- | | `action` | string | `"generate"`（默认）、`"status"` 或 `"list"` | | `model` | string | 提供商/模型覆盖（例如 `runway/gen4.5`） | | `filename` | string | 输出文件名提示 | -| `providerOptions` | object | 以 JSON 对象形式传递的提供商特定选项（例如 `{"seed": 42, "draft": true}`）。声明了类型化 schema 的提供商会验证键名和类型；未知键名或类型不匹配会导致该候选项在回退时被跳过。未声明 schema 的提供商会按原样接收这些选项。运行 `video_generate action=list` 可查看各提供商接受哪些选项 | +| `providerOptions` | object | 以 JSON 对象形式传递的提供商特定选项（例如 `{"seed": 42, "draft": true}`）。声明了类型化 schema 的提供商会校验键名和类型；未知键名或类型不匹配会在回退时跳过该候选项。未声明 schema 的提供商会按原样接收这些选项。运行 `video_generate action=list` 可查看各提供商接受哪些选项 | -并非所有提供商都支持所有参数。OpenClaw 已经会将时长规范化为最接近的提供商支持值，也会在回退提供商暴露不同控制面时，重新映射像 size 到 aspect-ratio 这样的几何提示。真正不受支持的覆盖项会尽力忽略，并在工具结果中作为警告报告。硬性能力限制（例如参考输入过多）会在提交前直接失败。 +并非所有提供商都支持所有参数。OpenClaw 会将时长规范化为最接近的提供商支持值；当回退提供商暴露的是不同控制面时，它还会重新映射诸如尺寸到宽高比之类的几何提示。真正不受支持的覆盖项会尽力忽略，并在工具结果中作为警告报告。硬性能力限制（例如参考输入过多）会在提交前直接报错。 -工具结果会报告实际应用的设置。当 OpenClaw 在提供商回退期间重新映射时长或几何参数时，返回的 `durationSeconds`、`size`、`aspectRatio` 和 `resolution` 值会反映实际提交的内容，而 `details.normalization` 会记录从请求值到应用值的转换。 +工具结果会报告实际应用的设置。当 OpenClaw 在提供商回退期间重新映射时长或几何参数时，返回的 `durationSeconds`、`size`、`aspectRatio` 和 `resolution` 值反映的是实际提交的内容，而 `details.normalization` 会记录从请求值到应用值的转换。 参考输入也会决定运行时模式： -- 没有参考媒体：`generate` -- 存在任意图像参考：`imageToVideo` -- 存在任意视频参考：`videoToVideo` -- 参考音频输入不会改变已解析的模式；它们会叠加应用在图像/视频参考所选择的模式之上，并且仅适用于声明了 `maxInputAudios` 的提供商 +- 无参考媒体：`generate` +- 任意图像参考：`imageToVideo` +- 任意视频参考：`videoToVideo` +- 参考音频输入不会改变最终解析的模式；它们会叠加到图像/视频参考所选择的模式之上，并且仅适用于声明了 `maxInputAudios` 的提供商 -图像和视频参考混用并不是一个稳定的共享能力面。 -建议每次请求只使用一种参考类型。 +图像参考和视频参考混合使用并不是稳定的共享能力面。 +建议每个请求只使用一种参考类型。 -#### 回退与类型化选项 +#### 回退和类型化选项 -某些能力检查是在回退层而不是 -工具边界层应用的，这样即使请求超出了主提供商的限制， -仍然可以在具备相应能力的回退提供商上运行： +某些能力检查是在回退层而不是工具边界上应用的，这样即使请求超出了主提供商的限制，仍然可以在支持该能力的回退提供商上运行： -- 如果当前候选项未声明 `maxInputAudios`（或将其声明为 - `0`），并且请求包含音频参考， - 则会跳过该候选项，并尝试下一个候选项。 -- 如果当前候选项的 `maxDurationSeconds` 低于请求的 - `durationSeconds`，且该候选项未声明 - `supportedDurationSeconds` 列表，则会跳过该候选项。 -- 如果请求包含 `providerOptions`，且当前候选项 - 明确声明了类型化的 `providerOptions` schema， - 当提供的键名不在 schema 中或值类型 - 不匹配时，该候选项会被跳过。尚未声明 schema 的提供商会按原样接收 - 这些选项（向后兼容透传）。提供商可以 - 通过声明一个空 schema - （`capabilities.providerOptions: {}`）来显式禁用所有 provider options， - 这会导致与类型不匹配相同的跳过行为。 +- 如果当前候选项未声明 `maxInputAudios`（或将其声明为 `0`），则当请求包含音频参考时会跳过该候选项，并尝试下一个候选项。 +- 如果当前候选项的 `maxDurationSeconds` 低于请求的 `durationSeconds`，且该候选项未声明 `supportedDurationSeconds` 列表，则会跳过该候选项。 +- 如果请求包含 `providerOptions`，且当前候选项显式声明了类型化的 `providerOptions` schema，那么当提供的键名不在 schema 中或值类型不匹配时，会跳过该候选项。尚未声明 schema 的提供商会按原样接收这些选项（向后兼容的透传）。提供商可以通过声明空 schema（`capabilities.providerOptions: {}`）来显式拒绝所有提供商选项，这会导致与类型不匹配相同的跳过行为。 -请求中的第一个跳过原因会以 `warn` 级别记录，这样操作人员可以看到 -为何他们的主提供商被跳过；后续跳过则以 -`debug` 级别记录，以避免冗长的回退链产生过多噪音。如果所有候选项都被跳过， -聚合错误会包含每个候选项的跳过原因。 +请求中的第一个跳过原因会记录为 `warn`，以便运维人员看到他们的主提供商为何被跳过；后续跳过原因会记录为 `debug`，以避免冗长的回退链产生过多日志。如果所有候选项都被跳过，聚合错误中会包含每个候选项的跳过原因。 ## 操作 -- **generate**（默认） -- 根据给定提示和可选参考输入创建视频。 -- **status** -- 检查当前会话中正在进行的视频任务状态，而不会启动新的生成。 +- **generate**（默认）-- 根据给定的提示和可选参考输入生成视频。 +- **status** -- 检查当前会话中正在进行的视频任务状态，而不启动新的生成。 - **list** -- 显示可用的提供商、模型及其能力。 ## 模型选择 @@ -235,13 +207,11 @@ Seedance 会使用它根据输入图像 1. **`model` 工具参数** -- 如果智能体在调用中指定了它。 2. **`videoGenerationModel.primary`** -- 来自配置。 3. **`videoGenerationModel.fallbacks`** -- 按顺序尝试。 -4. **自动检测** -- 使用具有有效鉴权的提供商，从当前默认提供商开始，然后按字母顺序尝试其余提供商。 +4. **自动检测** -- 使用具有有效凭证的提供商，从当前默认提供商开始，然后按字母顺序尝试其余提供商。 如果某个提供商失败，会自动尝试下一个候选项。如果所有候选项都失败，错误中会包含每次尝试的详细信息。 -如果你希望 -视频生成仅使用显式的 `model`、`primary` 和 `fallbacks` -条目，请设置 `agents.defaults.mediaGenerationAutoProviderFallback: false`。 +如果你希望视频生成仅使用显式的 `model`、`primary` 和 `fallbacks` 条目，请设置 `agents.defaults.mediaGenerationAutoProviderFallback: false`。 ```json5 { @@ -261,25 +231,23 @@ Seedance 会使用它根据输入图像 | 提供商 | 说明 | | ------ | ---- | | Alibaba | 使用 DashScope/Model Studio 异步端点。参考图像和视频必须是远程 `http(s)` URL。 | -| BytePlus（1.0） | 提供商 ID 为 `byteplus`。模型：`seedance-1-0-pro-250528`（默认）、`seedance-1-0-pro-t2v-250528`、`seedance-1-0-pro-fast-251015`、`seedance-1-0-lite-t2v-250428`、`seedance-1-0-lite-i2v-250428`。T2V 模型（`*-t2v-*`）不接受图像输入；I2V 模型和通用 `*-pro-*` 模型支持单张参考图像（首帧）。你可以按位置传入图像，或设置 `role: "first_frame"`。当提供图像时，T2V 模型 ID 会自动切换为对应的 I2V 变体。支持的 `providerOptions` 键名：`seed`（number）、`draft`（boolean，会强制 480p）、`camera_fixed`（boolean）。 | -| BytePlus Seedance 1.5 | 需要安装 [`@openclaw/byteplus-modelark`](https://www.npmjs.com/package/@openclaw/byteplus-modelark) 插件。提供商 ID 为 `byteplus-seedance15`。模型：`seedance-1-5-pro-251215`。使用统一的 `content[]` API。最多支持 2 张输入图像（`first_frame` + `last_frame`）。所有输入都必须是远程 `https://` URL。请为每张图像设置 `role: "first_frame"` / `"last_frame"`，或按位置传入图像。`aspectRatio: "adaptive"` 会根据输入图像自动检测比例。`audio: true` 会映射为 `generate_audio`。`providerOptions.seed`（number）会被转发。 | -| BytePlus Seedance 2.0 | 需要安装 [`@openclaw/byteplus-modelark`](https://www.npmjs.com/package/@openclaw/byteplus-modelark) 插件。提供商 ID 为 `byteplus-seedance2`。模型：`dreamina-seedance-2-0-260128`、`dreamina-seedance-2-0-fast-260128`。使用统一的 `content[]` API。最多支持 9 张参考图像、3 个参考视频和 3 个参考音频。所有输入都必须是远程 `https://` URL。请为每个资源设置 `role`——支持的值包括：`"first_frame"`、`"last_frame"`、`"reference_image"`、`"reference_video"`、`"reference_audio"`。`aspectRatio: "adaptive"` 会根据输入图像自动检测比例。`audio: true` 会映射为 `generate_audio`。`providerOptions.seed`（number）会被转发。 | -| ComfyUI | 由 workflow 驱动的本地或云端执行。通过已配置的图表支持文生视频和图生视频。 | -| fal | 对长时间运行任务使用基于队列的流程。仅支持单张图像参考。 | -| Google | 使用 Gemini/Veo。支持一张图像或一个视频参考。 | -| MiniMax | 仅支持单张图像参考。 | -| OpenAI | 只会转发 `size` 覆盖项。其他风格覆盖项（`aspectRatio`、`resolution`、`audio`、`watermark`）会被忽略，并发出警告。 | -| Qwen | 与 Alibaba 使用相同的 DashScope 后端。参考输入必须是远程 `http(s)` URL；本地文件会在前置校验时被拒绝。 | -| Runway | 通过 data URI 支持本地文件。视频转视频需要 `runway/gen4_aleph`。纯文本运行暴露 `16:9` 和 `9:16` 宽高比。 | -| Together | 仅支持单张图像参考。 | -| Vydra | 直接使用 `https://www.vydra.ai/api/v1`，以避免丢失鉴权的重定向。内置 `veo3` 仅支持文生视频；`kling` 需要远程图像 URL。 | +| BytePlus（1.0） | 提供商 ID 为 `byteplus`。模型：`seedance-1-0-pro-250528`（默认）、`seedance-1-0-pro-t2v-250528`、`seedance-1-0-pro-fast-251015`、`seedance-1-0-lite-t2v-250428`、`seedance-1-0-lite-i2v-250428`。T2V 模型（`*-t2v-*`）不接受图像输入；I2V 模型和通用 `*-pro-*` 模型支持单个参考图像（首帧）。可以按位置传递图像，或设置 `role: "first_frame"`。当提供图像时，T2V 模型 ID 会自动切换为对应的 I2V 变体。支持的 `providerOptions` 键名：`seed`（number）、`draft`（boolean，会强制为 480p）、`camera_fixed`（boolean）。 | +| BytePlus Seedance 1.5 | 需要 [`@openclaw/byteplus-modelark`](https://www.npmjs.com/package/@openclaw/byteplus-modelark) 插件。提供商 ID 为 `byteplus-seedance15`。模型：`seedance-1-5-pro-251215`。使用统一的 `content[]` API。最多支持 2 张输入图像（`first_frame` + `last_frame`）。所有输入都必须是远程 `https://` URL。在每张图像上设置 `role: "first_frame"` / `"last_frame"`，或按位置传递图像。`aspectRatio: "adaptive"` 会根据输入图像自动检测比例。`audio: true` 会映射为 `generate_audio`。`providerOptions.seed`（number）会被转发。 | +| BytePlus Seedance 2.0 | 需要 [`@openclaw/byteplus-modelark`](https://www.npmjs.com/package/@openclaw/byteplus-modelark) 插件。提供商 ID 为 `byteplus-seedance2`。模型：`dreamina-seedance-2-0-260128`、`dreamina-seedance-2-0-fast-260128`。使用统一的 `content[]` API。最多支持 9 张参考图像、3 个参考视频和 3 个参考音频。所有输入都必须是远程 `https://` URL。为每个资源设置 `role`——支持的值包括：`"first_frame"`、`"last_frame"`、`"reference_image"`、`"reference_video"`、`"reference_audio"`。`aspectRatio: "adaptive"` 会根据输入图像自动检测比例。`audio: true` 会映射为 `generate_audio`。`providerOptions.seed`（number）会被转发。 | +| ComfyUI | 由 workflow 驱动的本地或云端执行。通过已配置的图形支持文生视频和图生视频。 | +| fal | 对长时间运行的作业使用基于队列的流程。仅支持单个图像参考。 | +| Google | 使用 Gemini/Veo。支持一个图像参考或一个视频参考。 | +| MiniMax | 仅支持单个图像参考。 | +| OpenAI | 仅转发 `size` 覆盖项。其他风格覆盖项（`aspectRatio`、`resolution`、`audio`、`watermark`）会被忽略，并附带警告。 | +| Qwen | 与 Alibaba 使用相同的 DashScope 后端。参考输入必须是远程 `http(s)` URL；本地文件会被预先拒绝。 | +| Runway | 通过 data URI 支持本地文件。视频转视频需要 `runway/gen4_aleph`。纯文本运行支持 `16:9` 和 `9:16` 宽高比。 | +| Together | 仅支持单个图像参考。 | +| Vydra | 直接使用 `https://www.vydra.ai/api/v1` 以避免凭证在重定向中丢失。内置的 `veo3` 仅支持文生视频；`kling` 需要远程图像 URL。 | | xAI | 支持文生视频、图生视频，以及基于远程视频的编辑/扩展流程。 | ## 提供商能力模式 -共享的视频生成契约现在允许提供商声明特定于模式的 -能力，而不再只使用扁平的聚合限制。新的提供商 -实现应优先使用显式模式块： +共享视频生成契约现在允许提供商声明特定于模式的能力，而不再仅仅是扁平化的聚合限制。新的提供商实现应优先使用显式的模式块： ```typescript capabilities: { @@ -303,38 +271,42 @@ capabilities: { } ``` -像 `maxInputImages` 和 `maxInputVideos` 这样的扁平聚合字段 -不足以声明转换模式支持。提供商应显式声明 -`generate`、`imageToVideo` 和 `videoToVideo`，以便实时测试、 -契约测试以及共享的 `video_generate` 工具能够以确定性的方式 -验证模式支持。 +像 `maxInputImages` 和 `maxInputVideos` 这样的扁平聚合字段，不足以声明转换模式支持。提供商应显式声明 `generate`、`imageToVideo` 和 `videoToVideo`，这样实时测试、契约测试以及共享的 `video_generate` 工具才能以确定性的方式校验模式支持。 ## 实时测试 -为共享内置提供商启用可选的实时覆盖： +为共享内置提供商启用选择性实时覆盖： ```bash OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/video-generation-providers.live.test.ts ``` -仓库封装命令： +仓库包装命令： ```bash pnpm test:live:media video ``` -该实时测试文件会从 `~/.profile` 加载缺失的提供商环境变量，默认优先使用 -实时/环境变量中的 API 密钥，而不是已存储的鉴权配置文件，并运行其能够安全使用本地媒体执行的 -已声明模式： +这个实时测试文件会从 `~/.profile` 加载缺失的提供商环境变量，默认优先使用实时/环境变量 API 密钥而不是已存储的凭证配置，并且默认运行一个适合发布流程的冒烟测试： -- 对扫描中的每个提供商执行 `generate` -- 当 `capabilities.imageToVideo.enabled` 为真时执行 `imageToVideo` -- 当 `capabilities.videoToVideo.enabled` 为真且提供商/模型 - 在共享扫描中接受基于缓冲区的本地视频输入时执行 `videoToVideo` +- 对扫测中的每个非 FAL 提供商运行 `generate` +- 使用 1 秒钟的龙虾提示词 +- 每个提供商的操作上限由 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 控制（默认值为 `180000`） -目前共享的 `videoToVideo` 实时通道覆盖： +FAL 需要显式选择启用，因为提供商侧的队列延迟可能会显著拉长发布时间： -- 仅 `runway`，并且前提是你选择了 `runway/gen4_aleph` +```bash +pnpm test:live:media video --video-providers fal +``` + +设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 后，还会运行共享扫测能够安全使用本地媒体执行的已声明转换模式： + +- 当 `capabilities.imageToVideo.enabled` 为真时运行 `imageToVideo` +- 当 `capabilities.videoToVideo.enabled` 为真，且提供商/模型在共享扫测中接受基于缓冲区的本地视频输入时运行 `videoToVideo` + +目前，共享 `videoToVideo` 实时通道覆盖： + +- 仅 `runway`，并且你选择了 `runway/gen4_aleph` 时才会运行 ## 配置 @@ -362,9 +334,9 @@ openclaw config set agents.defaults.videoGenerationModel.primary "qwen/wan2.6-t2 ## 相关内容 - [工具概览](/zh-CN/tools) -- [后台任务](/zh-CN/automation/tasks) -- 异步视频生成的任务跟踪 +- [后台任务](/zh-CN/automation/tasks) -- 用于异步视频生成的任务跟踪 - [Alibaba Model Studio](/zh-CN/providers/alibaba) -- [BytePlus（国际版）](/zh-CN/concepts/model-providers#byteplus-international) +- [BytePlus](/zh-CN/concepts/model-providers#byteplus-international) - [ComfyUI](/zh-CN/providers/comfy) - [fal](/zh-CN/providers/fal) - [Google（Gemini）](/zh-CN/providers/google)