diff --git a/docs/zh-CN/ci.md b/docs/zh-CN/ci.md index ca6e99a6f..963338f90 100644 --- a/docs/zh-CN/ci.md +++ b/docs/zh-CN/ci.md @@ -1,98 +1,100 @@ --- read_when: - - 你需要了解某个 CI 作业为什么会运行或不会运行 - - 你正在调试失败的 GitHub Actions 检查 + - 你需要了解为什么某个 CI 作业运行了或没有运行。 + - 你正在调试失败的 GitHub Actions 检查。 summary: CI 作业图、作用域门禁，以及本地等效命令 title: CI 流水线 x-i18n: - generated_at: "2026-04-23T05:04:48Z" + generated_at: "2026-04-23T05:14:57Z" model: gpt-5.4 provider: openai - source_hash: 345fd6200405e8b3f4ba9baadbbd491aa506f889c38631685aa5a8392e082109 + source_hash: b3c2cf85b45405fdd5cc1d74c7cc07c4f16c3d9dcf8ca93286a0ba78ba4b6dd1 source_path: ci.md workflow: 15 --- # CI 流水线 -CI 会在每次推送到 `main` 以及每个拉取请求时运行。它使用智能作用域划分，在仅有不相关区域发生变更时跳过高成本作业。 +CI 会在每次推送到 `main` 以及每个拉取请求上运行。它使用智能作用域划分，在只有不相关区域发生变更时跳过高开销作业。 + +QA Lab 在主智能作用域工作流之外还有两条专用的 CI 通道。`Parity gate` 工作流会在匹配的 PR 变更、`main` 上的每夜运行以及手动触发时运行；它会构建私有 QA 运行时，并比较模拟的 GPT-5.4 和 Opus 4.6 智能体包。`QA-Lab - Live Telegram, Live Frontier` 工作流会在 `main` 上每夜运行以及手动触发时运行；它使用 `qa-live-shared` 环境，并为实时 Telegram 通道使用 Convex 租约。`OpenClaw Release Checks` 也会在发布批准前运行这两条 QA Lab 通道。 ## 作业概览 | 作业 | 目的 | 运行时机 | | -------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------ | -| `preflight` | 检测仅文档变更、变更作用域、已变更扩展，并构建 CI 清单 | 在所有非草稿推送和 PR 上始终运行 | +| `preflight` | 检测仅文档变更、变更作用域、变更的扩展，并构建 CI 清单 | 在所有非草稿推送和 PR 上始终运行 | | `security-scm-fast` | 通过 `zizmor` 进行私钥检测和工作流审计 | 在所有非草稿推送和 PR 上始终运行 | -| `security-dependency-audit` | 针对 npm 安全公告执行无依赖的生产 lockfile 审计 | 在所有非草稿推送和 PR 上始终运行 | -| `security-fast` | 快速安全作业的必需聚合项 | 在所有非草稿推送和 PR 上始终运行 | -| `build-artifacts` | 构建 `dist/`、Control UI、构建产物检查，以及可复用的下游产物 | 与 Node 相关的变更 | -| `checks-fast-core` | 快速 Linux 正确性分支，例如 bundled/plugin-contract/protocol 检查 | 与 Node 相关的变更 | +| `security-dependency-audit` | 针对 npm 安全通告执行无依赖的生产锁文件审计 | 在所有非草稿推送和 PR 上始终运行 | +| `security-fast` | 快速安全作业的必需聚合作业 | 在所有非草稿推送和 PR 上始终运行 | +| `build-artifacts` | 构建 `dist/`、Control UI、构建产物检查，以及可复用的下游构建产物 | 与 Node 相关的变更 | +| `checks-fast-core` | 快速 Linux 正确性通道，例如内置/plugin-contract/protocol 检查 | 与 Node 相关的变更 | | `checks-fast-contracts-channels` | 分片的渠道契约检查，并提供稳定的聚合检查结果 | 与 Node 相关的变更 | | `checks-node-extensions` | 覆盖整个扩展套件的完整内置插件测试分片 | 与 Node 相关的变更 | -| `checks-node-core-test` | Core Node 测试分片，不包括渠道、内置、契约和扩展分支 | 与 Node 相关的变更 | -| `extension-fast` | 仅针对已变更内置插件的定向测试 | 带有扩展变更的拉取请求 | -| `check` | 分片后的主本地门禁等效项：生产类型、lint、守卫、测试类型和严格 smoke | 与 Node 相关的变更 | -| `check-additional` | 架构、边界、扩展表面守卫、包边界，以及 gateway-watch 分片 | 与 Node 相关的变更 | -| `build-smoke` | 已构建 CLI 的 smoke 测试和启动内存 smoke | 与 Node 相关的变更 | -| `checks` | 已构建产物的渠道测试验证器，以及仅在推送时运行的 Node 22 兼容性 | 与 Node 相关的变更 | -| `check-docs` | 文档格式、lint 和失效链接检查 | 文档发生变更 | -| `skills-python` | 针对 Python 支持的 Skills 运行 Ruff + pytest | 与 Python Skills 相关的变更 | -| `checks-windows` | Windows 特定测试分支 | 与 Windows 相关的变更 | -| `macos-node` | 使用共享构建产物的 macOS TypeScript 测试分支 | 与 macOS 相关的变更 | +| `checks-node-core-test` | Core Node 测试分片，不包含渠道、内置、契约和扩展通道 | 与 Node 相关的变更 | +| `extension-fast` | 仅针对已变更的内置插件执行聚焦测试 | 具有扩展变更的拉取请求 | +| `check` | 分片的主本地门禁等效项：生产类型、lint、守卫、测试类型以及严格 smoke | 与 Node 相关的变更 | +| `check-additional` | 架构、边界、扩展表面守卫、包边界以及 gateway-watch 分片 | 与 Node 相关的变更 | +| `build-smoke` | 已构建 CLI 的 smoke 测试以及启动内存 smoke | 与 Node 相关的变更 | +| `checks` | 已构建构件渠道测试的验证器，以及仅推送时启用的 Node 22 兼容性 | 与 Node 相关的变更 | +| `check-docs` | 文档格式、lint 和坏链检查 | 文档发生变更 | +| `skills-python` | 面向 Python 支持的 Skills 的 Ruff + pytest | 与 Python Skills 相关的变更 | +| `checks-windows` | Windows 专用测试通道 | 与 Windows 相关的变更 | +| `macos-node` | 使用共享构建产物的 macOS TypeScript 测试通道 | 与 macOS 相关的变更 | | `macos-swift` | macOS 应用的 Swift lint、构建和测试 | 与 macOS 相关的变更 | -| `android` | 两种 flavor 的 Android 单元测试，以及一次 debug APK 构建 | 与 Android 相关的变更 | +| `android` | 两种 flavor 的 Android 单元测试，以及一个 debug APK 构建 | 与 Android 相关的变更 | ## 快速失败顺序 -作业的排列顺序经过设计，使廉价检查能在高成本作业运行前先失败： +作业顺序经过安排，使低成本检查先失败，避免高成本作业继续运行： -1. `preflight` 决定究竟存在哪些分支。`docs-scope` 和 `changed-scope` 逻辑是这个作业中的步骤，而不是独立作业。 -2. `security-scm-fast`、`security-dependency-audit`、`security-fast`、`check`、`check-additional`、`check-docs` 和 `skills-python` 会快速失败，而不会等待更重的产物和平台矩阵作业。 -3. `build-artifacts` 与快速 Linux 分支并行进行，这样下游消费者可以在共享构建就绪后立即开始。 -4. 更重的平台和运行时分支会在此之后展开：`checks-fast-core`、`checks-fast-contracts-channels`、`checks-node-extensions`、`checks-node-core-test`、仅限 PR 的 `extension-fast`、`checks`、`checks-windows`、`macos-node`、`macos-swift` 和 `android`。 +1. `preflight` 决定哪些通道会存在。`docs-scope` 和 `changed-scope` 逻辑是这个作业内部的步骤，不是独立作业。 +2. `security-scm-fast`、`security-dependency-audit`、`security-fast`、`check`、`check-additional`、`check-docs` 和 `skills-python` 会快速失败，无需等待更重的构建产物和平台矩阵作业。 +3. `build-artifacts` 与快速 Linux 通道并行执行，这样下游消费者可以在共享构建准备好后立即开始。 +4. 随后更重的平台和运行时通道再展开：`checks-fast-core`、`checks-fast-contracts-channels`、`checks-node-extensions`、`checks-node-core-test`、仅 PR 的 `extension-fast`、`checks`、`checks-windows`、`macos-node`、`macos-swift` 和 `android`。 作用域逻辑位于 `scripts/ci-changed-scope.mjs`，并由 `src/scripts/ci-changed-scope.test.ts` 中的单元测试覆盖。 -CI 工作流编辑会验证 Node CI 作业图以及工作流 lint，但它们本身不会强制触发 Windows、Android 或 macOS 原生构建；这些平台分支仍仅限于平台源码变更。 -Windows Node 检查仅针对 Windows 特定的进程/路径包装器、npm/pnpm/UI 运行器辅助工具、包管理器配置，以及执行该分支的 CI 工作流表面进行作用域划分；不相关的源码、插件、安装 smoke 和仅测试变更仍保留在 Linux Node 分支上，因此不会为了已经由常规测试分片覆盖的内容而占用一台 16 vCPU 的 Windows worker。 -单独的 `install-smoke` 工作流会通过其自己的 `preflight` 作业复用同一个作用域脚本。它根据更窄的 changed-smoke 信号计算 `run_install_smoke`，因此 Docker/安装 smoke 会针对安装、打包、与容器相关的变更、内置扩展生产变更，以及 Docker smoke 作业所覆盖的 core plugin/channel/gateway/插件 SDK 表面运行。仅测试和仅文档编辑不会占用 Docker workers。它的 QR 包 smoke 会强制 Docker `pnpm install` 层重新运行，同时保留 BuildKit pnpm store 缓存，因此仍能覆盖安装过程，而无需每次运行都重新下载依赖。它的 gateway-network e2e 会复用作业前面构建好的运行时镜像，因此在不增加额外 Docker 构建的情况下，增加了真实的容器到容器 WebSocket 覆盖。本地 `test:docker:all` 会预构建一个共享的 `scripts/e2e/Dockerfile` built-app 镜像，并在 E2E 容器 smoke 运行器之间复用；可复用的 live/E2E 工作流也遵循这一模式，会在 Docker 矩阵之前构建并推送一个带 SHA 标签的 GHCR Docker E2E 镜像，然后使用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 运行矩阵。QR 和安装器 Docker 测试则保留各自以安装为重点的 Dockerfile。另有一个独立的 `docker-e2e-fast` 作业，在 120 秒命令超时下运行受限的内置插件 Docker 配置：setup-entry 依赖修复加上 synthetic bundled-loader failure isolation。完整的内置更新/渠道矩阵仍保留为手动/完整套件，因为它会重复执行真实的 npm update 和 doctor repair 过程。 +CI 工作流编辑会验证 Node CI 作业图以及工作流 lint，但它们本身不会强制触发 Windows、Android 或 macOS 原生构建；这些平台通道仍然只针对平台源码变更启用。 +Windows Node 检查的作用域限定在 Windows 专用的进程/路径包装器、npm/pnpm/UI 运行器辅助工具、包管理器配置，以及执行该通道的 CI 工作流表面；不相关的源码、插件、安装 smoke 和仅测试变更仍然留在 Linux Node 通道中，因此不会为了已由常规测试分片覆盖的内容占用一个 16 vCPU 的 Windows worker。 +单独的 `install-smoke` 工作流会通过它自己的 `preflight` 作业复用同一个作用域脚本。它会基于更窄的 changed-smoke 信号计算 `run_install_smoke`，因此 Docker/安装 smoke 会在安装、打包、与容器相关的变更、内置扩展生产变更，以及 Docker smoke 作业所覆盖的 core plugin/channel/Gateway 网关/插件 SDK 表面发生变化时运行。仅测试和仅文档编辑不会占用 Docker worker。它的 QR 包 smoke 会强制 Docker `pnpm install` 层重新运行，同时保留 BuildKit 的 pnpm store 缓存，因此仍会覆盖安装流程，而不必在每次运行时重新下载依赖。它的 gateway-network e2e 会复用该作业前面构建的运行时镜像，因此增加了真实的容器到容器 WebSocket 覆盖，而无需再增加一次 Docker 构建。本地 `test:docker:all` 会预构建一个共享的 `scripts/e2e/Dockerfile` built-app 镜像，并在 E2E 容器 smoke 运行器之间复用；可复用的 live/E2E 工作流也采用同样的模式，在 Docker 矩阵之前先构建并推送一个带 SHA 标签的 GHCR Docker E2E 镜像，然后以 `OPENCLAW_SKIP_DOCKER_BUILD=1` 运行矩阵。QR 和 installer Docker 测试保留各自以安装为重点的 Dockerfile。单独的 `docker-e2e-fast` 作业会在 120 秒命令超时限制下运行有界的内置插件 Docker 配置：setup-entry 依赖修复加上合成的 bundled-loader 故障隔离。完整的内置更新/渠道矩阵仍然是手动/完整套件，因为它会执行多次真实的 npm update 和 doctor 修复流程。 -本地 changed-lane 逻辑位于 `scripts/changed-lanes.mjs`，并由 `scripts/check-changed.mjs` 执行。这个本地门禁在架构边界方面比较宽泛的 CI 平台作用域更严格：core 生产变更会运行 core 生产 typecheck 加 core 测试，core 仅测试变更只运行 core 测试 typecheck/测试，扩展生产变更会运行扩展生产 typecheck 加扩展测试，而扩展仅测试变更只运行扩展测试 typecheck/测试。公共插件 SDK 或 plugin-contract 变更会扩展为扩展验证，因为扩展依赖这些 core 契约。仅发布元数据的版本提升会运行定向的版本/配置/根依赖检查。未知的根目录/配置变更会以安全优先方式回退到所有分支。 +本地 changed-lane 逻辑位于 `scripts/changed-lanes.mjs`，并由 `scripts/check-changed.mjs` 执行。这个本地门禁在架构边界方面比宽泛的 CI 平台作用域更严格：core 生产变更会运行 core 生产 typecheck 加 core 测试，core 仅测试变更只运行 core 测试 typecheck/测试，扩展生产变更会运行扩展生产 typecheck 加扩展测试，而扩展仅测试变更只运行扩展测试 typecheck/测试。公开的插件 SDK 或 plugin-contract 变更会扩大到扩展验证，因为扩展依赖这些核心契约。仅发布元数据的版本号变更会运行有针对性的版本/配置/root 依赖检查。未知的 root/配置变更会以保守方式回退到所有通道。 -在推送时，`checks` 矩阵会加入仅推送时运行的 `compat-node22` 分支。在拉取请求中，该分支会被跳过，矩阵会聚焦于常规测试/渠道分支。 +在推送时，`checks` 矩阵会增加仅推送启用的 `compat-node22` 通道。在拉取请求上，这个通道会被跳过，矩阵仍专注于常规测试/渠道通道。 -最慢的 Node 测试族已被拆分或平衡，以便每个作业都保持较小规模：渠道契约将 registry 和 core 覆盖拆分为总共六个加权分片，内置插件测试在六个扩展 workers 之间平衡分配，自动回复以三个平衡 workers 运行而不是六个很小的 workers，而 agentic gateway/plugin 配置则分布到现有仅源码的 agentic Node 作业中，而不是等待构建产物。广泛的 browser、QA、media 和杂项插件测试使用各自专用的 Vitest 配置，而不是共享的插件兜底配置。广泛的 agents 分支使用共享的 Vitest 文件并行调度器，因为它主要受导入/调度影响，而不是由某个单独的慢测试文件主导。`runtime-config` 与 infra core-runtime 分片一起运行，以避免共享运行时分片承担尾部耗时。`check-additional` 将包边界 compile/canary 工作放在一起，并将运行时拓扑架构与 gateway watch 覆盖分开；边界守卫分片会在一个作业内并发运行其小型独立守卫。Gateway watch、渠道测试以及 core support-boundary 分片会在 `dist/` 和 `dist-runtime/` 已构建完成之后，于 `build-artifacts` 内并发运行，保留它们原有的检查名称作为轻量级验证作业，同时避免再占用两个额外的 Blacksmith workers 和第二个产物消费者队列。 -Android CI 会同时运行 `testPlayDebugUnitTest` 和 `testThirdPartyDebugUnitTest`，然后构建 Play debug APK。第三方 flavor 没有单独的源码集或清单；它的单元测试分支仍会使用 SMS/通话日志 BuildConfig 标志来编译该 flavor，同时避免在每次与 Android 相关的推送中重复执行 debug APK 打包作业。 -`extension-fast` 仅限 PR，因为 push 运行已经会执行完整的内置插件分片。这样既能为评审提供已变更插件的反馈，又不会在 `main` 上额外占用一个 Blacksmith worker 去覆盖已经存在于 `checks-node-extensions` 中的内容。 +最慢的 Node 测试家族已经被拆分或平衡，因此每个作业都保持较小规模：渠道契约将 registry 和 core 覆盖拆成总计六个加权分片，内置插件测试在六个扩展 worker 之间平衡，自动回复以三个平衡 worker 运行而不是六个很小的 worker，而 agentic Gateway 网关/plugin 配置会分散到现有的仅源码 agentic Node 作业中，而不是等待构建产物。广泛的 browser、QA、media 和杂项插件测试使用各自专用的 Vitest 配置，而不是共享的插件兜底配置。宽泛的 agents 通道使用共享的 Vitest 文件级并行调度器，因为它主要受 import/调度影响，而不是由单个慢测试文件主导。`runtime-config` 与 infra core-runtime 分片一起运行，以避免共享 runtime 分片成为尾部瓶颈。`check-additional` 将 package-boundary compile/canary 工作保持在一起，并将 runtime topology 架构与 gateway watch 覆盖分开；边界守卫分片会在一个作业内部并发运行其体量较小且彼此独立的守卫。Gateway 网关 watch、渠道测试以及 core support-boundary 分片会在 `dist/` 和 `dist-runtime/` 已构建完成后，在 `build-artifacts` 内部并发运行；这样既保留了它们原有的检查名称作为轻量级验证作业，又避免了额外两个 Blacksmith worker 和第二个构建产物消费者队列。 +Android CI 会同时运行 `testPlayDebugUnitTest` 和 `testThirdPartyDebugUnitTest`，然后构建 Play debug APK。第三方 flavor 没有单独的源码集或 manifest；它的单元测试通道仍会在启用 SMS/通话记录 BuildConfig 标志的情况下编译该 flavor，同时避免在每次与 Android 相关的推送中重复执行 debug APK 打包作业。 +`extension-fast` 仅在 PR 上运行，因为 push 已经会执行完整的内置插件分片。这样可以在评审时保留已变更插件的反馈，同时避免在 `main` 上为 `checks-node-extensions` 已经覆盖的内容额外占用一个 Blacksmith worker。 -当同一 PR 或 `main` 引用上有更新的推送到达时，GitHub 可能会将已被取代的作业标记为 `cancelled`。除非同一引用上的最新运行也失败，否则应将其视为 CI 噪声。聚合分片检查使用 `!cancelled() && always()`，因此它们仍会报告正常的分片失败，但不会在整个工作流已经被更新运行取代后继续排队。 -CI 并发键带有版本号（`CI-v7-*`），因此 GitHub 端旧队列组中的僵尸任务不会无限期阻塞较新的 main 运行。 +当同一个 PR 或 `main` 引用上有较新的推送到达时，GitHub 可能会将被取代的作业标记为 `cancelled`。除非同一引用上的最新运行也失败，否则应将其视为 CI 噪声。聚合分片检查使用 `!cancelled() && always()`，因此它们仍会正常报告分片失败，但不会在整个工作流已经被更新版本取代后继续排队。 +CI 并发键带有版本号（`CI-v7-*`），这样 GitHub 端旧队列组中的僵尸任务就不会无限期阻塞新的 `main` 运行。 ## 运行器 | 运行器 | 作业 | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ubuntu-24.04` | `preflight`、快速安全作业及其聚合项（`security-scm-fast`、`security-dependency-audit`、`security-fast`）、快速 protocol/contract/bundled 检查、分片的渠道契约检查、除 lint 之外的 `check` 分片、`check-additional` 分片及其聚合项、Node 测试聚合验证器、文档检查、Python Skills、workflow-sanity、labeler、自动响应；`install-smoke` 的 preflight 也使用 GitHub 托管的 Ubuntu，以便 Blacksmith 矩阵能更早排队 | +| `ubuntu-24.04` | `preflight`、快速安全作业及其聚合（`security-scm-fast`、`security-dependency-audit`、`security-fast`）、快速 protocol/contract/bundled 检查、分片的渠道契约检查、除 lint 之外的 `check` 分片、`check-additional` 分片及聚合、Node 测试聚合验证器、文档检查、Python Skills、workflow-sanity、labeler、auto-response；`install-smoke` 的 preflight 也使用 GitHub 托管的 Ubuntu，这样 Blacksmith 矩阵可以更早开始排队 | | `blacksmith-8vcpu-ubuntu-2404` | `build-artifacts`、build-smoke、Linux Node 测试分片、内置插件测试分片、`android` | -| `blacksmith-16vcpu-ubuntu-2404` | `check-lint`，它对 CPU 仍然足够敏感，以至于 8 vCPU 的成本高于收益；以及 `install-smoke` 的 Docker 构建，在那里 32 vCPU 的排队时间成本高于收益 | +| `blacksmith-16vcpu-ubuntu-2404` | `check-lint`，它仍然对 CPU 足够敏感，以至于 8 vCPU 的成本高于节省；`install-smoke` Docker 构建，其中 32 vCPU 的排队时间成本高于节省 | | `blacksmith-16vcpu-windows-2025` | `checks-windows` | -| `blacksmith-6vcpu-macos-latest` | 在 `openclaw/openclaw` 上运行的 `macos-node`；fork 会回退到 `macos-latest` | -| `blacksmith-12vcpu-macos-latest` | 在 `openclaw/openclaw` 上运行的 `macos-swift`；fork 会回退到 `macos-latest` | +| `blacksmith-6vcpu-macos-latest` | `openclaw/openclaw` 上的 `macos-node`；fork 会回退到 `macos-latest` | +| `blacksmith-12vcpu-macos-latest` | `openclaw/openclaw` 上的 `macos-swift`；fork 会回退到 `macos-latest` | ## 本地等效命令 ```bash -pnpm changed:lanes # 检查针对 origin/main...HEAD 的本地 changed-lane 分类器 -pnpm check:changed # 智能本地门禁：按边界分支运行变更范围内的 typecheck/lint/测试 -pnpm check # 快速本地门禁：生产 `tsgo` + 分片 lint + 并行快速守卫 +pnpm changed:lanes # 检查本地针对 origin/main...HEAD 的 changed-lane 分类器 +pnpm check:changed # 智能本地门禁：按边界通道运行变更范围内的 typecheck/lint/测试 +pnpm check # 快速本地门禁：生产 tsgo + 分片 lint + 并行快速守卫 pnpm check:test-types -pnpm check:timed # 相同门禁，但带有各阶段耗时 +pnpm check:timed # 相同门禁，并附带各阶段耗时 pnpm build:strict-smoke pnpm check:architecture pnpm test:gateway:watch-regression -pnpm test # Vitest 测试 +pnpm test # vitest 测试 pnpm test:channels pnpm test:contracts:channels -pnpm check:docs # 文档格式 + lint + 失效链接 -pnpm build # 当 CI 产物/build-smoke 分支相关时，构建 `dist` -node scripts/ci-run-timings.mjs # 汇总总耗时、排队耗时以及最慢的作业 +pnpm check:docs # 文档格式 + lint + 坏链检查 +pnpm build # 当 CI 构建产物/build-smoke 通道相关时，构建 dist +node scripts/ci-run-timings.mjs # 汇总总耗时、排队时间以及最慢的作业 ``` diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index fddd6241a..683472154 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -1,122 +1,121 @@ --- read_when: - 在本地或 CI 中运行测试 - - 为模型/提供商 bug 添加回归测试 + - 为模型 / 提供商 bug 添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包：unit/e2e/live 套件、Docker 运行器，以及每项测试覆盖的内容 +summary: 测试工具包：单元 / e2e / 实时测试套件、Docker 运行器，以及每种测试涵盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-23T05:04:50Z" + generated_at: "2026-04-23T05:14:54Z" model: gpt-5.4 provider: openai - source_hash: bb54abb18e3af9b9cf9d9bea42da40d961f0abdbfd667c65c21a59bdde0fe700 + source_hash: b4902af2bf752d03b6928206f5e93f6681fec29319c9815c0178bec3ce4b74c1 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三套 Vitest 测试套件（unit/integration、e2e、live）以及一小组 Docker 运行器。 +OpenClaw 有三套 Vitest 测试套件（单元 / 集成、e2e、实时）以及一小组 Docker 运行器。 -本文档是一份“我们如何测试”的指南： +本文档是“我们如何测试”的指南： -- 每个套件覆盖什么（以及它刻意 _不_ 覆盖什么） -- 常见工作流（本地、推送前、调试）应运行哪些命令 -- live 测试如何发现凭证，以及如何选择模型/提供商 -- 如何为真实世界中的模型/提供商问题添加回归测试 +- 每个测试套件涵盖什么内容（以及它刻意 _不_ 涵盖什么） +- 常见工作流应运行哪些命令（本地、推送前、调试） +- 实时测试如何发现凭证并选择模型 / 提供商 +- 如何为真实世界中的模型 / 提供商问题添加回归测试 ## 快速开始 大多数时候： - 完整门禁（预期在推送前执行）：`pnpm build && pnpm check && pnpm check:test-types && pnpm test` -- 在配置充足的机器上更快地运行本地全套测试：`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` +- 在配置充足的机器上更快地运行本地完整测试套件：`pnpm test:max` +- 直接进入 Vitest 监听循环：`pnpm test:watch` +- 现在直接定位文件也会路由到 extension / 渠道路径：`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` +- E2E 测试套件：`pnpm test:e2e` -当你在调试真实提供商/模型时（需要真实凭证）： +当你在调试真实提供商 / 模型时（需要真实凭证）： -- live 套件（模型 + Gateway 网关工具/图像探测）：`pnpm test:live` -- 安静地只运行一个 live 文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` -- Moonshot/Kimi 成本冒烟测试：设置 `MOONSHOT_API_KEY` 后，运行 - `openclaw models list --provider moonshot --json`，然后对 `moonshot/kimi-k2.6` 运行隔离的 +- 实时测试套件（模型 + Gateway 网关工具 / 图像探测）：`pnpm test:live` +- 安静地只跑一个实时测试文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` +- Moonshot / Kimi 成本冒烟测试：设置 `MOONSHOT_API_KEY` 后，运行 + `openclaw models list --provider moonshot --json`，然后针对 `moonshot/kimi-k2.6` 运行隔离的 `openclaw agent --local --session-id live-kimi-cost --message 'Reply exactly: KIMI_LIVE_OK' --thinking off --json` - 。验证 JSON 报告的是 Moonshot/K2.6，并且助手转录存储了归一化后的 `usage.cost`。 + 。验证 JSON 报告的是 Moonshot / K2.6，并且助手转录中存储了标准化的 `usage.cost`。 -提示：如果你只需要一个失败用例，优先使用下文描述的 allowlist 环境变量来缩小 live 测试范围。 +提示：当你只需要一个失败用例时，优先使用下面描述的 allowlist 环境变量来缩小实时测试范围。 ## QA 专用运行器 -当你需要 QA-lab 的真实环境时，这些命令与主要测试套件并列使用： +当你需要更接近 QA-lab 的真实环境时，这些命令与主测试套件并列使用： + +CI 会在专用工作流中运行 QA Lab。`Parity gate` 会在匹配的 PR 上运行、在 `main` 上夜间运行，并支持使用 mock 提供商手动触发。`QA-Lab - Live Telegram, Live Frontier` 会在 `main` 上夜间运行，并通过 Convex 管理的实时 Telegram 凭证手动触发。`OpenClaw Release Checks` 会在发布批准前运行这两个通道。 - `pnpm openclaw qa suite` - - 直接在主机上运行由仓库支持的 QA 场景。 - - 默认并行运行多个选中的场景，并使用隔离的 Gateway 网关工作进程。`qa-channel` 默认并发数为 4（受所选场景数量限制）。使用 `--concurrency ` 调整工作进程数量，或使用 `--concurrency 1` 采用旧的串行通道。 - - 任一场景失败时以非零状态退出。当你需要产物但不希望使用失败退出码时，使用 `--allow-failures`。 + - 直接在宿主机上运行由仓库支持的 QA 场景。 + - 默认并行运行多个选定场景，并使用隔离的 Gateway 网关工作进程。`qa-channel` 默认并发数为 4（受所选场景数量限制）。使用 `--concurrency ` 调整工作进程数，或使用 `--concurrency 1` 回退到旧的串行通道。 + - 任一场景失败时以非零状态退出。若你想保留产物而不以失败状态退出，可使用 `--allow-failures`。 - 支持提供商模式 `live-frontier`、`mock-openai` 和 `aimock`。 - `aimock` 会启动一个本地的 AIMock 支持的提供商服务器，用于实验性的 fixture 和协议 mock 覆盖，而不会替代具备场景感知能力的 `mock-openai` 通道。 + `aimock` 会启动一个本地的 AIMock 支持的提供商服务器，用于实验性的 fixture 和协议 mock 覆盖，而不是替代具备场景感知能力的 `mock-openai` 通道。 - `pnpm openclaw qa suite --runner multipass` - - 在一次性的 Multipass Linux VM 中运行相同的 QA 套件。 - - 保持与主机上 `qa suite` 相同的场景选择行为。 - - 复用与 `qa suite` 相同的提供商/模型选择标志。 - - live 运行会转发对客户机实用的受支持 QA 认证输入： - 基于环境变量的提供商密钥、QA live 提供商配置路径，以及存在时的 `CODEX_HOME`。 - - 输出目录必须保留在仓库根目录下，以便客户机可以通过挂载的工作区回写内容。 - - 将常规 QA 报告 + 摘要以及 Multipass 日志写入 - `.artifacts/qa-e2e/...`。 + - 在一次性 Multipass Linux VM 内运行同一套 QA 测试。 + - 保持与宿主机上 `qa suite` 相同的场景选择行为。 + - 复用与 `qa suite` 相同的提供商 / 模型选择标志。 + - 实时运行会转发对访客机可行的受支持 QA 认证输入： + 基于环境变量的提供商密钥、QA 实时提供商配置路径，以及存在时的 `CODEX_HOME`。 + - 输出目录必须保持在仓库根目录下，这样访客机才能通过挂载的工作区写回内容。 + - 在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告 + 摘要，以及 Multipass 日志。 - `pnpm qa:lab:up` - - 启动基于 Docker 的 QA 站点，用于偏操作员风格的 QA 工作。 + - 启动 Docker 支持的 QA 站点，用于偏运维风格的 QA 工作。 - `pnpm test:docker:npm-onboard-channel-agent` - - 从当前检出构建一个 npm tarball，在 Docker 中全局安装，运行非交互式 OpenAI API 密钥新手引导，默认配置 Telegram，验证启用该插件会按需安装运行时依赖，运行 doctor，并针对一个 mock 的 OpenAI 端点执行一次本地智能体轮次。 - - 使用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 可通过 Discord 运行同一条打包安装通道。 + - 从当前 checkout 构建一个 npm tarball，在 Docker 中全局安装，运行非交互式 OpenAI API 密钥新手引导，默认配置 Telegram，验证启用插件会按需安装运行时依赖，运行 doctor，并针对 mock 的 OpenAI 端点运行一次本地智能体轮次。 + - 使用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 可在 Discord 上运行相同的打包安装通道。 - `pnpm test:docker:bundled-channel-deps` - - 在 Docker 中打包并安装当前 OpenClaw 构建，启动配置了 OpenAI 的 Gateway 网关，然后通过配置编辑启用内置渠道/插件。 - - 验证设置发现会让未配置的插件运行时依赖保持未安装状态，第一次配置后的 Gateway 网关或 doctor 运行会按需安装每个内置插件的运行时依赖，而第二次重启不会重新安装已激活的依赖。 - - 还会安装一个已知的较旧 npm 基线，在运行 `openclaw update --tag ` 之前启用 Telegram，并验证候选版本的更新后 doctor 会修复内置渠道运行时依赖，而无需测试框架侧的 postinstall 修复。 + - 在 Docker 中打包并安装当前 OpenClaw 构建，启动已配置 OpenAI 的 Gateway 网关，然后通过编辑配置启用内置渠道 / plugins。 + - 验证设置发现不会预先安装未配置插件的运行时依赖，第一次配置后的 Gateway 网关或 doctor 运行会按需安装每个内置插件的运行时依赖，而第二次重启不会重新安装已经激活的依赖。 + - 还会安装一个已知的旧版 npm 基线，在运行 `openclaw update --tag ` 之前启用 Telegram，并验证候选版本的更新后 doctor 能修复内置渠道运行时依赖，而无需测试框架侧的 postinstall 修复。 - `pnpm openclaw qa aimock` - 仅启动本地 AIMock 提供商服务器，用于直接协议冒烟测试。 - `pnpm openclaw qa matrix` - - 针对一次性的、基于 Docker 的 Tuwunel homeserver 运行 Matrix live QA 通道。 - - 这个 QA 主机目前仅用于仓库/开发。打包后的 OpenClaw 安装不会附带 - `qa-lab`，因此也不会暴露 `openclaw qa`。 - - 仓库检出会直接加载内置运行器；不需要单独的插件安装步骤。 - - 预配三个临时 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 报告、摘要、observed-events 产物以及合并后的 stdout/stderr 输出日志写入 `.artifacts/qa-e2e/...`。 + - 针对一次性 Docker 支持的 Tuwunel homeserver 运行 Matrix 实时 QA 通道。 + - 这个 QA 宿主当前仅供仓库 / 开发环境使用。打包后的 OpenClaw 安装不会附带 `qa-lab`，因此也不会暴露 `openclaw qa`。 + - 仓库 checkout 会直接加载内置运行器，无需单独安装插件。 + - 配置三个临时 Matrix 用户（`driver`、`sut`、`observer`）以及一个私有房间，然后启动一个以真实 Matrix 插件作为 SUT 传输层的 QA Gateway 网关子进程。 + - 默认使用固定稳定版 Tuwunel 镜像 `ghcr.io/matrix-construct/tuwunel:v1.5.1`。当你需要测试其他镜像时，可用 `OPENCLAW_QA_MATRIX_TUWUNEL_IMAGE` 覆盖。 + - Matrix 不暴露共享凭证来源标志，因为该通道会在本地配置一次性用户。 + - 在 `.artifacts/qa-e2e/...` 下写入 Matrix QA 报告、摘要、observed-events 产物，以及合并的 stdout / stderr 输出日志。 - `pnpm openclaw qa telegram` - - 使用环境变量中的 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 chat id。 - - 支持 `--credential-source convex` 用于共享池化凭证。默认使用 env 模式，或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用池化租约。 - - 任一场景失败时以非零状态退出。当你需要产物但不希望使用失败退出码时，使用 `--allow-failures`。 - - 需要位于同一私有群组中的两个不同 bot，并且 SUT bot 需要暴露 Telegram 用户名。 - - 为了实现稳定的 bot 到 bot 观察，请在 `@BotFather` 中为两个 bot 启用 Bot-to-Bot Communication Mode，并确保 driver bot 能够观察群组中的 bot 流量。 - - 将 Telegram QA 报告、摘要和 observed-messages 产物写入 `.artifacts/qa-e2e/...`。 + - 使用环境变量中的 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` 以启用池化租约。 + - 任一场景失败时以非零状态退出。若你想保留产物而不以失败状态退出，可使用 `--allow-failures`。 + - 需要同一私有群组中的两个不同机器人，且 SUT 机器人必须暴露 Telegram 用户名。 + - 为了稳定观察机器人之间的交互，请在 `@BotFather` 中为两个机器人都启用 Bot-to-Bot Communication Mode，并确保 driver 机器人能观察群组中的机器人流量。 + - 在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要和 observed-messages 产物。 -live 传输通道共享一套标准契约，这样新传输方式就不会发生漂移： +实时传输通道共享一个标准契约，以避免新传输方式发生漂移： -`qa-channel` 仍然是广义的合成 QA 套件，不属于 live -传输覆盖矩阵的一部分。 +`qa-channel` 仍然是广泛的合成 QA 测试套件，不属于实时传输覆盖矩阵的一部分。 -| 通道 | Canary | 提及门禁 | Allowlist 屏蔽 | 顶层回复 | 重启恢复 | 线程后续跟进 | 线程隔离 | Reaction 观察 | 帮助命令 | -| ---- | ------ | -------- | -------------- | -------- | -------- | ------------ | -------- | --------------- | -------- | -| Matrix | x | x | x | x | x | x | x | x | | -| Telegram | x | | | | | | | | x | +| 通道 | Canary | 提及门控 | allowlist 拦截 | 顶层回复 | 重启恢复 | 线程后续跟进 | 线程隔离 | 反应观察 | 帮助命令 | +| ---- | ------ | -------- | -------------- | -------- | -------- | ------------ | -------- | -------- | -------- | +| 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 项目脚手架： +参考 Convex 项目脚手架： - `qa/convex-credential-broker/` @@ -124,8 +123,8 @@ live 传输通道共享一套标准契约，这样新传输方式就不会发生 - `OPENCLAW_QA_CONVEX_SITE_URL`（例如 `https://your-deployment.convex.site`） - 为所选角色提供一个 secret： - - `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` 对应 `maintainer` - - `OPENCLAW_QA_CONVEX_SECRET_CI` 对应 `ci` + - `maintainer` 使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` + - `ci` 使用 `OPENCLAW_QA_CONVEX_SECRET_CI` - 凭证角色选择： - CLI：`--credential-role maintainer|ci` - 环境变量默认值：`OPENCLAW_QA_CREDENTIAL_ROLE`（在 CI 中默认为 `ci`，否则默认为 `maintainer`） @@ -137,15 +136,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`（可选的 trace 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`。 -面向维护者的 CLI 辅助命令： +供维护者使用的 CLI 辅助命令： ```bash pnpm openclaw qa credentials add --kind telegram --payload-file qa/telegram-credential.json @@ -153,14 +152,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`） @@ -181,57 +180,57 @@ pnpm openclaw qa credentials remove --credential-id Telegram 类型的 payload 结构： - `{ groupId: string, driverToken: string, sutToken: string }` -- `groupId` 必须是数字形式的 Telegram chat id 字符串。 -- 对于 `kind: "telegram"`，`admin/add` 会验证该结构，并拒绝格式错误的 payload。 +- `groupId` 必须是 Telegram 聊天数字 id 的字符串形式。 +- `admin/add` 会为 `kind: "telegram"` 校验该结构，并拒绝格式错误的 payload。 -### 向 QA 添加渠道 +### 向 QA 添加一个渠道 -将一个渠道添加到 markdown QA 系统中，严格只需要两样东西： +将一个渠道添加到 Markdown QA 系统中，严格只需要两样东西： 1. 该渠道的传输适配器。 -2. 一组用于执行渠道契约的场景包。 +2. 用于验证渠道契约的场景包。 -当共享的 `qa-lab` 主机可以承载流程时，不要添加新的顶级 QA 命令根。 +当共享的 `qa-lab` 宿主可以承载整个流程时，不要新增顶层 QA 命令根。 -`qa-lab` 拥有共享主机机制： +`qa-lab` 负责共享宿主机制： - `openclaw qa` 命令根 -- 套件启动与拆卸 +- 测试套件启动和清理 - 工作进程并发 - 产物写入 - 报告生成 - 场景执行 - 对旧版 `qa-channel` 场景的兼容别名 -运行器插件拥有传输契约： +运行器插件负责传输契约： -- `openclaw qa ` 如何挂载到共享 `qa` 根之下 -- 如何为该传输配置 Gateway 网关 +- `openclaw qa ` 如何挂载在共享的 `qa` 根命令之下 +- 如何为该传输方式配置 Gateway 网关 - 如何检查就绪状态 - 如何注入入站事件 - 如何观察出站消息 -- 如何暴露转录和归一化后的传输状态 -- 如何执行传输支持的操作 -- 如何处理传输专属的重置或清理 +- 如何暴露转录内容和标准化后的传输状态 +- 如何执行由传输支持的操作 +- 如何处理传输特定的重置或清理 新渠道的最低接入门槛是： -1. 保持 `qa-lab` 作为共享 `qa` 根的所有者。 -2. 在共享的 `qa-lab` 主机接缝上实现传输运行器。 -3. 将传输专属机制保留在运行器插件或渠道 harness 内部。 -4. 将运行器挂载为 `openclaw qa `，而不是注册一个相互竞争的根命令。 +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 场景。 + 保持 `runtime-api.ts` 轻量；惰性 CLI 和运行器执行应放在单独的入口点之后。 +5. 在按主题划分的 `qa/scenarios/` 目录下编写或适配 Markdown 场景。 6. 为新场景使用通用场景辅助工具。 -7. 除非仓库正在进行有意的迁移，否则要保持现有兼容别名继续可用。 +7. 保持现有兼容性别名继续可用，除非仓库正在进行有意的迁移。 决策规则是严格的： -- 如果某个行为可以在 `qa-lab` 中统一表达一次，就把它放到 `qa-lab` 中。 -- 如果某个行为依赖于单一渠道传输，就将其保留在该运行器插件或插件 harness 中。 -- 如果某个场景需要多个渠道都能使用的新能力，请添加通用辅助工具，而不是在 `suite.ts` 中加入渠道专属分支。 -- 如果某个行为只对一种传输有意义，就保持该场景为传输专属，并在场景契约中明确说明。 +- 如果某种行为可以在 `qa-lab` 中只表达一次，就把它放到 `qa-lab`。 +- 如果某种行为依赖某一个渠道传输方式，就把它保留在该运行器插件或插件 harness 中。 +- 如果某个场景需要一种多个渠道都可使用的新能力，就添加通用辅助工具，而不是在 `suite.ts` 中添加渠道特定分支。 +- 如果某种行为只对一种传输方式有意义，就保持该场景为传输特定，并在场景契约中明确说明。 新场景优先使用的通用辅助工具名称为： @@ -248,7 +247,7 @@ Telegram 类型的 payload 结构： - `formatTransportTranscript` - `resetTransport` -现有场景仍可使用兼容别名，包括： +现有场景仍可使用兼容性别名，包括： - `waitForQaChannelReady` - `waitForOutboundMessage` @@ -257,82 +256,80 @@ Telegram 类型的 payload 结构： - `resetBus` 新的渠道工作应使用通用辅助工具名称。 -兼容别名的存在是为了避免一次性切换迁移，而不是作为 -新场景编写的范式。 +兼容性别名的存在是为了避免一次性迁移日，而不是作为 +新场景编写的模型。 ## 测试套件（各自运行位置） -可以把这些套件理解为“真实性逐步提升”（同时脆弱性/成本也逐步提升）： +可以把这些测试套件理解为“真实度逐步提升”（同时不稳定性 / 成本也随之增加）： -### Unit / integration（默认） +### 单元 / 集成（默认） - 命令：`pnpm test` -- 配置：对现有按范围划分的 Vitest projects 执行十个顺序分片运行（`vitest.full-*.config.ts`） -- 文件：位于 `src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core/unit 清单，以及由 `vitest.unit.config.ts` 覆盖的白名单 `ui` node 测试 +- 配置：基于现有分域 Vitest project 的十个顺序 shard 运行（`vitest.full-*.config.ts`） +- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的核心 / 单元测试清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 - 范围： - 纯单元测试 - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） - - 针对已知 bug 的确定性回归测试 + - 已知 bug 的确定性回归测试 - 预期： - 在 CI 中运行 - 不需要真实密钥 - 应该快速且稳定 - Projects 说明： - - 未定向的 `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`），而不是一个庞大的原生 root-project 进程。这会降低高负载机器上的 RSS 峰值，并避免 auto-reply/extension 工作拖累无关套件。 - - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` project graph，因为多分片观察循环并不现实。 - - `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 路径扩展到相同的按范围划分通道；配置/设置编辑仍会回退到更广泛的 root-project 重新运行。 - - `pnpm check:changed` 是针对小范围工作的常规智能本地门禁。它会将 diff 分类为 core、core tests、extensions、extension tests、apps、docs、release metadata 和 tooling，然后运行匹配的 typecheck/lint/test 通道。公共 Plugin SDK 和插件契约变更会包含 extension 验证，因为扩展依赖这些 core 契约。仅发布元数据的版本号变更会运行定向的版本/配置/根依赖检查，而不是完整套件，并带有一个守卫，拒绝顶层版本字段之外的 package 变更。 - - 来自 agents、commands、plugins、auto-reply helpers、`plugin-sdk` 以及类似纯工具区域的轻导入 unit 测试，会通过 `unit-fast` 通道运行，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态/运行时较重的文件仍保留在现有通道中。 - - 部分 `plugin-sdk` 和 `commands` helper 源文件在 changed 模式下也会映射到这些轻量通道中的显式同级测试，因此 helper 编辑无需为该目录重新运行完整的重型套件。 - - `auto-reply` 现在有三个专用分桶：顶层 core helpers、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这使最重的 reply harness 工作不会影响廉价的 status/chunk/token 测试。 + - 未定向的 `pnpm test` 现在运行 11 个更小的 shard 配置（`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`），而不是一个巨大的原生根 project 进程。这样可减少高负载机器上的峰值 RSS，并避免 auto-reply / extension 工作拖慢无关测试套件。 + - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` project 图，因为多 shard 的 watch 循环并不现实。 + - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会优先通过分域通道路由显式文件 / 目录目标，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整根 project 启动成本。 + - 当改动只涉及可路由的源码 / 测试文件时，`pnpm test:changed` 会将变更后的 git 路径展开到同样的分域通道；配置 / setup 编辑仍会回退为更广泛的根 project 重跑。 + - `pnpm check:changed` 是窄范围工作时的常规智能本地门禁。它会把 diff 分类到 core、core tests、extensions、extension tests、apps、docs、发布元数据和工具，然后运行匹配的 typecheck / lint / test 通道。公开的插件 SDK 和 plugin 契约变更会包含 extension 验证，因为 extensions 依赖这些核心契约。仅发布元数据的版本升级会运行定向版本 / 配置 / 根依赖检查，而不是完整测试套件，并带有一个保护机制，拒绝顶层 version 字段之外的 package 变更。 + - 来自智能体、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 工作不再拖累轻量的状态 / chunk / token 测试。 - Embedded runner 说明： - - 当你更改消息工具发现输入或压缩运行时上下文时， - 保持两个层级的覆盖都存在。 - - 为纯路由/归一化边界添加聚焦的 helper 回归测试。 - - 同时保持 embedded runner 集成套件健康： + - 当你修改消息工具发现输入或压缩运行时上下文时， + 要保持两个层级的覆盖。 + - 为纯路由 / 标准化边界添加聚焦的辅助工具回归测试。 + - 同时也要保持 embedded runner 集成测试套件健康： `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` 路径；仅有 helper 测试 - 不能充分替代这些集成路径。 + - 这些测试套件会验证带作用域的 id 和压缩行为仍然会流经真实的 `run.ts` / `compact.ts` 路径；仅有辅助工具测试并不能充分替代这些集成路径。 - Pool 说明： - 基础 Vitest 配置现在默认使用 `threads`。 - - 共享 Vitest 配置还固定了 `isolate: false`，并在 root projects、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`。 -- Fast-local iteration 说明： - - `pnpm changed:lanes` 会显示某个 diff 触发了哪些架构通道。 - - pre-commit hook 会在已暂存格式化/lint 之后运行 `pnpm check:changed --staged`，因此纯 core 提交不会承担 extension 测试成本，除非它们触及对外的 extension 契约。仅发布元数据的提交会保留在定向版本/配置/根依赖通道上。 - - 如果完全相同的暂存变更集已经通过同等或更强的门禁验证，可以使用 `scripts/committer --fast "" ` 只跳过 changed-scope hook 的重复运行。暂存格式化/lint 仍会运行。在你的交接说明中提及已完成的门禁。这同样适用于隔离的 flaky hook 失败在重新运行后通过、且具备范围化证明的情况。 - - `pnpm test:changed` 会在已更改路径能够明确映射到更小套件时，通过按范围划分的通道进行路由。 - - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是有更高的 worker 上限。 - - 本地 worker 自动缩放现在有意保持保守，并且在主机负载平均值已经较高时也会回退，因此默认情况下多个并发 Vitest 运行造成的影响更小。 - - 基础 Vitest 配置将 projects/config 文件标记为 `forceRerunTriggers`，以便测试接线变更时 changed-mode 重新运行仍然正确。 - - 该配置在受支持主机上保持 `OPENCLAW_VITEST_FS_MODULE_CACHE` 启用；如果你想为直接分析指定一个显式缓存位置，请设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 + - 共享 Vitest 配置还固定了 `isolate: false`，并在根 projects、e2e 和实时配置中使用非隔离运行器。 + - 根 UI 通道保留其 `jsdom` setup 和优化器，但现在也运行在共享的非隔离运行器上。 + - 每个 `pnpm test` shard 都从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 + - 共享的 `scripts/run-vitest.mjs` 启动器现在默认还会为 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。若你需要与原生 V8 行为对比，可设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 +- Fast-local 迭代说明： + - `pnpm changed:lanes` 会显示某个 diff 会触发哪些架构通道。 + - pre-commit hook 会在 staged 格式化 / lint 之后运行 `pnpm check:changed --staged`，因此纯 core 提交不会承担 extension 测试成本，除非它们修改了面向 extension 的公开契约。仅发布元数据的提交会保持在定向版本 / 配置 / 根依赖通道。 + - 如果完全相同的 staged 变更集已经通过同等或更严格的门禁验证，可使用 `scripts/committer --fast "" ` 只跳过 changed-scope hook 的重跑。staged format / lint 仍会执行。在交接中说明已完成的门禁。这种做法在隔离的 flaky hook 失败被重新运行并基于分域证据通过后也可接受。 + - `pnpm test:changed` 会在变更路径能清晰映射到较小测试套件时通过分域通道运行。 + - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是使用更高的 worker 上限。 + - 本地 worker 自动伸缩现在有意更保守，并且在宿主负载平均值已经较高时也会回退，因此默认情况下多个并发 Vitest 运行对系统的影响更小。 + - 基础 Vitest 配置会将 projects / 配置文件标记为 `forceRerunTriggers`，以便测试接线变化时 changed 模式重跑仍然正确。 + - 该配置会在受支持的宿主上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你想为直接性能分析指定一个明确缓存位置，可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 - Perf-debug 说明： - `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 启动和转换开销写入主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下，为 unit 套件写入运行器 CPU+heap profile。 + - `pnpm test:perf:imports:changed` 会将相同的性能分析视图限定到自 `origin/main` 以来变更的文件。 +- `pnpm test:perf:changed:bench -- --ref ` 会将路由后的 `test:changed` 与该已提交 diff 的原生根 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。 ### 稳定性（Gateway 网关） - 命令：`pnpm test:stability:gateway` - 配置：`vitest.gateway.config.ts`，强制单 worker - 范围： - - 启动一个默认启用诊断的真实 loopback Gateway 网关 - - 通过诊断事件路径驱动合成的 Gateway 网关消息、memory 和大负载 churn + - 启动一个默认启用诊断功能的真实 loopback Gateway 网关 + - 通过诊断事件路径驱动合成的 Gateway 网关消息、内存和大负载抖动 - 通过 Gateway 网关 WS RPC 查询 `diagnostics.stability` - 覆盖诊断稳定性 bundle 持久化辅助工具 - - 断言记录器保持有界、合成 RSS 采样保持在压力预算之下，并且每个会话队列深度会回落到零 + - 断言记录器保持有界、合成 RSS 采样保持在压力预算内，并且每个会话的队列深度会回落到零 - 预期： - - 对 CI 安全且不需要密钥 - - 这是一个用于稳定性回归跟进的窄通道，不是完整 Gateway 网关套件的替代品 + - 对 CI 安全且无需密钥 + - 这是一个用于稳定性回归跟进的窄通道，不可替代完整的 Gateway 网关测试套件 ### E2E（Gateway 网关冒烟） @@ -340,179 +337,179 @@ Telegram 类型的 payload 结构： - 配置：`vitest.e2e.config.ts` - 文件：`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts` - 运行时默认值： - - 使用 Vitest `threads` 和 `isolate: false`，与仓库其他部分保持一致。 - - 使用自适应 workers（CI：最多 2，本地：默认 1）。 - - 默认以静默模式运行，以减少控制台 I/O 开销。 + - 使用带 `isolate: false` 的 Vitest `threads`，与仓库其余部分保持一致。 + - 使用自适应 worker（CI：最多 2 个，本地：默认 1 个）。 + - 默认以 silent 模式运行，以减少控制台 I/O 开销。 - 常用覆盖项： - - `OPENCLAW_E2E_WORKERS=` 强制指定 worker 数量（上限 16）。 + - `OPENCLAW_E2E_WORKERS=` 强制指定 worker 数量（上限为 16）。 - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 - 范围： - 多实例 Gateway 网关端到端行为 - - WebSocket/HTTP 接口、节点配对以及更重的网络交互 + - WebSocket / HTTP 表面、节点配对以及更重的网络行为 - 预期： - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 - - 比 unit 测试包含更多可变因素（可能更慢） + - 比单元测试涉及更多活动部件（可能更慢） ### E2E：OpenShell 后端冒烟 - 命令：`pnpm test:e2e:openshell` - 文件：`test/openshell-sandbox.e2e.test.ts` - 范围： - - 通过 Docker 在主机上启动一个隔离的 OpenShell Gateway 网关 + - 通过 Docker 在宿主上启动一个隔离的 OpenShell Gateway 网关 - 从临时本地 Dockerfile 创建一个沙箱 - 通过真实的 `sandbox ssh-config` + SSH exec 运行 OpenClaw 的 OpenShell 后端 - 通过沙箱 fs bridge 验证远程规范文件系统行为 - 预期： - - 仅按需启用；不属于默认的 `pnpm test:e2e` 运行 + - 仅限主动启用；不属于默认 `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 二进制文件或包装脚本 + - `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`） - 范围： - - “这个提供商/模型在 _今天_ 搭配真实凭证时是否真的可用？” - - 捕获提供商格式变更、工具调用怪癖、认证问题和速率限制行为 + - “这个提供商 / 模型在 _今天_ 搭配真实凭证时是否真的可用？” + - 捕捉提供商格式变化、工具调用怪癖、认证问题和速率限制行为 - 预期： - 按设计不具备 CI 稳定性（真实网络、真实提供商策略、配额、故障） - 会花钱 / 消耗速率限制 - - 优先运行缩小范围的子集，而不是“全部” -- live 运行会读取 `~/.profile`，以获取缺失的 API 密钥。 -- 默认情况下，live 运行仍会隔离 `HOME`，并将配置/认证材料复制到临时测试 home 中，这样 unit fixture 就不会修改你真实的 `~/.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 网关/探针心跳。 + - 优先运行缩小范围后的子集，而不是“全部都跑” +- 实时运行会读取 `~/.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 心跳。 -## 我应该运行哪套测试？ +## 我应该运行哪个测试套件？ -使用这个决策表： +使用这张决策表： -- 编辑逻辑/测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） +- 编辑逻辑 / 测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） - 修改 Gateway 网关网络 / WS 协议 / 配对：额外运行 `pnpm test:e2e` -- 调试“我的 bot 挂了” / 提供商专属故障 / 工具调用：运行缩小范围的 `pnpm test:live` +- 调试“我的机器人挂了” / 提供商特定故障 / 工具调用：运行缩小范围后的 `pnpm test:live` -## Live：Android 节点能力扫描 +## 实时：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 设置细节： [Android App](/zh-CN/platforms/android) -## Live：模型冒烟测试（profile keys） +## 实时：模型冒烟（profile keys） -live 测试分成两层，这样我们可以隔离故障： +实时测试分为两层，以便隔离故障： -- “直连模型”用于判断提供商/模型在给定密钥下是否至少能响应。 -- “Gateway 网关冒烟”用于判断该模型的完整 gateway + 智能体流水线是否正常（会话、历史、工具、沙箱策略等）。 +- “直接模型”告诉我们，给定密钥时提供商 / 模型是否至少能响应。 +- “Gateway 网关冒烟”告诉我们，该模型的完整 Gateway 网关 + 智能体管线是否工作正常（会话、历史、工具、沙箱策略等）。 -### 第 1 层：直连模型补全（无 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="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） - - modern/all 扫描默认使用精心挑选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行穷尽式 modern 扫描，或设置为正数以使用更小的上限。 -- 如何选择提供商： +- 设置 `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 的别名 + - 或者使用 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） + - modern / all 扫描默认使用精心挑选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行穷尽式 modern 扫描，或设置为正数来使用更小上限。 +- 选择提供商的方法： - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔的 allowlist） - 密钥来源： - - 默认：profile store 和环境变量回退 - - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制**仅使用 profile store** -- 这个层级存在的原因： - - 将“提供商 API 坏了 / 密钥无效”与“Gateway 网关智能体流水线坏了”区分开 - - 包含小型、隔离的回归测试（例如：OpenAI Responses/Codex Responses 推理重放 + 工具调用流程） + - 默认：profile 存储和环境变量回退 + - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制**仅使用 profile 存储** +- 该层存在的原因： + - 将“提供商 API 坏了 / 密钥无效”与“Gateway 网关智能体管线坏了”分离开来 + - 容纳小型、隔离的回归测试（示例：OpenAI Responses / Codex Responses 的推理重放 + 工具调用流程） -### 第 2 层：Gateway 网关 + dev 智能体冒烟测试（也就是 “@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` 读回。 - - 图像探针：测试会附加一个生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 + - 创建 / patch 一个 `agent:dev:*` 会话（每次运行按模型覆盖） + - 遍历带密钥的模型并断言： + - 有“有意义”的响应（无工具） + - 一个真实工具调用可用（read probe） + - 可选的额外工具 probe 可用（exec+read probe） + - OpenAI 回归路径（仅工具调用 → 后续跟进）继续工作 +- Probe 细节（便于你快速解释故障）： + - `read` probe：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 它并将 nonce 回显回来。 + - `exec+read` probe：测试会要求智能体通过 `exec` 将 nonce 写入临时文件，然后再 `read` 回来。 + - 图像 probe：测试会附加一个生成的 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） - - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是 modern allowlist 的别名 +- 选择模型的方法： + - 默认：现代 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 全都跑一遍”）： + - 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`） +- 工具 + 图像 probe 在此实时测试中始终开启： + - `read` probe + `exec+read` probe（工具压力测试） + - 当模型声明支持图像输入时，会运行图像 probe + - 流程（高层）： + - 测试会生成一个带有 “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`） + - Embedded 智能体会向模型转发一条多模态用户消息 + - 断言：回复中包含 `cat` + 该代码（OCR 容错：允许轻微错误） -提示：想查看你的机器上能测什么（以及精确的 `provider/model` id），请运行： +提示：如果你想查看你的机器上可以测什么（以及精确的 `provider/model` id），请运行： ```bash openclaw models list openclaw models list --json ``` -## Live：CLI 后端冒烟测试（Claude、Codex、Gemini 或其他本地 CLI） +## 实时：CLI 后端冒烟（Claude、Codex、Gemini 或其他本地 CLI） - 测试：`src/gateway/gateway-cli-backend.live.test.ts` -- 目标：使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线，并且不触碰你的默认配置。 -- 后端专属的冒烟测试默认值定义在所属扩展的 `cli-backend.ts` 中。 -- 启用： +- 目标：使用本地 CLI 后端验证 Gateway 网关 + 智能体管线，而不触碰你的默认配置。 +- 后端特定的冒烟默认值与所属 extension 的 `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_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 同会话连续性 probe（当所选模型支持切换目标时，设为 `1` 可强制开启）。 示例： @@ -522,13 +519,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 @@ -540,26 +537,26 @@ 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` 用户身份运行实时 CLI 后端冒烟测试。 +- 它会从所属 extension 解析 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 目前会将第三方应用使用路由到额外用量计费，而不是普通订阅计划额度，因此该订阅通道默认禁用 Claude MCP / 工具和图像 probe。 +- 实时 CLI 后端冒烟测试现在会对 Claude、Codex 和 Gemini 执行相同的端到端流程：文本轮次、图像分类轮次，然后是通过 Gateway 网关 CLI 验证的 MCP `cron` 工具调用。 +- Claude 的默认冒烟测试还会将会话从 Sonnet patch 到 Opus，并验证恢复后的会话仍然记得较早的备注。 -## Live：ACP 绑定冒烟测试（`/acp spawn ... --bind here`） +## 实时：ACP 绑定冒烟（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` -- 目标：使用一个 live ACP 智能体验证真实的 ACP 会话绑定流程： +- 目标：使用一个实时 ACP 智能体验证真实的 ACP 会话绑定流程： - 发送 `/acp spawn --bind here` - 就地绑定一个合成的消息渠道会话 - - 在同一个会话上发送一次普通的后续消息 + - 在同一会话上发送一次普通后续消息 - 验证该后续消息落入已绑定的 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` - 覆盖项： @@ -570,8 +567,8 @@ pnpm test:docker:live-cli-backend:gemini - `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND='npx -y @agentclientprotocol/claude-agent-acp@'` - `OPENCLAW_LIVE_ACP_BIND_CODEX_MODEL=gpt-5.4` - 说明： - - 这个通道使用 Gateway 网关 `chat.send` 接口，并配合仅管理员可用的合成 originating-route 字段，这样测试就能附加消息渠道上下文，而无需伪装成外部投递。 - - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会为所选 ACP harness 智能体使用内置 `acpx` 插件的内建智能体注册表。 + - 这个通道使用 Gateway 网关 `chat.send` 表面，并带有仅限管理员使用的合成 originating-route 字段，因此测试可以附加消息渠道上下文，而无需假装进行外部投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件中针对所选 ACP harness 智能体的内建智能体注册表。 示例： @@ -581,13 +578,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 @@ -598,37 +595,36 @@ 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 可用。 +- 默认情况下，它会按顺序对所有受支持的实时 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 前缀中，然后在缺失时安装所请求的实时 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 冒烟测试 +## 实时：Codex app-server harness 冒烟 - 目标：通过常规 Gateway 网关 `agent` 方法验证由插件拥有的 Codex harness： - - 加载内置的 `codex` 插件 + - 加载内置 `codex` 插件 - 选择 `OPENCLAW_AGENT_RUNTIME=codex` - - 向 `codex/gpt-5.4` 发送第一轮 Gateway 网关智能体请求 - - 向同一个 OpenClaw 会话发送第二轮请求，并验证 app-server + - 向 `codex/gpt-5.4` 发送第一轮 Gateway 网关智能体消息 + - 向同一个 OpenClaw 会话发送第二轮消息，并验证 app-server 线程可以恢复 - - 通过同一条 Gateway 网关命令 + - 通过同一个 Gateway 网关命令 路径运行 `/codex status` 和 `/codex models` - - 可选地运行两个经 Guardian 审核的提权 shell 探针：一个应被批准的无害 - 命令，以及一个应被拒绝的伪造 secret 上传， - 从而让智能体回头询问 + - 可选地运行两个经 Guardian 审核过的提权 shell probe：一个应被批准的无害 + 命令，以及一个应被拒绝的伪造 secret 上传，从而让智能体回问 - 测试：`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` -- 可选 Guardian 探针：`OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=1` +- 可选图像 probe：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` +- 可选 MCP / 工具 probe：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` +- 可选 Guardian probe：`OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=1` - 该冒烟测试会设置 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，因此损坏的 Codex - harness 不能通过静默回退到 PI 来蒙混过关。 -- 认证：来自 shell/profile 的 `OPENAI_API_KEY`，以及可选复制的 + harness 不能通过静默回退到 PI 而“假装通过”。 +- 认证：来自 shell / profile 的 `OPENAI_API_KEY`，以及可选复制的 `~/.codex/auth.json` 和 `~/.codex/config.toml` -本地配方： +本地用法： ```bash source ~/.profile @@ -640,7 +636,7 @@ OPENCLAW_LIVE_CODEX_HARNESS=1 \ pnpm test:live -- src/gateway/gateway-codex-harness.live.test.ts ``` -Docker 配方： +Docker 用法： ```bash source ~/.profile @@ -651,55 +647,54 @@ Docker 说明： - Docker 运行器位于 `scripts/test-live-codex-harness-docker.sh`。 - 它会读取挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI - 认证文件，将 `@openai/codex` 安装到可写的挂载 npm - 前缀中，暂存源代码树，然后只运行 Codex harness live 测试。 -- Docker 默认启用图像、MCP/工具和 Guardian 探针。设置 - `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 + 认证文件，把 `@openai/codex` 安装到一个可写、已挂载的 npm + 前缀中，准备源码树，然后仅运行 Codex harness 实时测试。 +- Docker 默认启用图像、MCP / 工具和 Guardian probes。需要更窄范围调试运行时， + 可设置 `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0`、 `OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=0` 或 - `OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=0`，即可在你需要更窄的调试 - 运行时关闭它们。 -- Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与 live - 测试配置保持一致，因此 `openai-codex/*` 或 PI 回退都无法掩盖 Codex harness + `OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=0`。 +- Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与实时 + 测试配置一致，因此 `openai-codex/*` 或 PI 回退无法掩盖 Codex harness 回归问题。 -### 推荐的 live 配方 +### 推荐的实时测试用法 -范围窄且显式的 allowlist 最快，也最不容易 flaky： +范围窄、显式的 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）： - - 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/...` 使用 Gemini API（API 密钥）。 - `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 会调用本地 `gemini` 二进制；它有自己的一套认证，并且行为可能不同（流式传输/工具支持/版本偏差）。 + - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；这也是大多数用户所说的 “Gemini”。 + - CLI：OpenClaw 会调用本地 `gemini` 二进制；它有自己的认证方式，而且行为可能不同（流式传输 / 工具支持 / 版本偏差）。 -## Live：模型矩阵（我们的覆盖范围） +## 实时：模型矩阵（我们覆盖哪些） -没有固定的“CI 模型列表”（live 是按需启用的），但以下是在带有密钥的开发机器上建议定期覆盖的**推荐**模型。 +没有固定的“CI 模型列表”（实时测试是选择性启用的），但以下是在开发机器上、在有密钥的情况下**建议**定期覆盖的模型。 ### 现代冒烟集合（工具调用 + 图像） -这是我们期望持续可用的“常用模型”运行： +这是我们预期应持续保持可用的“常见模型”运行集： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` - Anthropic：`anthropic/claude-opus-4-6`（或 `anthropic/claude-sonnet-4-6`） -- Google（Gemini API）：`google/gemini-3.1-pro-preview` 和 `google/gemini-3-flash-preview`（避免使用较旧的 Gemini 2.x 模型） +- Google（Gemini API）：`google/gemini-3.1-pro-preview` 和 `google/gemini-3-flash-preview`（避免旧的 Gemini 2.x 模型） - Google（Antigravity）：`google-antigravity/claude-opus-4-6-thinking` 和 `google-antigravity/gemini-3-flash` - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` @@ -717,81 +712,81 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -可选的额外覆盖（有更好，没有也行）： +可选附加覆盖（有更好，没有也行）： - xAI：`xai/grok-4`（或最新可用版本） -- Mistral：`mistral/`…（选择一个你已启用、支持 `tools` 的模型） +- Mistral：`mistral/`…（选择一个你已启用、支持 tools 的模型） - Cerebras：`cerebras/`…（如果你有访问权限） - LM Studio：`lmstudio/`…（本地；工具调用取决于 API 模式） -### Vision：图像发送（附件 → 多模态消息） +### 视觉：图像发送（附件 → 多模态消息） -在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude/Gemini/OpenAI 的视觉变体等），以执行图像探针。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude / Gemini / OpenAI 的视觉变体等），以覆盖图像 probe。 -### 聚合器 / 替代 Gateway 网关 +### 聚合器 / 其他 Gateway 网关 -如果你已启用相应密钥，我们也支持通过以下方式测试： +如果你启用了密钥，我们也支持通过以下方式测试： - OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选模型） - 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(...)` 返回的内容 + 当前可用的密钥。 ## 凭证（绝不要提交） -live 测试发现凭证的方式与 CLI 相同。实际含义如下： +实时测试发现凭证的方式与 CLI 相同。实际含义是： -- 如果 CLI 可用，live 测试应该能找到相同的密钥。 -- 如果 live 测试提示“没有凭证”，请用与调试 `openclaw models list` / 模型选择相同的方法来排查。 +- 如果 CLI 可用，实时测试通常也应能找到相同的密钥。 +- 如果实时测试提示“没有凭证”，就按你调试 `openclaw models list` / 模型选择的方式来调试。 -- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试中 “profile keys” 的含义） +- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是实时测试中 “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/`（若存在，会被复制到准备好的实时 home 中，但它不是主 profile-key 存储） +- 本地实时运行默认会把当前激活配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home 中；准备好的实时 home 会跳过 `workspace/` 和 `sandboxes/`，并移除 `agents.*.workspace` / `agentDir` 路径覆盖，从而让 probes 不会落到你真实宿主工作区上。 -如果你想依赖环境变量密钥（例如导出在你的 `~/.profile` 中），请在本地测试前运行 `source ~/.profile`，或者使用下方的 Docker 运行器（它们可以把 `~/.profile` 挂载进容器中）。 +如果你想依赖环境变量密钥（例如在你的 `~/.profile` 中导出的密钥），请在本地测试前运行 `source ~/.profile`，或者使用下面的 Docker 运行器（它们可以将 `~/.profile` 挂载到容器中）。 -## Deepgram live（音频转录） +## Deepgram 实时测试（音频转录） - 测试：`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 编码计划 live +## BytePlus 编码计划实时测试 - 测试：`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 工作流媒体 live +## ComfyUI 工作流媒体实时测试 - 测试：`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 工作流提交、轮询、下载或插件注册之后特别有用 + - 覆盖内置 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` - Harness：`pnpm test:live:media image` - 范围： - - 枚举每一个已注册的图像生成提供商插件 + - 枚举每个已注册的图像生成提供商插件 - 在探测前从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 - - 默认优先使用 live/env API key，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试 key 就不会掩盖真实的 shell 凭证 - - 跳过没有可用认证/profile/model 的提供商 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` - `google:pro-edit` - `openai:default-generate` -- 当前覆盖的内置提供商： +- 当前已覆盖的内置提供商： - `openai` - `google` - `xai` @@ -800,74 +795,74 @@ live 测试发现凭证的方式与 CLI 相同。实际含义如下： - `OPENCLAW_LIVE_IMAGE_GENERATION_MODELS="openai/gpt-image-2,google/gemini-3.1-flash-image-preview,xai/grok-imagine-image"` - `OPENCLAW_LIVE_IMAGE_GENERATION_CASES="google:flash-generate,google:pro-edit,xai:default-generate,xai:default-edit"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile store 认证，并忽略仅环境变量的覆盖 + - `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` - Harness：`pnpm test:live:media music` - 范围： - - 执行共享的内置音乐生成提供商路径 + - 覆盖共享的内置音乐生成提供商路径 - 当前覆盖 Google 和 MiniMax - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live/env API key，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试 key 就不会掩盖真实的 shell 凭证 - - 跳过没有可用认证/profile/model 的提供商 - - 在可用时运行两种已声明的运行时模式： + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 + - 在可用时运行两个已声明的运行时模式： - 使用仅提示词输入的 `generate` - 当提供商声明 `capabilities.edit.enabled` 时运行 `edit` - 当前共享通道覆盖： - `google`：`generate`、`edit` - `minimax`：`generate` - - `comfy`：单独的 Comfy live 文件，不在这个共享扫描中 + - `comfy`：使用单独的 Comfy 实时测试文件，而不是这个共享扫描 - 可选缩小范围： - `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 store 认证，并忽略仅环境变量的覆盖 + - `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` - Harness：`pnpm test:live:media video` - 范围： - - 执行共享的内置视频生成提供商路径 - - 默认使用对发布安全的冒烟路径：非 FAL 提供商、每个提供商一个文生视频请求、1 秒钟的龙虾提示词，以及来自 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 的每提供商操作上限（默认 `180000`） - - 默认跳过 FAL，因为提供商侧队列延迟可能会主导发布时间；传入 `--video-providers fal` 或 `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="fal"` 可显式运行它 + - 覆盖共享的内置视频生成提供商路径 + - 默认走对发布安全的冒烟路径：非 FAL 提供商、每个提供商一个文生视频请求、1 秒龙虾提示词，以及来自 `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` 中过期的测试 key 就不会掩盖真实的 shell 凭证 - - 跳过没有可用认证/profile/model 的提供商 - - 默认只运行 `generate` - - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 以在可用时额外运行已声明的转换模式： - - 当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商/model 在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` - - 当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商/model 在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` - - 共享扫描中当前已声明但会跳过的 `imageToVideo` 提供商： - - `vydra`，因为内置的 `veo3` 仅支持文本，而内置的 `kling` 需要远程图像 URL - - 提供商专属的 Vydra 覆盖： + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 + - 默认仅运行 `generate` + - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 还会在可用时运行已声明的转换模式： + - 当提供商声明 `capabilities.imageToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` + - 当提供商声明 `capabilities.videoToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` + - 当前在共享扫描中已声明但被跳过的 `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` live 覆盖： - - 仅 `runway`，且所选模型为 `runway/gen4_aleph` 时 - - 共享扫描中当前已声明但会跳过的 `videoToVideo` 提供商： + - 当前 `videoToVideo` 实时覆盖： + - 仅 `runway`，且仅当所选模型为 `runway/gen4_aleph` + - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商： - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享 Gemini/Veo 通道使用本地基于 buffer 的输入，而共享扫描不接受这条路径 - - `openai`，因为当前共享通道缺少针对特定组织的视频修补/混剪访问保证 + - `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 store 认证，并忽略仅环境变量的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制使用 profile 存储认证，并忽略仅环境变量覆盖 -## 媒体 live harness +## 媒体实时 harness - 命令：`pnpm test:live:media` -- 用途： - - 通过一个仓库原生入口点运行共享的图像、音乐和视频 live 套件 +- 目的： + - 通过一个仓库原生命令入口运行共享的图像、音乐和视频实时测试套件 - 自动从 `~/.profile` 加载缺失的提供商环境变量 - - 默认自动将每个套件缩小到当前拥有可用认证的提供商 + - 默认自动将每个测试套件缩小到当前具有可用认证的提供商 - 复用 `scripts/test-live.mjs`，因此心跳和安静模式行为保持一致 - 示例： - `pnpm test:live:media` @@ -879,149 +874,154 @@ live 测试发现凭证的方式与 CLI 相同。实际含义如下： 这些 Docker 运行器分为两类： -- live-model 运行器：`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`、 +- 实时模型运行器：`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`），会挂载你的本地配置目录和工作区（如果已挂载，也会读取 `~/.profile`）。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 +- Docker 实时运行器默认使用较小的冒烟上限，以便完整的 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_STEP_TIMEOUT_MS=45000` 和 `OPENCLAW_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`。当你 - 明确需要更大规模的穷尽式扫描时，可覆盖这些环境变量。 -- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次 live Docker 镜像，然后在两个 live Docker 通道中复用该镜像。它还会通过 `test:docker:e2e-build` 构建一个共享的 `scripts/e2e/Dockerfile` 镜像，并在执行已构建应用的 E2E 容器冒烟运行器中复用它。 + 明确想执行更大的穷尽式扫描时，可覆盖这些环境变量。 +- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次实时 Docker 镜像，然后在两个实时 Docker 通道中复用它。它还会通过 `test:docker:e2e-build` 构建一个共享的 `scripts/e2e/Dockerfile` 镜像，并在覆盖已构建应用的 E2E 容器冒烟运行器中复用它。 - 容器冒烟运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:npm-onboard-channel-agent`、`test:docker:gateway-network`、`test:docker:mcp-channels`、`test:docker:pi-bundle-mcp-tools`、`test:docker:cron-mcp-cleanup`、`test:docker:plugins`、`test:docker:plugin-update` 和 `test:docker:config-reload` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -live-model Docker 运行器还会只 bind-mount 所需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持的认证 home），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就可以刷新 token，而不会修改主机认证存储： +实时模型 Docker 运行器还会只 bind-mount 所需的 CLI 认证 home（如果运行未缩小范围，则会挂载所有受支持的认证 home），然后在运行前将它们复制到容器 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`） +- 直接模型：`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`） -- Open WebUI live 冒烟测试：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） +- Open WebUI 实时冒烟：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） - 新手引导向导（TTY，完整脚手架）：`pnpm test:docker:onboard`（脚本：`scripts/e2e/onboard-docker.sh`） -- Npm tarball 新手引导/渠道/智能体冒烟测试：`pnpm test:docker:npm-onboard-channel-agent` 会在 Docker 中全局安装打包后的 OpenClaw tarball，通过 env-ref 新手引导配置 OpenAI，并默认配置 Telegram，验证启用插件会按需安装其运行时依赖，运行 doctor，并运行一次 mock 的 OpenAI 智能体轮次。使用 `OPENCLAW_NPM_ONBOARD_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 可复用预构建 tarball，使用 `OPENCLAW_NPM_ONBOARD_HOST_BUILD=0` 可跳过主机构建，或使用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 切换渠道。 +- npm tarball 新手引导 / 渠道 / 智能体冒烟：`pnpm test:docker:npm-onboard-channel-agent` 会在 Docker 中全局安装打包后的 OpenClaw tarball，通过 env-ref 新手引导配置 OpenAI，默认再配置 Telegram，验证启用插件会按需安装其运行时依赖，运行 Doctor，并执行一次 mock 的 OpenAI 智能体轮次。可通过 `OPENCLAW_NPM_ONBOARD_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball，通过 `OPENCLAW_NPM_ONBOARD_HOST_BUILD=0` 跳过宿主重建，或通过 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 切换渠道。 - 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`） -- Pi bundle MCP 工具（真实 stdio MCP server + 嵌入式 Pi profile allow/deny 冒烟测试）：`pnpm test:docker:pi-bundle-mcp-tools`（脚本：`scripts/e2e/pi-bundle-mcp-tools-docker.sh`） -- Cron/subagent MCP 清理（真实 Gateway 网关 + stdio MCP 子进程在隔离的 cron 和一次性 subagent 运行后拆除）：`pnpm test:docker:cron-mcp-cleanup`（脚本：`scripts/e2e/cron-mcp-cleanup-docker.sh`） -- 插件（安装冒烟测试 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） -- 插件更新未变更冒烟测试：`pnpm test:docker:plugin-update`（脚本：`scripts/e2e/plugin-update-unchanged-docker.sh`） -- 配置热重载元数据冒烟测试：`pnpm test:docker:config-reload`（脚本：`scripts/e2e/config-reload-source-docker.sh`） -- 内置插件运行时依赖：`pnpm test:docker:bundled-channel-deps` 默认会构建一个小型 Docker 运行器镜像，在主机上构建并打包一次 OpenClaw，然后将该 tarball 挂载到每个 Linux 安装场景中。使用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 可复用镜像，使用 `OPENCLAW_BUNDLED_CHANNEL_HOST_BUILD=0` 可在本地刚完成一次新构建后跳过主机构建，或使用 `OPENCLAW_BUNDLED_CHANNEL_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 指向现有 tarball。 -- 迭代时可通过禁用无关场景来缩小内置插件运行时依赖测试范围，例如： +- MCP 渠道桥接（预置 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 冒烟）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） +- Pi 内置 MCP 工具（真实 stdio MCP 服务器 + 内置 Pi profile allow / deny 冒烟）：`pnpm test:docker:pi-bundle-mcp-tools`（脚本：`scripts/e2e/pi-bundle-mcp-tools-docker.sh`） +- Cron / subagent MCP 清理（真实 Gateway 网关 + 独立 cron 和一次性 subagent 运行后的 stdio MCP 子进程清理）：`pnpm test:docker:cron-mcp-cleanup`（脚本：`scripts/e2e/cron-mcp-cleanup-docker.sh`） +- 插件（安装冒烟 + `/plugin` 别名 + Claude-bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） +- 插件更新无变化冒烟：`pnpm test:docker:plugin-update`（脚本：`scripts/e2e/plugin-update-unchanged-docker.sh`） +- 配置重载元数据冒烟：`pnpm test:docker:config-reload`（脚本：`scripts/e2e/config-reload-source-docker.sh`） +- 内置插件运行时依赖：`pnpm test:docker:bundled-channel-deps` 默认会构建一个小型 Docker 运行器镜像，在宿主上构建并打包一次 OpenClaw，然后将该 tarball 挂载到每个 Linux 安装场景中。可通过 `OPENCLAW_SKIP_DOCKER_BUILD=1` 复用镜像，在刚完成本地构建后通过 `OPENCLAW_BUNDLED_CHANNEL_HOST_BUILD=0` 跳过宿主重建，或通过 `OPENCLAW_BUNDLED_CHANNEL_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 指向现有 tarball。 +- 在迭代时，可通过禁用无关场景来缩小内置插件运行时依赖测试范围，例如： `OPENCLAW_BUNDLED_CHANNEL_SCENARIOS=0 OPENCLAW_BUNDLED_CHANNEL_UPDATE_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_ROOT_OWNED_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_SETUP_ENTRY_SCENARIO=0 pnpm test:docker:bundled-channel-deps`。 -如果你想手动预构建并复用共享的 built-app 镜像： +如需手动预构建并复用共享的已构建应用镜像： ```bash OPENCLAW_DOCKER_E2E_IMAGE=openclaw-docker-e2e:local pnpm test:docker:e2e-build OPENCLAW_DOCKER_E2E_IMAGE=openclaw-docker-e2e:local OPENCLAW_SKIP_DOCKER_BUILD=1 pnpm test:docker:mcp-channels ``` -像 `OPENCLAW_GATEWAY_NETWORK_E2E_IMAGE` 这样的套件专属镜像覆盖项在设置后仍然优先生效。当 `OPENCLAW_SKIP_DOCKER_BUILD=1` 指向远程共享镜像时，如果本地尚不存在，该脚本会先拉取它。QR 和安装器 Docker 测试保留自己的 Dockerfile，因为它们验证的是打包/安装行为，而不是共享的 built-app 运行时。 +设置后，诸如 `OPENCLAW_GATEWAY_NETWORK_E2E_IMAGE` 之类的测试套件特定镜像覆盖仍然优先生效。当 `OPENCLAW_SKIP_DOCKER_BUILD=1` 指向远程共享镜像时，如果该镜像尚未存在于本地，脚本会先拉取它。QR 和安装器 Docker 测试保留各自独立的 Dockerfile，因为它们验证的是打包 / 安装行为，而不是共享的已构建应用运行时。 -live-model Docker 运行器还会以只读方式 bind-mount 当前检出，并将其暂存到容器内的临时工作目录中。这样既能保持运行时镜像精简，又能让 Vitest 针对你精确的本地源代码/配置运行。 -暂存步骤会跳过大型的本地专用缓存和应用构建输出，例如 -`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地的 `.build` 或 -Gradle 输出目录，因此 Docker live 运行不会花上数分钟去复制 -机器专属产物。 -它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关 live 探针就不会在 -容器内启动真实的 Telegram/Discord 等渠道工作进程。 -`test:docker:live-models` 仍然会运行 `pnpm test:live`，因此当你需要在该 Docker 通道中缩小范围或排除 Gateway 网关 live 覆盖时，也要一并传入 +实时模型 Docker 运行器还会以只读方式 bind-mount 当前 checkout， +并将其准备到容器内的临时工作目录中。这样可以保持运行时 +镜像轻量，同时仍然对你本地的精确源码 / 配置运行 Vitest。 +准备步骤会跳过大型仅本地缓存和应用构建输出，例如 +`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地 `.build` 或 +Gradle 输出目录，因此 Docker 实时运行不会花几分钟去复制 +机器特定的产物。 +它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关实时 probes 就不会在 +容器中启动真实的 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 也可能需要完成自己的冷启动设置。 -这个通道需要一个可用的 live 模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认 `~/.profile`）是在 Docker 化运行中提供该密钥的主要方式。 -成功运行后会打印一个小型 JSON 负载，类似 `{ "ok": true, "model": +针对该 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 负载，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 是有意设计为确定性的，不需要 -真实的 Telegram、Discord 或 iMessage 账号。它会启动一个带种子的 Gateway -网关容器，启动第二个生成 `openclaw mcp serve` 的容器，然后 -验证经路由的会话发现、转录读取、附件元数据、 -live 事件队列行为、出站发送路由，以及通过真实 stdio MCP bridge 发送的 Claude 风格渠道 + -权限通知。通知检查会直接检查原始 stdio MCP frame，因此这个冒烟测试验证的是 bridge 实际发出的内容，而不只是某个特定客户端 SDK 恰好暴露的内容。 -`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要 live +`test:docker:mcp-channels` 是刻意设计为确定性的，不需要真实的 +Telegram、Discord 或 iMessage 账号。它会启动一个带预置数据的 Gateway 网关 +容器，启动第二个生成 `openclaw mcp serve` 的容器，然后 +通过真实的 stdio MCP bridge 验证已路由会话发现、转录读取、附件元数据、 +实时事件队列行为、出站发送路由，以及 Claude 风格的渠道 + +权限通知。通知检查会直接检查原始 stdio MCP 帧，因此该冒烟测试验证的是 +bridge 实际发出的内容，而不仅仅是某个特定客户端 SDK 恰好暴露出来的内容。 +`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要实时 模型密钥。它会构建仓库 Docker 镜像，在容器内启动一个真实的 stdio MCP 探测服务器， -通过嵌入式 Pi bundle MCP 运行时实例化该服务器， -执行该工具，然后验证 `coding` 和 `messaging` 会保留 +通过内置 Pi bundle MCP 运行时将该服务器实例化， +执行工具，然后验证 `coding` 和 `messaging` 会保留 `bundle-mcp` 工具，而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会将其过滤掉。 -`test:docker:cron-mcp-cleanup` 是确定性的，不需要 live 模型 -密钥。它会启动一个带有真实 stdio MCP 探测服务器的种子 Gateway 网关，运行一个隔离的 cron 轮次和一个 `/subagents spawn` 一次性子智能体轮次，然后验证 +`test:docker:cron-mcp-cleanup` 是确定性的，不需要实时模型 +密钥。它会启动一个带真实 stdio MCP 探测服务器的预置 Gateway 网关， +运行一个隔离的 cron 轮次和一个 `/subagents spawn` 一次性子智能体轮次，然后验证 MCP 子进程会在每次运行后退出。 -手动 ACP 通俗语言线程冒烟测试（不在 CI 中运行）： +手动 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_PROFILE_ENV_ONLY=1` 用于只验证从 `OPENCLAW_PROFILE_FILE` 读取的环境变量，使用临时配置/工作区目录，并且不挂载外部 CLI 认证 -- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于 Docker 内部缓存的 CLI 安装 -- 位于 `$HOME` 下的外部 CLI 认证目录/文件会以只读方式挂载到 `/host-auth...` 下，然后在测试开始前复制到 `/home/node/...` +- `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_PROFILE_ENV_ONLY=1` 用于仅验证从 `OPENCLAW_PROFILE_FILE` 读取的环境变量，使用临时配置 / 工作区目录，且不挂载外部 CLI 认证 +- `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 store（而不是环境变量） -- `OPENCLAW_OPENWEBUI_MODEL=...` 用于选择 Gateway 网关为 Open WebUI 冒烟测试暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试使用的 nonce 检查提示词 +- `OPENCLAW_SKIP_DOCKER_BUILD=1` 用于复用现有 `openclaw:local-live` 镜像，以便在无需重建时重新运行 +- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 用于确保凭证来自 profile 存储（而不是 env） +- `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`。 +修改文档后运行文档检查：`pnpm check:docs`。 +当你还需要检查页内标题锚点时，运行完整的 Mintlify 锚点校验：`pnpm docs:check-links:anchors`。 -## 离线回归测试（对 CI 安全） +## 离线回归（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`）。 -- 验证会话接线和配置效果的端到端向导流程（`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` 并遵循要求的步骤/参数？ -- **工作流契约：** 断言工具顺序、会话历史延续和沙箱边界的多轮场景。 +- **决策能力：** 当 prompt 中列出了 Skills 时，智能体是否会选择正确的 Skills（或避开无关项）？ +- **合规性：** 智能体在使用前是否会读取 `SKILL.md`，并遵循要求的步骤 / 参数？ +- **工作流契约：** 用于断言工具顺序、会话历史延续和沙箱边界的多轮场景。 未来的评估应优先保持确定性： - 一个使用 mock 提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话接线。 -- 一小套聚焦于 skill 的场景（使用 vs 避免、门禁、提示注入）。 -- 只有在对 CI 安全的套件就位后，才添加可选的 live 评估（按需启用、由环境变量控制）。 +- 一小套聚焦 Skills 的场景（使用与避免、门控、prompt 注入）。 +- 只有在 CI 安全测试套件到位之后，才添加可选的实时评估（选择加入、通过 env 控制）。 ## 契约测试（插件和渠道形状） -契约测试用于验证每个已注册的插件和渠道都符合其 -接口契约。它们会遍历所有已发现的插件，并运行一组形状和行为断言。默认的 `pnpm test` unit 通道会有意 -跳过这些共享接缝和冒烟文件；当你修改共享渠道或提供商接口时， -请显式运行契约命令。 +契约测试用于验证每个已注册插件和渠道都符合其 +接口契约。它们会遍历所有已发现的插件，并运行一组 +关于形状和行为的断言。默认的 `pnpm test` 单元通道会有意 +跳过这些共享接缝和冒烟文件；当你修改共享渠道或提供商表面时， +请显式运行这些契约命令。 ### 命令 -- 全部契约：`pnpm test:contracts` +- 所有契约：`pnpm test:contracts` - 仅渠道契约：`pnpm test:contracts:channels` - 仅提供商契约：`pnpm test:contracts:plugins` @@ -1034,16 +1034,16 @@ MCP 子进程会在每次运行后退出。 - **session-binding** - 会话绑定行为 - **outbound-payload** - 消息负载结构 - **inbound** - 入站消息处理 -- **actions** - 渠道操作处理器 +- **actions** - 渠道动作处理器 - **threading** - 线程 ID 处理 -- **directory** - 目录/成员列表 API -- **group-policy** - 群组策略强制执行 +- **directory** - 目录 / roster API +- **group-policy** - 群组策略执行 ### 提供商状态契约 位于 `src/plugins/contracts/*.contract.test.ts`。 -- **status** - 渠道状态探针 +- **status** - 渠道状态探测 - **registry** - 插件注册表形状 ### 提供商契约 @@ -1051,31 +1051,31 @@ MCP 子进程会在每次运行后退出。 位于 `src/plugins/contracts/*.contract.test.ts`： - **auth** - 认证流程契约 -- **auth-choice** - 认证选择/选择逻辑 +- **auth-choice** - 认证选择 / 选取 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 - **runtime** - 提供商运行时 -- **shape** - 插件形状/接口 +- **shape** - 插件形状 / 接口 - **wizard** - 设置向导 ### 何时运行 -- 修改 plugin-sdk 导出或子路径之后 -- 添加或修改渠道或提供商插件之后 -- 重构插件注册或发现逻辑之后 +- 在修改插件 SDK 导出或子路径之后 +- 在添加或修改渠道或提供商插件之后 +- 在重构插件注册或发现机制之后 -契约测试会在 CI 中运行，不需要真实 API key。 +契约测试会在 CI 中运行，并且不需要真实 API 密钥。 -## 添加回归测试（指导） +## 添加回归测试（指南） -当你修复一个在 live 中发现的提供商/模型问题时： +当你修复了一个在实时测试中发现的提供商 / 模型问题时： -- 如果可能，添加一个对 CI 安全的回归测试（mock/stub 提供商，或捕获精确的请求形状转换） -- 如果它天然只能在 live 中复现（速率限制、认证策略），就保持 live 测试范围窄，并通过环境变量按需启用 -- 优先瞄准能捕获该 bug 的最小层级： - - 提供商请求转换/重放 bug → 直连模型测试 - - Gateway 网关会话/历史/工具流水线 bug → Gateway 网关 live 冒烟测试或对 CI 安全的 gateway mock 测试 +- 如果可能，添加一个 CI 安全的回归测试（mock / stub 提供商，或捕获精确的请求形状转换） +- 如果它本质上只能是实时问题（速率限制、认证策略），就让实时测试保持范围窄，并通过环境变量选择启用 +- 优先选择能捕获该 bug 的最小层级： + - 提供商请求转换 / 重放 bug → 直接模型测试 + - Gateway 网关会话 / 历史 / 工具管线 bug → 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`。这个测试会在出现未分类 target id 时故意失败，这样新类别就无法被静默跳过。 + - `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 5e739f7a8..d780174ed 100644 --- a/docs/zh-CN/plugins/manifest.md +++ b/docs/zh-CN/plugins/manifest.md @@ -1,14 +1,14 @@ --- read_when: - 你正在构建一个 OpenClaw 插件 - - 你需要提供插件配置 schema，或调试插件校验错误 + - 你需要交付一个插件配置 schema，或调试插件校验错误 summary: 插件清单 + JSON schema 要求（严格配置校验） title: 插件清单 x-i18n: - generated_at: "2026-04-22T07:00:33Z" + generated_at: "2026-04-23T05:14:53Z" model: gpt-5.4 provider: openai - source_hash: 085c1baccb96b8e6bd4033ad11bdd5f79bdb0daec470e977fce723c3ae38cc99 + source_hash: 4da8ce35aca4c12bf49a4c3e352fb7fc2b5768cb34157a00dabd247fe60b4f04 source_path: plugins/manifest.md workflow: 15 --- @@ -17,40 +17,40 @@ x-i18n: 本页仅适用于**原生 OpenClaw 插件清单**。 -如需了解兼容的 bundle 布局，请参阅 [插件 bundles](/zh-CN/plugins/bundles)。 +关于兼容的 bundle 布局，请参见 [插件 bundle](/zh-CN/plugins/bundles)。 兼容的 bundle 格式使用不同的清单文件： - Codex bundle：`.codex-plugin/plugin.json` -- Claude bundle：`.claude-plugin/plugin.json`，或不带清单的默认 Claude 组件布局 +- Claude bundle：`.claude-plugin/plugin.json` 或不带清单的默认 Claude 组件布局 - Cursor bundle：`.cursor-plugin/plugin.json` -OpenClaw 也会自动检测这些 bundle 布局，但它们不会根据此处介绍的 `openclaw.plugin.json` schema 进行校验。 +OpenClaw 也会自动检测这些 bundle 布局，但不会根据这里描述的 `openclaw.plugin.json` schema 对它们进行校验。 -对于兼容 bundle，如果其布局符合 OpenClaw 运行时预期，OpenClaw 当前会读取 bundle 元数据，以及声明的 skill 根目录、Claude 命令根目录、Claude bundle 的 `settings.json` 默认值、Claude bundle 的 LSP 默认值，以及受支持的 hook packs。 +对于兼容 bundle，当其布局符合 OpenClaw 运行时预期时，OpenClaw 当前会读取 bundle 元数据、已声明的 skill 根目录、Claude 命令根目录、Claude bundle 的 `settings.json` 默认值、Claude bundle 的 LSP 默认值，以及受支持的 hook pack。 -每个原生 OpenClaw 插件**必须**在**插件根目录**中提供一个 `openclaw.plugin.json` 文件。OpenClaw 使用此清单在**不执行插件代码**的情况下校验配置。缺失或无效的清单会被视为插件错误，并阻止配置校验。 +每个原生 OpenClaw 插件都**必须**在**插件根目录**中提供一个 `openclaw.plugin.json` 文件。OpenClaw 使用这个清单在**不执行插件代码**的情况下校验配置。缺失或无效的清单会被视为插件错误，并阻止配置校验。 -完整的插件系统指南请参阅：[插件](/zh-CN/tools/plugin)。 -如需了解原生能力模型及当前外部兼容性指南，请参阅： +参见完整的插件系统指南：[插件](/zh-CN/tools/plugin)。 +关于原生能力模型和当前外部兼容性指引，请参见： [能力模型](/zh-CN/plugins/architecture#public-capability-model)。 ## 此文件的作用 `openclaw.plugin.json` 是 OpenClaw 在加载你的插件代码之前读取的元数据。 -将它用于： +用途包括： - 插件标识 - 配置校验 -- 无需启动插件运行时即可获取的认证与新手引导元数据 -- 控制平面界面可在运行时加载前检查的轻量激活提示 -- 设置 / 新手引导界面可在运行时加载前检查的轻量设置描述符 -- 应在插件运行时加载前解析的别名与自动启用元数据 -- 应在插件运行时加载前自动激活插件的简写模型家族归属元数据 -- 用于内置兼容接线与契约覆盖的静态能力归属快照 -- 共享 `openclaw qa` 主机可在插件运行时加载前检查的轻量 QA 运行器元数据 -- 应合并到目录与校验界面、且无需加载运行时的渠道专属配置元数据 +- 无需启动插件运行时即可获取的认证和新手引导元数据 +- 可供控制平面界面在运行时加载前检查的低成本激活提示 +- 可供设置 / 新手引导界面在运行时加载前检查的低成本设置描述符 +- 应在插件运行时加载前解析的别名和自动启用元数据 +- 应在运行时加载前自动激活插件的简写模型族归属元数据 +- 用于内置兼容性接线和契约覆盖的静态能力归属快照 +- 共享 `openclaw qa` 主机可在插件运行时加载前检查的低成本 QA 运行器元数据 +- 应在不加载运行时的情况下合并到目录和校验界面中的渠道特定配置元数据 - 配置 UI 提示 不要将它用于： @@ -59,7 +59,7 @@ OpenClaw 也会自动检测这些 bundle 布局，但它们不会根据此处介 - 声明代码入口点 - npm 安装元数据 -这些应放在你的插件代码和 `package.json` 中。 +这些内容应放在你的插件代码和 `package.json` 中。 ## 最小示例 @@ -142,29 +142,29 @@ OpenClaw 也会自动检测这些 bundle 布局，但它们不会根据此处介 | 字段 | 必填 | 类型 | 含义 | | ------------------------------------ | -------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | 是 | `string` | 规范插件 id。这是 `plugins.entries.` 中使用的 id。 | -| `configSchema` | 是 | `object` | 该插件配置的内联 JSON Schema。 | -| `enabledByDefault` | 否 | `true` | 将内置插件标记为默认启用。省略该字段，或将其设为任何非 `true` 的值，可使插件默认保持禁用。 | -| `legacyPluginIds` | 否 | `string[]` | 会规范化到该规范插件 id 的旧版 id。 | -| `autoEnableWhenConfiguredProviders` | 否 | `string[]` | 当认证、配置或模型引用提到这些提供商 id 时，应自动启用此插件。 | -| `kind` | 否 | `"memory"` \| `"context-engine"` | 声明用于 `plugins.slots.*` 的互斥插件类型。 | -| `channels` | 否 | `string[]` | 此插件拥有的渠道 id。用于设备发现和配置校验。 | -| `providers` | 否 | `string[]` | 此插件拥有的提供商 id。 | -| `modelSupport` | 否 | `object` | 由清单持有的简写模型家族元数据，用于在运行时之前自动加载插件。 | -| `providerEndpoints` | 否 | `object[]` | 由清单持有的端点主机 / `baseUrl` 元数据，用于 core 在提供商运行时加载前对提供商路由进行分类。 | -| `cliBackends` | 否 | `string[]` | 此插件拥有的 CLI 推理后端 id。用于根据显式配置引用在启动时自动激活。 | -| `syntheticAuthRefs` | 否 | `string[]` | 提供商或 CLI 后端引用；在运行时加载前的冷启动模型发现期间，应探测其由插件持有的 synthetic auth hook。 | -| `nonSecretAuthMarkers` | 否 | `string[]` | 由内置插件持有的占位 API key 值，表示非机密的本地、OAuth 或环境凭证状态。 | -| `commandAliases` | 否 | `object[]` | 此插件拥有的命令名称；在运行时加载前，它们应生成带有插件感知的配置和 CLI 诊断信息。 | -| `providerAuthEnvVars` | 否 | `Record` | OpenClaw 无需加载插件代码即可检查的轻量提供商认证环境变量元数据。 | -| `providerAuthAliases` | 否 | `Record` | 应复用另一个提供商 id 进行认证查找的提供商 id，例如与基础提供商 API key 和认证配置文件共享的 coding 提供商。 | -| `channelEnvVars` | 否 | `Record` | OpenClaw 无需加载插件代码即可检查的轻量渠道环境变量元数据。将其用于由环境变量驱动的渠道设置或认证界面，以便通用启动 / 配置辅助工具能够识别。 | -| `providerAuthChoices` | 否 | `object[]` | 用于新手引导选择器、首选提供商解析和简单 CLI 标志接线的轻量认证选择元数据。 | -| `activation` | 否 | `object` | 面向提供商、命令、渠道、路由和能力触发加载的轻量激活提示。仅为元数据；实际行为仍由插件运行时负责。 | -| `setup` | 否 | `object` | 设备发现和设置界面可在不加载插件运行时的情况下检查的轻量设置 / 新手引导描述符。 | -| `qaRunners` | 否 | `object[]` | 共享 `openclaw qa` 主机在插件运行时加载前使用的轻量 QA 运行器描述符。 | -| `contracts` | 否 | `object` | 用于语音、实时转录、实时语音、媒体理解、图像生成、音乐生成、视频生成、网页抓取、网页搜索和工具归属的静态内置能力快照。 | -| `mediaUnderstandingProviderMetadata` | 否 | `Record` | 为 `contracts.mediaUnderstandingProviders` 中声明的提供商 id 提供的轻量媒体理解默认值。 | -| `channelConfigs` | 否 | `Record` | 由清单持有的渠道配置元数据，在运行时加载前合并到设备发现和校验界面中。 | +| `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` | 由清单拥有的简写模型族元数据，用于在运行时之前自动加载插件。 | +| `providerEndpoints` | 否 | `object[]` | 由清单拥有的 endpoint host/baseUrl 元数据，用于核心层在 provider 运行时加载前对 provider 路由进行分类。 | +| `cliBackends` | 否 | `string[]` | 由此插件拥有的 CLI 推理后端 id。用于根据显式配置引用在启动时自动激活。 | +| `syntheticAuthRefs` | 否 | `string[]` | 在运行时加载前的冷启动模型发现期间，应探测其插件自有 synthetic auth hook 的 provider 或 CLI backend 引用。 | +| `nonSecretAuthMarkers` | 否 | `string[]` | 由内置插件拥有的占位 API key 值，用于表示非秘密的本地、OAuth 或环境凭证状态。 | +| `commandAliases` | 否 | `object[]` | 由此插件拥有的命令名称，这些命令应在运行时加载前生成具备插件感知能力的配置和 CLI 诊断信息。 | +| `providerAuthEnvVars` | 否 | `Record` | OpenClaw 可在不加载插件代码的情况下检查的低成本 provider 认证环境变量元数据。 | +| `providerAuthAliases` | 否 | `Record` | 应复用另一个 provider id 进行认证查找的 provider id，例如与基础 provider API key 和认证配置文件共享的 coding provider。 | +| `channelEnvVars` | 否 | `Record` | OpenClaw 可在不加载插件代码的情况下检查的低成本渠道环境变量元数据。将其用于通用启动 / 配置辅助程序需要识别的、由环境变量驱动的渠道设置或认证界面。 | +| `providerAuthChoices` | 否 | `object[]` | 用于新手引导选择器、首选 provider 解析和简单 CLI 标志接线的低成本认证选项元数据。 | +| `activation` | 否 | `object` | 用于 provider、命令、渠道、路由和由能力触发的加载的低成本激活提示。仅为元数据；插件运行时仍拥有实际行为。 | +| `setup` | 否 | `object` | 发现和设置界面可在不加载插件运行时的情况下检查的低成本设置 / 新手引导描述符。 | +| `qaRunners` | 否 | `object[]` | 共享 `openclaw qa` 主机在插件运行时加载前使用的低成本 QA 运行器描述符。 | +| `contracts` | 否 | `object` | 适用于 speech、realtime transcription、realtime voice、media-understanding、image-generation、music-generation、video-generation、web-fetch、web search 和工具归属的静态内置能力快照。 | +| `mediaUnderstandingProviderMetadata` | 否 | `Record` | 为 `contracts.mediaUnderstandingProviders` 中声明的 provider id 提供的低成本 media-understanding 默认元数据。 | +| `channelConfigs` | 否 | `Record` | 由清单拥有的渠道配置元数据，会在运行时加载前合并到发现和校验界面中。 | | `skills` | 否 | `string[]` | 要加载的 Skills 目录，相对于插件根目录。 | | `name` | 否 | `string` | 人类可读的插件名称。 | | `description` | 否 | `string` | 显示在插件界面中的简短摘要。 | @@ -174,30 +174,30 @@ OpenClaw 也会自动检测这些 bundle 布局，但它们不会根据此处介 ## `providerAuthChoices` 参考 每个 `providerAuthChoices` 条目描述一个新手引导或认证选项。 -OpenClaw 会在提供商运行时加载之前读取这些内容。 +OpenClaw 会在 provider 运行时加载前读取这些内容。 | 字段 | 必填 | 类型 | 含义 | | --------------------- | -------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `provider` | 是 | `string` | 此选项所属的提供商 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。 | +| `provider` | 是 | `string` | 此选项所属的 provider id。 | +| `method` | 是 | `string` | 要分发到的认证方法 id。 | +| `choiceId` | 是 | `string` | 供新手引导和 CLI 流程使用的稳定 auth-choice 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"]`。 | +| `cliDescription` | 否 | `string` | 用于 CLI 帮助的说明。 | +| `onboardingScopes` | 否 | `Array<"text-inference" \| "image-generation">` | 此选项应显示在哪些新手引导界面中。如省略，默认值为 `["text-inference"]`。 | ## `commandAliases` 参考 -当插件拥有某个运行时命令名称，而用户可能错误地将它放入 `plugins.allow` 中，或尝试将其作为根级 CLI 命令运行时，请使用 `commandAliases`。OpenClaw 使用这些元数据生成诊断信息，而无需导入插件运行时代码。 +当插件拥有某个运行时命令名称，而用户可能误将其放入 `plugins.allow`，或尝试将其作为根级 CLI 命令运行时，请使用 `commandAliases`。OpenClaw 使用此元数据提供诊断信息，而无需导入插件运行时代码。 ```json { @@ -215,15 +215,15 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 | ------------ | -------- | ----------------- | ----------------------------------------------------------------------- | | `name` | 是 | `string` | 属于此插件的命令名称。 | | `kind` | 否 | `"runtime-slash"` | 将该别名标记为聊天斜杠命令，而不是根级 CLI 命令。 | -| `cliCommand` | 否 | `string` | 若存在，用于 CLI 操作时建议的相关根级 CLI 命令。 | +| `cliCommand` | 否 | `string` | 若存在相关的根级 CLI 命令，则建议用于 CLI 操作。 | ## `activation` 参考 -当插件可以低成本声明哪些控制平面事件应在之后激活它时，请使用 `activation`。 +当插件可以以低成本声明哪些控制平面事件应在之后激活它时，请使用 `activation`。 ## `qaRunners` 参考 -当插件在共享 `openclaw qa` 根命令下贡献一个或多个传输运行器时，请使用 `qaRunners`。请保持这些元数据轻量且静态；实际的 CLI 注册仍由插件运行时通过导出 `qaRunnerCliRegistrations` 的轻量 `runtime-api.ts` 接口负责。 +当插件向共享的 `openclaw qa` 根命令下贡献一个或多个传输运行器时，请使用 `qaRunners`。请将此元数据保持为低成本且静态；插件运行时仍通过导出 `qaRunnerCliRegistrations` 的轻量 `runtime-api.ts` 接口拥有实际的 CLI 注册逻辑。 ```json { @@ -238,10 +238,11 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 | 字段 | 必填 | 类型 | 含义 | | ------------- | -------- | -------- | ------------------------------------------------------------------ | -| `commandName` | 是 | `string` | 挂载在 `openclaw qa` 下的子命令，例如 `matrix`。 | -| `description` | 否 | `string` | 当共享主机需要一个 stub 命令时使用的回退帮助文本。 | +| `commandName` | 是 | `string` | 挂载在 `openclaw qa` 之下的子命令，例如 `matrix`。 | +| `description` | 否 | `string` | 当共享主机需要一个存根命令时使用的回退帮助文本。 | -此区块仅为元数据。它不会注册运行时行为，也不会替代 `register(...)`、`setupEntry` 或其他运行时 / 插件入口点。当前使用方会在更广泛的插件加载前将其用作缩小范围的提示，因此缺少激活元数据通常只会带来性能成本；在旧版清单归属回退机制仍存在时，它不应改变正确性。 +此区块仅为元数据。它不会注册运行时行为，也不会替代 `register(...)`、`setupEntry` 或其他运行时 / 插件入口点。 +当前使用方将其作为在更广泛插件加载之前进行范围收窄的提示，因此缺少激活元数据通常只会带来性能损失；在旧版清单归属回退机制仍存在的情况下，它不应改变正确性。 ```json { @@ -257,21 +258,21 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 | 字段 | 必填 | 类型 | 含义 | | ---------------- | -------- | ---------------------------------------------------- | ----------------------------------------------------------------- | -| `onProviders` | 否 | `string[]` | 请求这些提供商 id 时，应激活此插件。 | +| `onProviders` | 否 | `string[]` | 请求这些 provider id 时应激活此插件。 | | `onCommands` | 否 | `string[]` | 应激活此插件的命令 id。 | | `onChannels` | 否 | `string[]` | 应激活此插件的渠道 id。 | | `onRoutes` | 否 | `string[]` | 应激活此插件的路由类型。 | -| `onCapabilities` | 否 | `Array<"provider" \| "channel" \| "tool" \| "hook">` | 控制平面激活规划所用的宽泛能力提示。 | +| `onCapabilities` | 否 | `Array<"provider" \| "channel" \| "tool" \| "hook">` | 供控制平面激活规划使用的广义能力提示。 | 当前在线使用方： - 由命令触发的 CLI 规划会回退到旧版 `commandAliases[].cliCommand` 或 `commandAliases[].name` - 当缺少显式渠道激活元数据时，渠道触发的设置 / 渠道规划会回退到旧版 `channels[]` 归属 -- 当缺少显式提供商激活元数据时，提供商触发的设置 / 运行时规划会回退到旧版 `providers[]` 和顶层 `cliBackends[]` 归属 +- 当缺少显式 provider 激活元数据时，由 provider 触发的设置 / 运行时规划会回退到旧版 `providers[]` 和顶层 `cliBackends[]` 归属 ## `setup` 参考 -当设置和新手引导界面需要在运行时加载前获取由插件持有的轻量元数据时，请使用 `setup`。 +当设置和新手引导界面需要在运行时加载前获取低成本的插件自有元数据时，请使用 `setup`。 ```json { @@ -290,32 +291,32 @@ 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` 参考 | 字段 | 必填 | 类型 | 含义 | | ------------- | -------- | ---------- | ------------------------------------------------------------------------------------ | -| `id` | 是 | `string` | 在设置或新手引导期间公开的提供商 id。请保持规范化 id 在全局范围内唯一。 | -| `authMethods` | 否 | `string[]` | 此提供商在无需加载完整运行时的情况下支持的设置 / 认证方式 id。 | +| `id` | 是 | `string` | 在设置或新手引导期间暴露的 provider id。请保持规范化 id 在全局唯一。 | +| `authMethods` | 否 | `string[]` | 此 provider 在不加载完整运行时的情况下支持的设置 / 认证方法 id。 | | `envVars` | 否 | `string[]` | 通用设置 / 状态界面可在插件运行时加载前检查的环境变量。 | ### `setup` 字段 | 字段 | 必填 | 类型 | 含义 | | ------------------ | -------- | ---------- | --------------------------------------------------------------------------------------------------- | -| `providers` | 否 | `object[]` | 在设置和新手引导期间公开的提供商设置描述符。 | -| `cliBackends` | 否 | `string[]` | 用于“描述符优先”设置查找的设置期后端 id。请保持规范化 id 在全局范围内唯一。 | -| `configMigrations` | 否 | `string[]` | 由该插件设置界面持有的配置迁移 id。 | -| `requiresRuntime` | 否 | `boolean` | 在描述符查找之后，设置是否仍需要执行 `setup-api`。 | +| `providers` | 否 | `object[]` | 在设置和新手引导期间暴露的 provider 设置描述符。 | +| `cliBackends` | 否 | `string[]` | 用于“描述符优先”设置查找的设置期后端 id。请保持规范化 id 在全局唯一。 | +| `configMigrations` | 否 | `string[]` | 由此插件设置界面拥有的配置迁移 id。 | +| `requiresRuntime` | 否 | `boolean` | 描述符查找之后，设置是否仍需要执行 `setup-api`。 | ## `uiHints` 参考 -`uiHints` 是一个从配置字段名映射到小型渲染提示的映射表。 +`uiHints` 是一个从配置字段名称映射到小型渲染提示的映射表。 ```json { @@ -337,13 +338,13 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 | `label` | `string` | 面向用户的字段标签。 | | `help` | `string` | 简短辅助文本。 | | `tags` | `string[]` | 可选的 UI 标签。 | -| `advanced` | `boolean` | 将该字段标记为高级选项。 | -| `sensitive` | `boolean` | 将该字段标记为机密或敏感。 | +| `advanced` | `boolean` | 将该字段标记为高级项。 | +| `sensitive` | `boolean` | 将该字段标记为秘密或敏感信息。 | | `placeholder` | `string` | 表单输入的占位文本。 | ## `contracts` 参考 -仅在 OpenClaw 无需导入插件运行时即可读取的静态能力归属元数据场景中使用 `contracts`。 +仅在 OpenClaw 可以不导入插件运行时就读取的静态能力归属元数据场景下使用 `contracts`。 ```json { @@ -367,19 +368,19 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 | 字段 | 类型 | 含义 | | -------------------------------- | ---------- | ----------------------------------------------------------------- | | `embeddedExtensionFactories` | `string[]` | 内置插件可为其注册工厂的嵌入式运行时 id。 | -| `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[]` | 在内置契约检查中，此插件拥有的智能体工具名称。 | +| `speechProviders` | `string[]` | 此插件拥有的 speech provider id。 | +| `realtimeTranscriptionProviders` | `string[]` | 此插件拥有的 realtime-transcription provider id。 | +| `realtimeVoiceProviders` | `string[]` | 此插件拥有的 realtime-voice provider id。 | +| `mediaUnderstandingProviders` | `string[]` | 此插件拥有的 media-understanding provider id。 | +| `imageGenerationProviders` | `string[]` | 此插件拥有的 image-generation provider id。 | +| `videoGenerationProviders` | `string[]` | 此插件拥有的 video-generation provider id。 | +| `webFetchProviders` | `string[]` | 此插件拥有的 web-fetch provider id。 | +| `webSearchProviders` | `string[]` | 此插件拥有的 web-search provider id。 | +| `tools` | `string[]` | 此插件拥有的智能体工具名称，用于内置契约检查。 | ## `mediaUnderstandingProviderMetadata` 参考 -当媒体理解提供商具有默认模型、自动认证回退优先级，或 generic core 辅助工具在运行时加载前所需的原生文档支持时，请使用 `mediaUnderstandingProviderMetadata`。键名也必须在 `contracts.mediaUnderstandingProviders` 中声明。 +当某个 media-understanding provider 具有默认模型、自动认证回退优先级，或通用核心辅助程序在运行时加载前需要的原生文档支持时，请使用 `mediaUnderstandingProviderMetadata`。键名也必须在 `contracts.mediaUnderstandingProviders` 中声明。 ```json { @@ -402,18 +403,18 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 } ``` -每个提供商条目可以包含： +每个 provider 条目可以包含： | 字段 | 类型 | 含义 | | ---------------------- | ----------------------------------- | ---------------------------------------------------------------------------- | -| `capabilities` | `("image" \| "audio" \| "video")[]` | 此提供商公开的媒体能力。 | -| `defaultModels` | `Record` | 当配置未指定模型时使用的“能力到模型”默认映射。 | -| `autoPriority` | `Record` | 用于基于凭证的自动提供商回退时，数值越小排序越靠前。 | -| `nativeDocumentInputs` | `"pdf"[]` | 该提供商支持的原生文档输入。 | +| `capabilities` | `("image" \| "audio" \| "video")[]` | 此 provider 提供的媒体能力。 | +| `defaultModels` | `Record` | 当配置未指定模型时使用的“能力到模型”默认值。 | +| `autoPriority` | `Record` | 用于基于凭证的自动 provider 回退时，数字越小排序越靠前。 | +| `nativeDocumentInputs` | `"pdf"[]` | 该 provider 支持的原生文档输入。 | ## `channelConfigs` 参考 -当渠道插件在运行时加载前需要轻量配置元数据时，请使用 `channelConfigs`。 +当渠道插件在运行时加载前需要低成本配置元数据时，请使用 `channelConfigs`。 ```json { @@ -444,7 +445,7 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 | 字段 | 类型 | 含义 | | ------------- | ------------------------ | ----------------------------------------------------------------------------------------- | -| `schema` | `object` | `channels.` 的 JSON Schema。对每个已声明的渠道配置条目来说都是必填。 | +| `schema` | `object` | `channels.` 的 JSON Schema。每个已声明的渠道配置条目都必须提供。 | | `uiHints` | `Record` | 该渠道配置区块可选的 UI 标签 / 占位符 / 敏感性提示。 | | `label` | `string` | 当运行时元数据尚未就绪时，合并到选择器和检查界面中的渠道标签。 | | `description` | `string` | 用于检查和目录界面的简短渠道描述。 | @@ -452,7 +453,7 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 ## `modelSupport` 参考 -当 OpenClaw 应在插件运行时加载前，根据诸如 `gpt-5.4` 或 `claude-sonnet-4.6` 之类的简写模型 id 推断你的提供商插件时，请使用 `modelSupport`。 +当 OpenClaw 应在插件运行时加载前，根据 `gpt-5.4` 或 `claude-sonnet-4.6` 这类简写模型 id 推断你的 provider 插件时，请使用 `modelSupport`。 ```json { @@ -463,66 +464,72 @@ OpenClaw 会在提供商运行时加载之前读取这些内容。 } ``` -OpenClaw 采用以下优先级： +OpenClaw 会按以下优先级处理： -- 显式 `provider/model` 引用使用所属 `providers` 清单元数据 +- 显式的 `provider/model` 引用使用所属 `providers` 清单元数据 - `modelPatterns` 优先于 `modelPrefixes` - 如果一个非内置插件和一个内置插件都匹配，则非内置插件胜出 -- 剩余歧义会被忽略，直到用户或配置显式指定提供商 +- 若仍存在歧义，在用户或配置明确指定 provider 之前将忽略该歧义 字段： | 字段 | 类型 | 含义 | | --------------- | ---------- | ------------------------------------------------------------------------------- | -| `modelPrefixes` | `string[]` | 使用 `startsWith` 对简写模型 id 进行匹配的前缀。 | -| `modelPatterns` | `string[]` | 在移除配置文件后缀后，对简写模型 id 进行匹配的正则表达式源码。 | +| `modelPrefixes` | `string[]` | 对简写模型 id 使用 `startsWith` 匹配的前缀。 | +| `modelPatterns` | `string[]` | 在移除 profile 后缀后，对简写模型 id 进行匹配的正则表达式源码。 | -旧版顶层能力字段已弃用。请使用 `openclaw doctor --fix` 将 `speechProviders`、`realtimeTranscriptionProviders`、`realtimeVoiceProviders`、`mediaUnderstandingProviders`、`imageGenerationProviders`、`videoGenerationProviders`、`webFetchProviders` 和 `webSearchProviders` 移动到 `contracts` 下；正常清单加载已不再将这些顶层字段视为能力归属。 +旧版顶层能力键已弃用。请使用 `openclaw doctor --fix` 将 `speechProviders`、`realtimeTranscriptionProviders`、`realtimeVoiceProviders`、`mediaUnderstandingProviders`、`imageGenerationProviders`、`videoGenerationProviders`、`webFetchProviders` 和 `webSearchProviders` 移动到 `contracts` 下；常规清单加载不再将这些顶层字段视为能力归属。 ## 清单与 `package.json` 的区别 -这两个文件承担不同职责： +这两个文件承担的职责不同： | 文件 | 用途 | | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `openclaw.plugin.json` | 设备发现、配置校验、认证选项元数据，以及在插件代码运行前必须存在的 UI 提示 | -| `package.json` | npm 元数据、依赖安装，以及用于入口点、安装门控、设置或目录元数据的 `openclaw` 配置块 | +| `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` 中。 重要示例： | 字段 | 含义 | | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `openclaw.extensions` | 声明原生插件入口点。必须保持在插件包目录内。 | -| `openclaw.runtimeExtensions` | 为已安装包声明构建后的 JavaScript 运行时入口点。必须保持在插件包目录内。 | -| `openclaw.setupEntry` | 在新手引导、延迟渠道启动以及只读渠道状态 / SecretRef 发现期间使用的轻量仅设置入口点。必须保持在插件包目录内。 | -| `openclaw.runtimeSetupEntry` | 为已安装包声明构建后的 JavaScript 设置入口点。必须保持在插件包目录内。 | -| `openclaw.channel` | 轻量渠道目录元数据，例如标签、文档路径、别名和选择文案。 | -| `openclaw.channel.configuredState` | 轻量已配置状态检查器元数据，可在不加载完整渠道运行时的情况下回答“是否已存在仅基于环境变量的设置？”。 | -| `openclaw.channel.persistedAuthState` | 轻量持久化认证状态检查器元数据，可在不加载完整渠道运行时的情况下回答“是否已有任何内容处于已登录状态？”。 | -| `openclaw.install.npmSpec` / `openclaw.install.localPath` | 内置插件和外部发布插件的安装 / 更新提示。 | +| `openclaw.extensions` | 声明原生插件入口点。必须保留在插件包目录内。 | +| `openclaw.runtimeExtensions` | 为已安装包声明已构建的 JavaScript 运行时入口点。必须保留在插件包目录内。 | +| `openclaw.setupEntry` | 在新手引导、延迟渠道启动以及只读渠道状态 / SecretRef 发现期间使用的轻量级仅设置入口点。必须保留在插件包目录内。 | +| `openclaw.runtimeSetupEntry` | 为已安装包声明已构建的 JavaScript 设置入口点。必须保留在插件包目录内。 | +| `openclaw.channel` | 低成本渠道目录元数据，例如标签、文档路径、别名和选择文案。 | +| `openclaw.channel.configuredState` | 轻量级 configured-state 检查器元数据，可在不加载完整渠道运行时的情况下回答“是否已存在仅环境变量方式的设置？”。 | +| `openclaw.channel.persistedAuthState` | 轻量级 persisted-auth 检查器元数据，可在不加载完整渠道运行时的情况下回答“是否已经有任何登录状态？”。 | +| `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` | 最低支持的 OpenClaw 主机版本，使用如 `>=2026.3.22` 这样的 semver 下限。 | +| `openclaw.install.expectedIntegrity` | 预期的 npm 发行包完整性字符串，例如 `sha512-...`；安装和更新流程会根据它验证获取到的构件。 | +| `openclaw.install.allowInvalidConfigRecovery` | 当配置无效时，允许一个受限的内置插件重新安装恢复路径。 | +| `openclaw.startup.deferConfiguredChannelFullLoadUntilAfterListen` | 允许仅设置用的渠道界面在启动期间先于完整渠道插件加载。 | -`openclaw.install.minHostVersion` 会在安装和清单注册表加载期间强制执行。无效值会被拒绝；在较旧主机上，较新但有效的值会导致跳过该插件。 +清单元数据决定了在运行时加载前，新手引导中会出现哪些 provider / channel / setup 选项。`package.json#openclaw.install` 则告诉新手引导：当用户选择其中某个选项时，应如何获取或启用该插件。不要将安装提示移到 `openclaw.plugin.json` 中。 -渠道插件应提供 `openclaw.setupEntry`，以便在状态、渠道列表或 SecretRef 扫描需要识别已配置账户时，无需加载完整运行时。设置入口点应公开渠道元数据，以及适用于设置阶段的安全配置、状态和密钥适配器；网络客户端、Gateway 网关监听器和传输运行时应保留在主扩展入口点中。 +`openclaw.install.minHostVersion` 会在安装期间和清单注册表加载期间强制执行。无效值会被拒绝；对于较旧主机，较新但有效的值会跳过该插件。 -运行时入口点字段不会绕过源码入口点字段的包边界检查。例如，`openclaw.runtimeExtensions` 不能让一个越界的 `openclaw.extensions` 路径变得可加载。 +精确的 npm 版本锁定已通过 `npmSpec` 提供，例如 +`"npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3"`。当你希望在获取到的 npm 构件不再匹配已锁定发布版本时，让更新流程以关闭方式失败，可将它与 `expectedIntegrity` 搭配使用。交互式新手引导仅会在 `npmSpec` 是精确版本且存在 `expectedIntegrity` 时，从受信任的目录元数据中提供 npm 安装选项；否则会回退到本地来源或跳过。 -`openclaw.install.allowInvalidConfigRecovery` 的设计刻意保持为窄范围。它不会让任意损坏的配置都变得可安装。当前它仅允许安装流程从某些特定的陈旧内置插件升级故障中恢复，例如缺失的内置插件路径，或同一个内置插件对应的陈旧 `channels.` 条目。无关的配置错误仍会阻止安装，并将操作人员引导到 `openclaw doctor --fix`。 +当状态、渠道列表或 SecretRef 扫描需要在不加载完整运行时的情况下识别已配置账户时，渠道插件应提供 `openclaw.setupEntry`。设置入口点应暴露渠道元数据以及适用于设置阶段的配置、状态和 secrets 适配器；请将网络客户端、Gateway 网关监听器和传输运行时保留在主扩展入口点中。 -`openclaw.channel.persistedAuthState` 是针对一个微型检查模块的包元数据： +运行时入口点字段不会覆盖针对源码入口点字段的包边界检查。例如，`openclaw.runtimeExtensions` 不能使一个越界的 `openclaw.extensions` 路径变为可加载。 + +`openclaw.install.allowInvalidConfigRecovery` 的适用范围是有意保持狭窄的。它不会让任意损坏的配置变得可安装。当前它只允许安装流程从特定的陈旧内置插件升级失败中恢复，例如缺失的内置插件路径，或同一内置插件对应的陈旧 `channels.` 条目。无关的配置错误仍会阻止安装，并将操作人员引导至 `openclaw doctor --fix`。 + +`openclaw.channel.persistedAuthState` 是用于微型检查模块的包元数据： ```json { @@ -538,9 +545,9 @@ OpenClaw 采用以下优先级： } ``` -当设置、Doctor 或已配置状态流程需要在完整渠道插件加载前进行一个低成本的“是 / 否”认证探测时，请使用它。目标导出应是一个仅读取持久化状态的小函数；不要通过完整渠道运行时 barrel 转发它。 +当设置、Doctor 或 configured-state 流程需要在完整渠道插件加载前进行低成本的是 / 否认证探测时，请使用它。目标导出应是一个仅读取持久化状态的小函数；不要通过完整渠道运行时 barrel 转发它。 -`openclaw.channel.configuredState` 也采用相同结构，用于低成本的仅环境变量已配置检查： +`openclaw.channel.configuredState` 采用相同的结构，用于低成本的仅环境变量 configured 检查： ```json { @@ -556,62 +563,64 @@ OpenClaw 采用以下优先级： } ``` -当一个渠道可以仅通过环境变量或其他微型非运行时输入来回答已配置状态时，请使用它。如果检查需要完整配置解析或真实的渠道运行时，请将该逻辑保留在插件 `config.hasConfiguredState` hook 中。 +当渠道可以通过环境变量或其他微小的非运行时输入来回答 configured-state 时，请使用它。如果检查需要完整的配置解析或真实渠道运行时，请改为将该逻辑保留在插件 `config.hasConfiguredState` hook 中。 -## 设备发现优先级（重复插件 id） +## 发现优先级（重复插件 id） -OpenClaw 会从多个根目录发现插件（内置、全局安装、工作区、配置中显式选择的路径）。如果两次发现共享同一个 `id`，则只保留**优先级最高**的清单；较低优先级的重复项会被丢弃，而不是与其并行加载。 +OpenClaw 会从多个根目录发现插件（内置、全局安装、工作区、配置中显式选定的路径）。如果两个发现结果共享相同的 `id`，则只保留**优先级最高**的清单；优先级较低的重复项会被丢弃，而不是与其并行加载。 优先级从高到低如下： 1. **配置选定** —— 在 `plugins.entries.` 中显式固定的路径 -2. **内置** —— 随 OpenClaw 一同发布的插件 +2. **内置** —— 随 OpenClaw 一起发布的插件 3. **全局安装** —— 安装到全局 OpenClaw 插件根目录中的插件 4. **工作区** —— 相对于当前工作区发现的插件 -影响： +影响如下： -- 工作区中某个内置插件的 fork 或陈旧副本不会遮蔽内置构建。 -- 如果你确实要用本地插件覆盖内置插件，请通过 `plugins.entries.` 固定它，使其凭借优先级获胜，而不是依赖工作区发现。 -- 重复项被丢弃会记录日志，以便 Doctor 和启动诊断可以指出被舍弃的副本。 +- 工作区中某个内置插件的 fork 或陈旧副本不会遮蔽内置版本。 +- 若要真正用本地插件覆盖内置插件，请通过 `plugins.entries.` 固定它，使其依靠优先级获胜，而不是依赖工作区发现。 +- 被丢弃的重复项会记录日志，以便 Doctor 和启动诊断能指出被舍弃的副本。 ## JSON Schema 要求 - **每个插件都必须提供一个 JSON Schema**，即使它不接受任何配置。 -- 空 schema 也是允许的（例如 `{ "type": "object", "additionalProperties": false }`）。 +- 接受空 schema（例如 `{ "type": "object", "additionalProperties": false }`）。 - Schema 会在配置读写时校验，而不是在运行时校验。 ## 校验行为 -- 未知的 `channels.*` 键是**错误**，除非该渠道 id 已由某个插件清单声明。 +- 未知的 `channels.*` 键是**错误**，除非该 channel 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，请参见[配置参考](/zh-CN/gateway/configuration)。 -## 注意事项 +## 说明 -- 清单对于**原生 OpenClaw 插件**是**必需的**，包括本地文件系统加载。 -- 运行时仍会单独加载插件模块；清单仅用于设备发现 + 校验。 -- 原生清单使用 JSON5 解析，因此只要最终值仍是一个对象，就接受注释、尾随逗号和未加引号的键。 -- 清单加载器只读取已文档化的清单字段。避免在此添加自定义顶层键。 -- `providerAuthEnvVars` 是用于认证探测、环境变量标记校验，以及类似提供商认证界面的轻量元数据路径；这些场景不应仅为了检查环境变量名称而启动插件运行时。 -- `providerAuthAliases` 允许提供商变体复用另一个提供商的认证环境变量、认证配置文件、基于配置的认证以及 API key 新手引导选项，而无需在 core 中硬编码这种关系。 -- `providerEndpoints` 允许提供商插件持有简单的端点主机 / `baseUrl` 匹配元数据。仅将其用于 core 已支持的端点类别；实际运行时行为仍由插件负责。 -- `syntheticAuthRefs` 是用于提供商持有的 synthetic auth hook 的轻量元数据路径；这些 hook 必须在运行时注册表存在之前，对冷启动模型发现可见。只列出那些其运行时提供商或 CLI 后端实际实现了 `resolveSyntheticAuth` 的引用。 -- `nonSecretAuthMarkers` 是用于内置插件持有的占位 API key 的轻量元数据路径，例如本地、OAuth 或环境凭证标记。Core 会将这些值视为非机密，用于认证显示和密钥审计，而无需硬编码其所属提供商。 -- `channelEnvVars` 是用于 shell 环境变量回退、设置提示以及类似渠道界面的轻量元数据路径；这些场景不应仅为了检查环境变量名称而启动插件运行时。环境变量名称只是元数据，本身不构成激活：状态、审计、定时任务投递校验以及其他只读界面，在将某个环境变量视为已配置渠道前，仍会应用插件信任与有效激活策略。 -- `providerAuthChoices` 是用于认证选项选择器、`--auth-choice` 解析、首选提供商映射，以及在提供商运行时加载前注册简单新手引导 CLI 标志的轻量元数据路径。对于需要提供商代码的运行时向导元数据，请参阅[提供商运行时 hooks](/zh-CN/plugins/architecture#provider-runtime-hooks)。 -- 互斥插件类型通过 `plugins.slots.*` 选择。 - - `kind: "memory"` 通过 `plugins.slots.memory` 选择。 - - `kind: "context-engine"` 通过 `plugins.slots.contextEngine` 选择（默认值：内置 `legacy`）。 +- 对于原生 OpenClaw 插件，清单是**必需的**，包括本地文件系统加载。 +- 运行时仍会单独加载插件模块；清单仅用于发现 + 校验。 +- 原生清单使用 JSON5 解析，因此支持注释、尾随逗号和未加引号的键，只要最终值仍然是对象即可。 +- 清单加载器只会读取文档中说明的清单字段。避免在此添加自定义顶层键。 +- `providerAuthEnvVars` 是用于认证探测、环境变量标记校验以及类似 provider 认证界面的低成本元数据路径，这些场景不应仅为检查环境变量名称而启动插件运行时。 +- `providerAuthAliases` 允许 provider 变体复用另一个 provider 的认证环境变量、认证配置文件、基于配置的认证，以及 API key 新手引导选项，而无需在核心中硬编码这种关系。 +- `providerEndpoints` 允许 provider 插件拥有简单的 endpoint host/baseUrl 匹配元数据。仅在核心已支持的 endpoint class 上使用它；插件仍拥有运行时行为。 +- `syntheticAuthRefs` 是一种低成本元数据路径，用于 provider 自有的 synthetic auth hook，这些 hook 必须在运行时注册表存在之前，对冷启动模型发现可见。只列出那些其运行时 provider 或 CLI backend 实际实现了 `resolveSyntheticAuth` 的引用。 +- `nonSecretAuthMarkers` 是一种低成本元数据路径，用于内置插件自有的占位 API key，例如本地、OAuth 或环境凭证标记。核心会将这些值视为非秘密信息，以用于认证显示和 secret 审计，而无需硬编码所属 provider。 +- `channelEnvVars` 是 shell 环境变量回退、设置提示以及类似渠道界面的低成本元数据路径，这些场景不应仅为检查环境变量名称而启动插件运行时。环境变量名称只是元数据，本身并不构成激活：状态、审计、cron 投递校验以及其他只读界面，在将环境变量视为已配置渠道之前，仍会应用插件信任和有效激活策略。 +- `providerAuthChoices` 是认证选项选择器、`--auth-choice` 解析、首选 provider 映射，以及在 provider 运行时加载前进行简单新手引导 CLI 标志注册的低成本元数据路径。对于需要 provider 代码的运行时向导元数据，请参见 + [Provider 运行时 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` 时，可以省略这些字段。 - 如果你的插件依赖原生模块，请记录构建步骤以及任何包管理器允许列表要求（例如 pnpm `allow-build-scripts` - `pnpm rebuild `）。 ## 相关内容 -- [构建插件](/zh-CN/plugins/building-plugins) — 插件快速开始 -- [插件架构](/zh-CN/plugins/architecture) — 内部架构 -- [SDK 概览](/zh-CN/plugins/sdk-overview) — 插件 SDK 参考 +- [构建插件](/zh-CN/plugins/building-plugins) —— 插件入门指南 +- [插件架构](/zh-CN/plugins/architecture) —— 内部架构 +- [SDK 概览](/zh-CN/plugins/sdk-overview) —— 插件 SDK 参考 diff --git a/docs/zh-CN/plugins/sdk-setup.md b/docs/zh-CN/plugins/sdk-setup.md index a23febb14..c77e36a4a 100644 --- a/docs/zh-CN/plugins/sdk-setup.md +++ b/docs/zh-CN/plugins/sdk-setup.md @@ -1,33 +1,33 @@ --- read_when: - 你正在为一个插件添加设置向导 - - 你需要理解 `setup-entry.ts` 与 `index.ts` 的区别 - - 你正在定义插件配置模式或 `package.json` 中的 OpenClaw 元数据 + - 你需要了解 `setup-entry.ts` 与 `index.ts` 的区别 + - 你正在定义插件配置 schema 或 `package.json` 中的 OpenClaw 元数据 sidebarTitle: Setup and Config -summary: 设置向导、setup-entry.ts、配置模式和 package.json 元数据 +summary: 设置向导、`setup-entry.ts`、配置 schema，以及 `package.json` 元数据 title: 插件设置和配置 x-i18n: - generated_at: "2026-04-20T16:50:01Z" + generated_at: "2026-04-23T05:14:54Z" model: gpt-5.4 provider: openai - source_hash: 5de51b55c04b4f05947bc2d4de9c34e24a26e4ca8b3ff9b1711288a8e5b63273 + source_hash: ccdafb9a562353a7851fcd47bbc382961a449f5d645362c800f64c60579ce7b2 source_path: plugins/sdk-setup.md workflow: 15 --- # 插件设置和配置 -关于插件打包（`package.json` 元数据）、清单（`openclaw.plugin.json`）、设置入口和配置模式的参考。 +关于插件打包（`package.json` 元数据）、清单（`openclaw.plugin.json`）、设置入口和配置 schema 的参考。 - **在找操作指南吗？** 操作指南会结合上下文介绍打包流程： + **想看操作演练？** 操作指南会结合上下文讲解打包流程： [渠道插件](/zh-CN/plugins/sdk-channel-plugins#step-1-package-and-manifest) 和 [提供商插件](/zh-CN/plugins/sdk-provider-plugins#step-1-package-and-manifest)。 ## 包元数据 -你的 `package.json` 需要包含一个 `openclaw` 字段，用来告诉插件系统你的插件提供了什么： +你的 `package.json` 需要有一个 `openclaw` 字段，用来告诉插件系统你的插件提供了什么： **渠道插件：** @@ -42,7 +42,7 @@ x-i18n: "channel": { "id": "my-channel", "label": "My Channel", - "blurb": "Short description of the channel." + "blurb": "渠道的简短描述。" } } } @@ -69,46 +69,44 @@ x-i18n: } ``` -如果你要在 ClawHub 上对外发布该插件，这些 `compat` 和 `build` -字段是必需的。规范的发布代码片段位于 -`docs/snippets/plugin-publish/`。 +如果你要在 ClawHub 上对外发布插件，则这些 `compat` 和 `build` 字段是必需的。规范的发布片段位于 `docs/snippets/plugin-publish/` 中。 ### `openclaw` 字段 -| 字段 | 类型 | 说明 | -| ------------ | ---------- | -------------------------------------------------------------------- | -| `extensions` | `string[]` | 入口点文件（相对于包根目录） | -| `setupEntry` | `string` | 仅用于设置的轻量入口（可选） | -| `channel` | `object` | 用于设置、选择器、快速开始和状态界面的渠道目录元数据 | -| `providers` | `string[]` | 该插件注册的提供商 id | -| `install` | `object` | 安装提示：`npmSpec`、`localPath`、`defaultChoice`、`minHostVersion`、`allowInvalidConfigRecovery` | -| `startup` | `object` | 启动行为标志 | +| 字段 | 类型 | 描述 | +| ------------ | ---------- | --------------------------------------------------------------------------------------------------------------------------- | +| `extensions` | `string[]` | 入口点文件（相对于包根目录） | +| `setupEntry` | `string` | 仅用于设置的轻量入口（可选） | +| `channel` | `object` | 用于设置、选择器、快速开始和状态界面的渠道目录元数据 | +| `providers` | `string[]` | 由该插件注册的提供商 id | +| `install` | `object` | 安装提示：`npmSpec`、`localPath`、`defaultChoice`、`minHostVersion`、`expectedIntegrity`、`allowInvalidConfigRecovery` | +| `startup` | `object` | 启动行为标志 | ### `openclaw.channel` -`openclaw.channel` 是低成本的包元数据，用于在运行时加载之前支持渠道发现和设置界面。 +`openclaw.channel` 是低成本的包元数据，用于在运行时加载前支持渠道发现和设置界面。 -| 字段 | 类型 | 含义 | -| -------------------------------------- | ---------- | ----------------------------------------------------- | -| `id` | `string` | 规范的渠道 id。 | -| `label` | `string` | 主要渠道标签。 | +| 字段 | 类型 | 含义 | +| -------------------------------------- | ---------- | ------------------------------------------------- | +| `id` | `string` | 规范的渠道 id。 | +| `label` | `string` | 主要渠道标签。 | | `selectionLabel` | `string` | 当需要与 `label` 不同时，在选择器 / 设置中显示的标签。 | -| `detailLabel` | `string` | 用于更丰富渠道目录和状态界面的次级详情标签。 | -| `docsPath` | `string` | 用于设置和选择链接的文档路径。 | -| `docsLabel` | `string` | 当需要与渠道 id 不同时，用作文档链接标签的覆盖值。 | -| `blurb` | `string` | 简短的新手引导 / 目录描述。 | -| `order` | `number` | 在渠道目录中的排序顺序。 | -| `aliases` | `string[]` | 用于渠道选择的额外查找别名。 | -| `preferOver` | `string[]` | 该渠道应优先于的较低优先级插件 / 渠道 id。 | -| `systemImage` | `string` | 渠道 UI 目录中可选的图标 / system-image 名称。 | -| `selectionDocsPrefix` | `string` | 在选择界面中文档链接前显示的前缀文本。 | +| `detailLabel` | `string` | 用于更丰富的渠道目录和状态界面的次级详情标签。 | +| `docsPath` | `string` | 用于设置和选择链接的文档路径。 | +| `docsLabel` | `string` | 当文档链接标签需要与渠道 id 不同时使用的覆盖标签。 | +| `blurb` | `string` | 简短的新手引导 / 目录描述。 | +| `order` | `number` | 在渠道目录中的排序顺序。 | +| `aliases` | `string[]` | 用于渠道选择的额外查找别名。 | +| `preferOver` | `string[]` | 该渠道应优先于的低优先级插件 / 渠道 id。 | +| `systemImage` | `string` | 用于渠道 UI 目录的可选图标 / system-image 名称。 | +| `selectionDocsPrefix` | `string` | 在选择界面中，文档链接前显示的前缀文本。 | | `selectionDocsOmitLabel` | `boolean` | 在选择文案中直接显示文档路径，而不是带标签的文档链接。 | -| `selectionExtras` | `string[]` | 附加在选择文案中的额外短文本。 | -| `markdownCapable` | `boolean` | 将该渠道标记为支持 Markdown，用于出站格式决策。 | -| `exposure` | `object` | 渠道在设置、已配置列表和文档界面中的可见性控制。 | -| `quickstartAllowFrom` | `boolean` | 让该渠道加入标准快速开始 `allowFrom` 设置流程。 | -| `forceAccountBinding` | `boolean` | 即使只有一个账户存在，也要求显式账户绑定。 | -| `preferSessionLookupForAnnounceTarget` | `boolean` | 为该渠道解析公告目标时，优先使用会话查找。 | +| `selectionExtras` | `string[]` | 附加在选择文案中的额外短文本。 | +| `markdownCapable` | `boolean` | 将该渠道标记为支持 Markdown，用于出站格式决策。 | +| `exposure` | `object` | 渠道在设置、已配置列表和文档界面中的可见性控制。 | +| `quickstartAllowFrom` | `boolean` | 让该渠道加入标准快速开始 `allowFrom` 设置流程。 | +| `forceAccountBinding` | `boolean` | 即使只存在一个账户，也要求显式账户绑定。 | +| `preferSessionLookupForAnnounceTarget` | `boolean` | 在为该渠道解析公告目标时，优先使用会话查找。 | 示例： @@ -122,11 +120,11 @@ x-i18n: "detailLabel": "My Channel Bot", "docsPath": "/channels/my-channel", "docsLabel": "my-channel", - "blurb": "Webhook-based self-hosted chat integration.", + "blurb": "基于 Webhook 的自托管聊天集成。", "order": 80, "aliases": ["mc"], "preferOver": ["my-channel-legacy"], - "selectionDocsPrefix": "Guide:", + "selectionDocsPrefix": "指南：", "selectionExtras": ["Markdown"], "markdownCapable": true, "exposure": { @@ -144,10 +142,9 @@ x-i18n: - `configured`：在已配置 / 状态类列表界面中包含该渠道 - `setup`：在交互式设置 / 配置选择器中包含该渠道 -- `docs`：将该渠道标记为面向公开的文档 / 导航界面内容 +- `docs`：将该渠道标记为在文档 / 导航界面中面向公开展示 -`showConfigured` 和 `showInSetup` 仍然作为旧别名受支持。优先使用 -`exposure`。 +`showConfigured` 和 `showInSetup` 仍然作为旧版别名受到支持。请优先使用 `exposure`。 ### `openclaw.install` @@ -157,15 +154,30 @@ x-i18n: | ---------------------------- | -------------------- | -------------------------------------------------------------------------------- | | `npmSpec` | `string` | 用于安装 / 更新流程的规范 npm spec。 | | `localPath` | `string` | 本地开发或内置安装路径。 | -| `defaultChoice` | `"npm"` \| `"local"` | 当两者都可用时，优先使用的安装来源。 | +| `defaultChoice` | `"npm"` \| `"local"` | 当两者都可用时的首选安装来源。 | | `minHostVersion` | `string` | 支持的最低 OpenClaw 版本，格式为 `>=x.y.z`。 | +| `expectedIntegrity` | `string` | 预期的 npm dist 完整性字符串，通常为 `sha512-...`，用于固定版本安装。 | | `allowInvalidConfigRecovery` | `boolean` | 允许内置插件重装流程从特定的过期配置失败中恢复。 | -如果设置了 `minHostVersion`，安装和清单注册表加载都会强制执行它。 -较旧的宿主会跳过该插件；无效的版本字符串会被拒绝。 +交互式新手引导也会将 `openclaw.install` 用于按需安装界面。如果你的插件在运行时加载前就暴露提供商认证选项，或暴露渠道设置 / 目录元数据，则新手引导可以显示该选项、提示用户选择 npm 还是本地安装、安装或启用插件，然后继续执行所选流程。npm 新手引导选项要求可信的目录元数据，其中必须包含精确版本的 `npmSpec` 和 `expectedIntegrity`；未固定版本的包名和 dist-tag 不会用于自动新手引导安装。请将“显示什么”的元数据保留在 `openclaw.plugin.json` 中，将“如何安装”的元数据保留在 `package.json` 中。 -`allowInvalidConfigRecovery` 不是针对损坏配置的通用绕过方式。它仅用于内置插件的狭义恢复场景，使重装 / 设置可以修复已知的升级遗留问题，例如缺失的内置插件路径，或该插件对应的过期 `channels.` -条目。如果配置因无关原因损坏，安装仍会以关闭方式失败，并提示操作员运行 `openclaw doctor --fix`。 +如果设置了 `minHostVersion`，则安装和清单注册表加载都会强制执行它。较旧的宿主会跳过该插件；无效的版本字符串会被拒绝。 + +对于固定版本的 npm 安装，请在 `npmSpec` 中保留精确版本，并添加预期的制品完整性： + +```json +{ + "openclaw": { + "install": { + "npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3", + "expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY", + "defaultChoice": "npm" + } + } +} +``` + +`allowInvalidConfigRecovery` 并不是对损坏配置的一般性绕过。它仅用于狭窄范围内的内置插件恢复，以便重装 / 设置可以修复已知的升级遗留问题，例如缺失的内置插件路径，或同一插件对应的过期 `channels.` 条目。如果配置因无关原因损坏，安装仍会默认拒绝，并提示操作者运行 `openclaw doctor --fix`。 ### 延迟完整加载 @@ -183,39 +195,38 @@ x-i18n: } ``` -启用后，OpenClaw 在监听前的启动阶段只会加载 `setupEntry`，即使对于已配置的渠道也是如此。完整入口会在 Gateway 网关开始监听后再加载。 +启用后，在监听前的启动阶段，OpenClaw 即使对已经配置的渠道也只会加载 `setupEntry`。完整入口会在 Gateway 网关开始监听后再加载。 - 仅当你的 `setupEntry` 注册了 Gateway 网关在开始监听前所需的一切内容时，才应启用延迟加载（渠道注册、HTTP 路由、Gateway 网关方法）。如果完整入口拥有必需的启动能力，请保持默认行为。 + 只有在你的 `setupEntry` 已经注册了 Gateway 网关在开始监听前所需的一切内容时，才应启用延迟加载（渠道注册、HTTP 路由、Gateway 网关方法）。如果完整入口拥有必需的启动能力，请保持默认行为。 -如果你的设置 / 完整入口会注册 Gateway 网关 RPC 方法，请保持使用插件专属前缀。保留的核心管理命名空间（`config.*`、 -`exec.approvals.*`、`wizard.*`、`update.*`）仍由核心拥有，并始终解析到 `operator.admin`。 +如果你的设置 / 完整入口会注册 Gateway 网关 RPC 方法，请保持使用插件专属前缀。保留的核心管理命名空间（`config.*`、`exec.approvals.*`、`wizard.*`、`update.*`）仍归核心所有，并始终解析到 `operator.admin`。 ## 插件清单 -每个原生插件都必须在包根目录提供一个 `openclaw.plugin.json`。 -OpenClaw 使用它在不执行插件代码的情况下验证配置。 +每个原生插件都必须在包根目录中提供一个 `openclaw.plugin.json`。 +OpenClaw 会用它在不执行插件代码的情况下验证配置。 ```json { "id": "my-plugin", "name": "My Plugin", - "description": "Adds My Plugin capabilities to OpenClaw", + "description": "为 OpenClaw 增加 My Plugin 功能", "configSchema": { "type": "object", "additionalProperties": false, "properties": { "webhookSecret": { "type": "string", - "description": "Webhook verification secret" + "description": "Webhook 验证密钥" } } } } ``` -对于渠道插件，添加 `kind` 和 `channels`： +对于渠道插件，请添加 `kind` 和 `channels`： ```json { @@ -230,7 +241,7 @@ OpenClaw 使用它在不执行插件代码的情况下验证配置。 } ``` -即使插件没有任何配置，也必须提供一个模式。空模式也是有效的： +即使插件没有任何配置，也必须提供一个 schema。空 schema 是有效的： ```json { @@ -242,22 +253,22 @@ OpenClaw 使用它在不执行插件代码的情况下验证配置。 } ``` -完整模式参考请见 [插件清单](/zh-CN/plugins/manifest)。 +完整的 schema 参考请参阅 [插件清单](/zh-CN/plugins/manifest)。 ## ClawHub 发布 -对于插件包，请使用包专用的 ClawHub 命令： +对于插件包，请使用针对包的 ClawHub 命令： ```bash clawhub package publish your-org/your-plugin --dry-run clawhub package publish your-org/your-plugin ``` -旧版仅适用于 skill 的发布别名是给 Skills 使用的。插件包应始终使用 `clawhub package publish`。 +旧的仅限 Skills 的发布别名用于 Skills。插件包应始终使用 `clawhub package publish`。 ## 设置入口 -`setup-entry.ts` 文件是 `index.ts` 的轻量替代方案，当 OpenClaw 只需要设置界面时（新手引导、配置修复、禁用渠道检查），会加载它。 +`setup-entry.ts` 文件是 `index.ts` 的轻量替代方案，当 OpenClaw 只需要设置界面时（新手引导、配置修复、已禁用渠道检查），会加载它。 ```typescript // setup-entry.ts @@ -267,14 +278,14 @@ import { myChannelPlugin } from "./src/channel.js"; export default defineSetupPluginEntry(myChannelPlugin); ``` -这可以避免在设置流程中加载重量级运行时代码（加密库、CLI 注册、后台服务）。 +这可以避免在设置流程中加载沉重的运行时代码（加密库、CLI 注册、后台服务）。 对于将设置安全导出保存在 sidecar 模块中的内置工作区渠道，可以使用 `openclaw/plugin-sdk/channel-entry-contract` 中的 `defineBundledChannelSetupEntry(...)`，而不是 -`defineSetupPluginEntry(...)`。该内置契约还支持可选的 `runtime` 导出，从而让设置阶段的运行时接线保持轻量且明确。 +`defineSetupPluginEntry(...)`。该内置契约还支持可选的 `runtime` 导出，以便让设置时的运行时接线保持轻量且明确。 -**OpenClaw 在以下情况下会使用 `setupEntry` 而不是完整入口：** +**OpenClaw 何时使用 `setupEntry` 而不是完整入口：** - 渠道已禁用，但仍需要设置 / 新手引导界面 - 渠道已启用，但尚未配置 @@ -283,8 +294,8 @@ export default defineSetupPluginEntry(myChannelPlugin); **`setupEntry` 必须注册的内容：** - 渠道插件对象（通过 `defineSetupPluginEntry`） -- 在 Gateway 网关监听前所需的任何 HTTP 路由 -- 启动期间所需的任何 Gateway 网关方法 +- 任何在 Gateway 网关开始监听前所需的 HTTP 路由 +- 启动期间需要的任何 Gateway 网关方法 这些启动期 Gateway 网关方法仍应避免使用保留的核心管理命名空间，例如 `config.*` 或 `update.*`。 @@ -292,45 +303,41 @@ export default defineSetupPluginEntry(myChannelPlugin); - CLI 注册 - 后台服务 -- 重量级运行时导入（加密库、SDK） +- 沉重的运行时导入（加密库、SDK） - 仅在启动后才需要的 Gateway 网关方法 -### 窄化设置辅助导入 +### 精简的设置辅助导入 -对于仅设置的热点路径，如果你只需要设置界面的一部分，优先使用窄化的设置辅助接缝，而不是更宽泛的 `plugin-sdk/setup` 总入口： +对于仅设置的热路径，当你只需要部分设置功能时，应优先使用更精简的设置辅助接缝，而不是更宽泛的 `plugin-sdk/setup` 总入口： -| 导入路径 | 适用场景 | 关键导出 | -| ---------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `plugin-sdk/setup-runtime` | 在 `setupEntry` / 延迟渠道启动中仍可用的设置期运行时辅助工具 | `createPatchedAccountSetupAdapter`, `createEnvPatchedAccountSetupAdapter`, `createSetupInputPresenceValidator`, `noteChannelLookupFailure`, `noteChannelLookupSummary`, `promptResolvedAllowFrom`, `splitSetupEntries`, `createAllowlistSetupWizardProxy`, `createDelegatedSetupWizardProxy` | -| `plugin-sdk/setup-adapter-runtime` | 感知环境的账户设置适配器 | `createEnvPatchedAccountSetupAdapter` | -| `plugin-sdk/setup-tools` | 设置 / 安装 CLI / 归档 / 文档辅助工具 | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` | +| 导入路径 | 适用场景 | 关键导出 | +| ---------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `plugin-sdk/setup-runtime` | 在 `setupEntry` / 延迟渠道启动期间仍可用的设置时运行时辅助工具 | `createPatchedAccountSetupAdapter`, `createEnvPatchedAccountSetupAdapter`, `createSetupInputPresenceValidator`, `noteChannelLookupFailure`, `noteChannelLookupSummary`, `promptResolvedAllowFrom`, `splitSetupEntries`, `createAllowlistSetupWizardProxy`, `createDelegatedSetupWizardProxy` | +| `plugin-sdk/setup-adapter-runtime` | 识别环境的账户设置适配器 | `createEnvPatchedAccountSetupAdapter` | +| `plugin-sdk/setup-tools` | 设置 / 安装 CLI / 归档 / 文档辅助工具 | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` | -当你需要完整的共享设置工具箱时，请使用更宽泛的 `plugin-sdk/setup` -接缝，其中包括配置补丁辅助工具，例如 +当你需要完整的共享设置工具箱时，请使用更宽泛的 `plugin-sdk/setup` 接缝，其中包括配置补丁辅助工具，例如 `moveSingleAccountChannelSectionToDefaultAccount(...)`。 -这些设置补丁适配器在导入时仍然对热点路径安全。它们对内置单账户提升契约界面的查找是惰性的，因此导入 -`plugin-sdk/setup-runtime` 不会在实际使用适配器之前急切加载内置契约界面发现逻辑。 +这些设置补丁适配器在导入时仍然对热路径安全。它们对内置单账户提升契约面的查找是惰性的，因此导入 +`plugin-sdk/setup-runtime` 不会在适配器真正使用前，急切加载内置契约面发现逻辑。 ### 渠道自有的单账户提升 -当一个渠道从单账户顶层配置升级到 -`channels..accounts.*` 时，默认的共享行为会将被提升的账户作用域值移动到 -`accounts.default` 中。 +当渠道从单账户顶层配置升级到 +`channels..accounts.*` 时，默认的共享行为会把提升后的账户作用域值移入 `accounts.default`。 -内置渠道可以通过其设置契约界面缩小或覆盖该提升行为： +内置渠道可以通过其设置契约面来收窄或覆盖这一提升行为： -- `singleAccountKeysToMove`：应移动到被提升账户中的额外顶层键 -- `namedAccountPromotionKeys`：当已存在命名账户时，只有这些键会移动到被提升账户中；共享的策略 / 投递键会保留在渠道根级别 -- `resolveSingleAccountPromotionTarget(...)`：选择哪个现有账户接收被提升的值 +- `singleAccountKeysToMove`：应移入提升后账户的额外顶层键 +- `namedAccountPromotionKeys`：如果已存在具名账户，则仅将这些键移入提升后的账户；共享的 policy / delivery 键保留在渠道根级别 +- `resolveSingleAccountPromotionTarget(...)`：选择由哪个现有账户接收提升后的值 -Matrix 是当前的内置示例。如果恰好已经存在一个命名的 Matrix 账户，或者 -`defaultAccount` 指向一个现有的非规范键（例如 `Ops`），提升过程会保留该账户，而不是创建新的 -`accounts.default` 条目。 +Matrix 是当前的内置示例。如果恰好已经存在一个具名 Matrix 账户，或者如果 `defaultAccount` 指向现有的非规范键名（例如 `Ops`），那么提升会保留该账户，而不是创建新的 `accounts.default` 条目。 -## 配置模式 +## 配置 schema -插件配置会根据清单中的 JSON Schema 进行验证。用户通过以下方式配置插件： +插件配置会根据你的清单中的 JSON Schema 进行验证。用户通过以下方式配置插件： ```json5 { @@ -346,9 +353,9 @@ Matrix 是当前的内置示例。如果恰好已经存在一个命名的 Matrix } ``` -你的插件会在注册期间通过 `api.pluginConfig` 接收这份配置。 +你的插件会在注册期间通过 `api.pluginConfig` 收到该配置。 -对于特定渠道的配置，请改用渠道配置区段： +对于渠道专属配置，请改用渠道配置部分： ```json5 { @@ -361,10 +368,10 @@ Matrix 是当前的内置示例。如果恰好已经存在一个命名的 Matrix } ``` -### 构建渠道配置模式 +### 构建渠道配置 schema -使用 `openclaw/plugin-sdk/core` 中的 `buildChannelConfigSchema` 将一个 -Zod 模式转换为 OpenClaw 用于验证的 `ChannelConfigSchema` 包装器： +使用 `openclaw/plugin-sdk/core` 中的 `buildChannelConfigSchema`，将 +Zod schema 转换为 OpenClaw 可验证的 `ChannelConfigSchema` 包装器： ```typescript import { z } from "zod"; @@ -391,8 +398,8 @@ import type { ChannelSetupWizard } from "openclaw/plugin-sdk/channel-setup"; const setupWizard: ChannelSetupWizard = { channel: "my-channel", status: { - configuredLabel: "Connected", - unconfiguredLabel: "Not configured", + configuredLabel: "已连接", + unconfiguredLabel: "未配置", resolveConfigured: ({ cfg }) => Boolean((cfg.channels as any)?.["my-channel"]?.token), }, credentials: [ @@ -401,9 +408,9 @@ const setupWizard: ChannelSetupWizard = { providerHint: "my-channel", credentialLabel: "Bot token", preferredEnvVar: "MY_CHANNEL_BOT_TOKEN", - envPrompt: "Use MY_CHANNEL_BOT_TOKEN from environment?", - keepPrompt: "Keep current token?", - inputPrompt: "Enter your bot token:", + envPrompt: "使用环境中的 MY_CHANNEL_BOT_TOKEN 吗？", + keepPrompt: "保留当前 token 吗？", + inputPrompt: "输入你的 bot token：", inspect: ({ cfg, accountId }) => { const token = (cfg.channels as any)?.["my-channel"]?.token; return { @@ -417,23 +424,21 @@ const setupWizard: ChannelSetupWizard = { ``` `ChannelSetupWizard` 类型支持 `credentials`、`textInputs`、 -`dmPolicy`、`allowFrom`、`groupAccess`、`prepare`、`finalize` -等。完整示例请参阅内置插件包（例如 Discord 插件中的 `src/channel.setup.ts`）。 +`dmPolicy`、`allowFrom`、`groupAccess`、`prepare`、`finalize` 等等。 +完整示例请参阅内置插件包（例如 Discord 插件的 `src/channel.setup.ts`）。 对于只需要标准 -`note -> prompt -> parse -> merge -> patch` -流程的私信 allowlist 提示，优先使用 +`note -> prompt -> parse -> merge -> patch` 流程的私信白名单提示，应优先使用 `openclaw/plugin-sdk/setup` 中的共享设置辅助工具： `createPromptParsedAllowFromForAccount(...)`、 `createTopLevelChannelParsedAllowFromPrompt(...)` 和 `createNestedChannelParsedAllowFromPrompt(...)`。 -对于仅在标签、分数和可选附加行上有所不同的渠道设置状态块，优先使用 +对于仅在标签、分数和可选附加行方面有所不同的渠道设置状态块，应优先使用 `openclaw/plugin-sdk/setup` 中的 -`createStandardChannelSetupStatus(...)`，而不是在每个插件中手动重复构建相同的 -`status` 对象。 +`createStandardChannelSetupStatus(...)`，而不是在每个插件中手写相同的 `status` 对象。 -对于只应在特定上下文中显示的可选设置界面，使用 +对于只应在某些上下文中显示的可选设置界面，请使用 `openclaw/plugin-sdk/channel-setup` 中的 `createOptionalChannelSetupSurface`： @@ -446,30 +451,26 @@ const setupSurface = createOptionalChannelSetupSurface({ npmSpec: "@myorg/openclaw-my-channel", docsPath: "/channels/my-channel", }); -// Returns { setupAdapter, setupWizard } +// 返回 { setupAdapter, setupWizard } ``` `plugin-sdk/channel-setup` 还暴露了更底层的 `createOptionalChannelSetupAdapter(...)` 和 -`createOptionalChannelSetupWizard(...)` 构建器，用于你只需要该可选安装界面其中一半的情况。 +`createOptionalChannelSetupWizard(...)` 构建器，用于你只需要该可选安装界面其中一半能力的场景。 -生成的可选适配器 / 向导在真正写入配置时会以关闭方式失败。它们会在 -`validateInput`、`applyAccountConfig` 和 `finalize` -之间复用同一条“需要安装”的消息，并在设置了 `docsPath` -时附加一个文档链接。 +生成的可选适配器 / 向导在真实配置写入时会默认拒绝失败关闭。它们会在 +`validateInput`、`applyAccountConfig` 和 `finalize` 之间复用一条“需要安装”的提示信息，并在设置了 `docsPath` 时附加文档链接。 -对于基于二进制文件的设置 UI，优先使用共享的委托辅助工具，而不是在每个渠道中复制相同的二进制 / 状态粘合逻辑： +对于由二进制驱动的设置 UI，应优先使用共享的委托辅助工具，而不是在每个渠道中复制相同的二进制 / 状态粘合逻辑： -- `createDetectedBinaryStatus(...)`：用于仅在标签、提示、分数和二进制检测上变化的状态块 +- `createDetectedBinaryStatus(...)`：用于仅在标签、提示、分数和二进制检测上有所不同的状态块 - `createCliPathTextInput(...)`：用于基于路径的文本输入 - `createDelegatedSetupWizardStatusResolvers(...)`、 `createDelegatedPrepare(...)`、`createDelegatedFinalize(...)` 和 - `createDelegatedResolveConfigured(...)`：用于当 `setupEntry` - 需要惰性转发到更重量级的完整向导时 -- `createDelegatedTextInputShouldPrompt(...)`：用于当 `setupEntry` - 只需要委托一个 `textInputs[*].shouldPrompt` 判断时 + `createDelegatedResolveConfigured(...)`：用于当 `setupEntry` 需要惰性转发到更重的完整向导时 +- `createDelegatedTextInputShouldPrompt(...)`：用于当 `setupEntry` 只需要委托 `textInputs[*].shouldPrompt` 决策时 -## 发布和安装 +## 发布与安装 **外部插件：** 发布到 [ClawHub](/zh-CN/tools/clawhub) 或 npm，然后安装： @@ -480,16 +481,16 @@ openclaw plugins install @myorg/openclaw-my-plugin OpenClaw 会先尝试 ClawHub，并在失败后自动回退到 npm。你也可以显式强制使用 ClawHub： ```bash -openclaw plugins install clawhub:@myorg/openclaw-my-plugin # ClawHub only +openclaw plugins install clawhub:@myorg/openclaw-my-plugin # 仅 ClawHub ``` -没有对应的 `npm:` 覆盖方式。当你希望在 ClawHub 回退后走 npm 路径时，请使用普通的 npm 包 spec： +没有对应的 `npm:` 覆盖写法。当你希望在 ClawHub 回退后走 npm 路径时，请使用普通的 npm 包 spec： ```bash openclaw plugins install @myorg/openclaw-my-plugin ``` -**仓库内插件：** 放在内置插件工作区目录树下，它们会在构建期间自动被发现。 +**仓库内插件：** 放在内置插件工作区树下，构建期间会自动发现。 **用户可以安装：** @@ -499,13 +500,13 @@ openclaw plugins install 对于来源于 npm 的安装，`openclaw plugins install` 会运行 - `npm install --ignore-scripts`（不执行生命周期脚本）。请保持插件依赖树为纯 JS/TS，并避免使用需要 `postinstall` 构建的包。 + `npm install --ignore-scripts`（不执行 lifecycle scripts）。请保持插件依赖树为纯 JS / TS，并避免使用需要 `postinstall` 构建的包。 -内置的 OpenClaw 自有插件是唯一的启动修复例外：当打包安装检测到某个插件因插件配置、旧版渠道配置或其内置默认启用清单而处于启用状态时，启动过程会在导入前为该插件安装缺失的运行时依赖。第三方插件不应依赖启动时安装；请继续使用显式的插件安装器。 +内置的 OpenClaw 自有插件是唯一的启动修复例外：当打包安装检测到某个插件已通过插件配置、旧版渠道配置或其内置默认启用清单启用时，启动流程会在导入前为该插件安装缺失的运行时依赖。第三方插件不应依赖启动期安装；请继续使用显式的插件安装器。 ## 相关内容 -- [SDK 入口点](/zh-CN/plugins/sdk-entrypoints) -- `definePluginEntry` 和 `defineChannelPluginEntry` -- [插件清单](/zh-CN/plugins/manifest) -- 完整清单模式参考 +- [SDK 概览 入口点](/zh-CN/plugins/sdk-entrypoints) -- `definePluginEntry` 和 `defineChannelPluginEntry` +- [插件清单](/zh-CN/plugins/manifest) -- 完整清单 schema 参考 - [构建插件](/zh-CN/plugins/building-plugins) -- 分步入门指南 diff --git a/docs/zh-CN/reference/RELEASING.md b/docs/zh-CN/reference/RELEASING.md index 21c918364..65fcc0fd3 100644 --- a/docs/zh-CN/reference/RELEASING.md +++ b/docs/zh-CN/reference/RELEASING.md @@ -5,165 +5,182 @@ read_when: summary: 公开发布渠道、版本命名和发布节奏 title: 发布策略 x-i18n: - generated_at: "2026-04-21T04:34:57Z" + generated_at: "2026-04-23T05:14:53Z" model: gpt-5.4 provider: openai - source_hash: 356844708f6ecdae4acfcce853ce16ae962914a9fdd1cfc38a22ac4c439ba172 + source_hash: edb86d97a37e400a4041f1e087c90d9a4f26087cc5da5c37d11f7ca58dba9404 source_path: reference/RELEASING.md workflow: 15 --- # 发布策略 -OpenClaw 有三个公开发布通道： +OpenClaw 有三个公开发布渠道： -- stable：带标签的发布，默认发布到 npm `beta`，或在明确请求时发布到 npm `latest` +- stable：带标签的发布，默认发布到 npm `beta`，或在明确指定时发布到 npm `latest` - beta：预发布标签，发布到 npm `beta` - dev：`main` 的持续更新头部版本 ## 版本命名 -- stable 发布版本：`YYYY.M.D` +- 稳定版发布版本：`YYYY.M.D` - Git 标签：`vYYYY.M.D` -- stable 修正版发布版本：`YYYY.M.D-N` +- 稳定版修正版发布版本：`YYYY.M.D-N` - Git 标签：`vYYYY.M.D-N` -- beta 预发布版本：`YYYY.M.D-beta.N` +- Beta 预发布版本：`YYYY.M.D-beta.N` - Git 标签：`vYYYY.M.D-beta.N` - 月和日不要补零 -- `latest` 表示当前已提升为正式版的 stable npm 发布 +- `latest` 表示当前已提升的稳定版 npm 发布 - `beta` 表示当前 beta 安装目标 -- stable 和 stable 修正版发布默认发布到 npm `beta`；发布操作人员可以明确指定目标为 `latest`，或稍后再将经过验证的 beta 构建提升过去 -- 每个 stable OpenClaw 发布都会同时发布 npm 包和 macOS 应用； - beta 发布通常会先验证并发布 npm/包路径，而 mac 应用的构建/签名/公证通常保留给 stable，除非有明确请求 +- 稳定版和稳定版修正版默认发布到 npm `beta`；发布操作人员可以明确指定目标为 `latest`，或者稍后再将已验证的 beta 构建提升过去 +- 每个稳定版 OpenClaw 发布都会同时交付 npm 包和 macOS 应用； + beta 发布通常会先验证并发布 npm/package 路径，而 mac 应用的构建 / 签名 / 公证则保留给稳定版，除非有明确要求 ## 发布节奏 -- 发布采用 beta 优先 -- 只有在最新 beta 验证通过后，才会跟进 stable +- 发布先走 beta +- 只有在最新 beta 完成验证后，才会跟进 stable - 维护者通常会从当前 `main` 创建 `release/YYYY.M.D` 分支来切发布， 这样发布验证和修复就不会阻塞 `main` 上的新开发 -- 如果 beta 标签已经推送或发布但需要修复，维护者会切下一个 - `-beta.N` 标签，而不是删除或重建旧的 beta 标签 -- 详细的发布流程、审批、凭证和恢复说明仅供维护者使用 +- 如果某个 beta 标签已经被推送或发布且需要修复，维护者会切下一个 + `-beta.N` 标签，而不是删除或重新创建旧的 beta 标签 +- 详细的发布流程、审批、凭证和恢复说明仅面向维护者 ## 发布预检 -- 在发布预检前运行 `pnpm check:test-types`，这样测试 TypeScript 就能在更快的本地 `pnpm check` 门禁之外继续受到覆盖 -- 在发布预检前运行 `pnpm check:architecture`，这样更广泛的导入循环和架构边界检查就能在更快的本地门禁之外保持通过 -- 在 `pnpm release:check` 之前运行 `pnpm build && pnpm ui:build`，这样打包验证步骤所需的 - `dist/*` 发布产物和 Control UI bundle 就会存在 -- 每次带标签发布前都要运行 `pnpm release:check` +- 在发布预检前运行 `pnpm check:test-types`，这样测试 TypeScript 也能获得覆盖， + 不会被更快的本地 `pnpm check` 检查门槛遗漏 +- 在发布预检前运行 `pnpm check:architecture`，这样更全面的导入循环和架构边界检查 + 就能在更快的本地检查之外保持绿色 +- 在运行 `pnpm release:check` 之前先运行 `pnpm build && pnpm ui:build`， + 以确保打包验证步骤所需的 `dist/*` 发布产物和 Control UI bundle 已存在 +- 每次带标签的发布前都要运行 `pnpm release:check` - 发布检查现在在单独的手动工作流中运行： `OpenClaw Release Checks` +- `OpenClaw Release Checks` 还会在发布审批前运行 QA Lab 模拟一致性门槛和实时 + Telegram QA 通道。实时通道使用 + `qa-live-shared` 环境和 Convex CI 凭证租约。 - 跨操作系统的安装和升级运行时验证由私有调用方工作流 `openclaw/releases-private/.github/workflows/openclaw-cross-os-release-checks.yml` 发起，该工作流会调用可复用的公开工作流 `.github/workflows/openclaw-cross-os-release-checks-reusable.yml` -- 这种拆分是有意为之：让真正的 npm 发布路径保持简短、 - 确定且以产物为中心，而较慢的在线检查保留在独立通道中， - 这样它们就不会拖慢或阻塞发布 +- 这种拆分是有意为之：让真实的 npm 发布路径保持简短、 + 可预测且聚焦产物，而较慢的实时检查保留在它们自己的通道中， + 这样就不会拖慢或阻塞发布 - 发布检查必须从 `main` 工作流引用或 - `release/YYYY.M.D` 工作流引用发起，这样工作流逻辑和密钥始终受控 -- 该工作流接受现有发布标签，或当前完整的 + `release/YYYY.M.D` 工作流引用发起，这样工作流逻辑和密钥才能保持受控 +- 该工作流接受已有的发布标签，或当前完整的 40 字符工作流分支提交 SHA -- 在 commit-SHA 模式下，它只接受当前工作流分支的 HEAD；较早的发布提交请使用发布标签 +- 在提交 SHA 模式下，它只接受当前工作流分支的 HEAD；较旧的发布提交请使用 + 发布标签 - `OpenClaw NPM Release` 的仅验证预检也接受当前完整的 - 40 字符工作流分支提交 SHA，而不要求已推送标签 + 40 字符工作流分支提交 SHA，无需先推送标签 - 该 SHA 路径仅用于验证，不能提升为真实发布 -- 在 SHA 模式下，工作流只会为包元数据检查合成 `v`；真实发布仍然需要真实的发布标签 -- 这两个工作流都将真实发布和提升路径保留在 GitHub 托管的 runner 上， - 而不改动状态的验证路径可以使用更大的 +- 在 SHA 模式下，工作流只会为包元数据检查临时生成 + `v`；真实发布仍然需要真实的发布标签 +- 这两个工作流都会将真实发布和提升路径保留在 GitHub 托管的 + runner 上，而非变更性的验证路径则可以使用更大的 Blacksmith Linux runner -- 该工作流运行 +- 该工作流会运行 `OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_CACHE_TEST=1 pnpm test:live:cache` 并同时使用 `OPENAI_API_KEY` 和 `ANTHROPIC_API_KEY` 工作流密钥 - npm 发布预检不再等待单独的发布检查通道 -- 在批准前运行 `RELEASE_TAG=vYYYY.M.D node --import tsx scripts/openclaw-npm-release-check.ts` - （或对应的 beta/修正版标签） +- 在审批前运行 `RELEASE_TAG=vYYYY.M.D node --import tsx scripts/openclaw-npm-release-check.ts` + （或对应的 beta / 修正版标签） - npm 发布后，运行 `node --import tsx scripts/openclaw-npm-postpublish-verify.ts YYYY.M.D` - （或对应的 beta/修正版版本）以在全新的临时前缀中验证已发布注册表安装路径 -- 维护者发布自动化现在采用先预检再提升： + （或对应的 beta / 修正版版本），以在新的临时前缀中验证已发布的注册表安装路径 +- 维护者发布自动化现在采用先预检后提升的方式： - 真实 npm 发布必须通过成功的 npm `preflight_run_id` - 真实 npm 发布必须从与成功预检运行相同的 `main` 或 `release/YYYY.M.D` 分支发起 - - stable npm 发布默认目标为 `beta` - - stable npm 发布可以通过工作流输入明确将目标设为 `latest` + - 稳定版 npm 发布默认使用 `beta` + - 稳定版 npm 发布可以通过工作流输入明确指定目标为 `latest` - 基于令牌的 npm dist-tag 变更现在位于 `openclaw/releases-private/.github/workflows/openclaw-npm-dist-tags.yml` - 中，以增强安全性，因为 `npm dist-tag add` 仍然需要 `NPM_TOKEN`，而公开仓库保持仅使用 OIDC 发布 + 中，以提升安全性，因为 `npm dist-tag add` 仍然需要 `NPM_TOKEN`， + 而公开仓库保留仅 OIDC 的发布方式 - 公开的 `macOS Release` 仅用于验证 - 真实的私有 mac 发布必须通过成功的私有 mac `preflight_run_id` 和 `validate_run_id` - 真实发布路径会提升已准备好的产物，而不是再次重新构建 -- 对于像 `YYYY.M.D-N` 这样的 stable 修正版发布，发布后验证器还会检查从 `YYYY.M.D` 到 `YYYY.M.D-N` 的相同临时前缀升级路径， - 这样发布修正就不能悄悄让旧的全局安装仍停留在基础 stable 载荷上 -- npm 发布预检默认失败关闭，除非 tarball 同时包含 - `dist/control-ui/index.html` 和非空的 `dist/control-ui/assets/` 载荷， - 这样我们就不会再次发布一个空的浏览器仪表盘 -- `pnpm test:install:smoke` 还会对候选更新 tarball 强制执行 npm 打包 `unpackedSize` 预算， - 因此安装器端到端测试会在发布路径之前捕获意外的包体膨胀 -- 如果此次发布工作涉及 CI 规划、扩展时间清单或扩展测试矩阵， - 请在批准前从 `.github/workflows/ci.yml` 重新生成并审查由规划器负责的 +- 对于像 `YYYY.M.D-N` 这样的稳定版修正版发布，发布后验证器 + 还会检查从 `YYYY.M.D` 升级到 `YYYY.M.D-N` 的同一临时前缀升级路径， + 这样发布修正就不会在无声无息中让旧的全局安装停留在基础稳定版负载上 +- npm 发布预检会默认失败关闭，除非 tarball 同时包含 + `dist/control-ui/index.html` 和非空的 `dist/control-ui/assets/` 负载， + 以避免我们再次发布空的浏览器仪表盘 +- `pnpm test:install:smoke` 还会对候选更新 tarball 的 npm pack `unpackedSize` 预算执行强制检查， + 这样安装器 e2e 就能在发布路径之前捕获意外的打包膨胀 +- 如果发布工作涉及 CI 规划、扩展 timing 清单或 + 扩展测试矩阵，请在审批前重新生成并审查 + 来自 `.github/workflows/ci.yml` 的、由 planner 负责的 `checks-node-extensions` 工作流矩阵输出， - 这样发布说明就不会描述过时的 CI 布局 -- stable macOS 发布就绪还包括更新器相关界面： + 以避免发布说明描述的是过时的 CI 布局 +- 稳定版 macOS 发布就绪还包括更新器相关界面： - GitHub 发布最终必须包含打包后的 `.zip`、`.dmg` 和 `.dSYM.zip` - - 发布后，`main` 上的 `appcast.xml` 必须指向新的 stable zip - - 打包后的应用必须保留非调试 bundle id、非空的 Sparkle feed + - 发布后，`main` 上的 `appcast.xml` 必须指向新的稳定版 zip + - 打包后的应用必须保持非调试 bundle id、非空的 Sparkle feed URL，以及不低于该发布版本规范 Sparkle 构建下限的 `CFBundleVersion` ## NPM 工作流输入 `OpenClaw NPM Release` 接受以下由操作人员控制的输入： -- `tag`：必填发布标签，例如 `v2026.4.2`、`v2026.4.2-1` 或 - `v2026.4.2-beta.1`；当 `preflight_only=true` 时，也可以是当前完整的 - 40 字符工作流分支提交 SHA，用于仅验证的预检 -- `preflight_only`：`true` 表示仅验证/构建/打包，`false` 表示真实发布路径 -- `preflight_run_id`：在真实发布路径中必填，这样工作流会复用成功预检运行中准备好的 tarball +- `tag`：必填的发布标签，例如 `v2026.4.2`、`v2026.4.2-1`，或 + `v2026.4.2-beta.1`；当 `preflight_only=true` 时，也可以是当前 + 完整的 40 字符工作流分支提交 SHA，用于仅验证的预检 +- `preflight_only`：`true` 表示仅进行验证 / 构建 / 打包，`false` 表示进入 + 真实发布路径 +- `preflight_run_id`：在真实发布路径中必填，这样工作流就会复用成功预检运行中准备好的 tarball - `npm_dist_tag`：发布路径的 npm 目标标签；默认为 `beta` `OpenClaw Release Checks` 接受以下由操作人员控制的输入： -- `ref`：现有发布标签，或在从 `main` 发起时用于验证的当前完整 - 40 字符 `main` 提交 SHA；如果从发布分支发起，则使用现有发布标签或当前完整的 - 40 字符发布分支提交 SHA +- `ref`：已有发布标签，或从 `main` 发起时要验证的当前完整 + 40 字符 `main` 提交 SHA；如果从发布分支发起，请使用已有的发布标签 + 或当前完整的 40 字符发布分支提交 SHA 规则： -- stable 和修正版标签可以发布到 `beta` 或 `latest` -- beta 预发布标签只能发布到 `beta` +- 稳定版和修正版标签可以发布到 `beta` 或 `latest` +- Beta 预发布标签只能发布到 `beta` - 对于 `OpenClaw NPM Release`，只有在 `preflight_only=true` 时才允许使用完整提交 SHA 作为输入 -- `OpenClaw Release Checks` 始终仅用于验证，也接受当前工作流分支提交 SHA -- 发布检查的 commit-SHA 模式还要求当前工作流分支 HEAD -- 真实发布路径必须使用预检期间使用的同一个 `npm_dist_tag`； +- `OpenClaw Release Checks` 始终仅用于验证，也接受 + 当前工作流分支提交 SHA +- 发布检查的提交 SHA 模式还要求必须是当前工作流分支 HEAD +- 真实发布路径必须使用与预检期间相同的 `npm_dist_tag`； 工作流会在继续发布前验证该元数据 -## Stable npm 发布顺序 +## 稳定版 npm 发布顺序 -在切一个 stable npm 发布时： +在切稳定版 npm 发布时： -1. 使用 `preflight_only=true` 运行 `OpenClaw NPM Release` +1. 运行 `OpenClaw NPM Release`，并设置 `preflight_only=true` - 在标签尚不存在时，你可以使用当前完整的工作流分支提交 - SHA，对预检工作流执行一次仅验证的干运行 -2. 为正常的 beta 优先流程选择 `npm_dist_tag=beta`，或仅在你明确希望直接发布 stable 时选择 `latest` -3. 单独运行 `OpenClaw Release Checks`，使用相同的标签，或在你希望获得在线 prompt cache 覆盖时使用完整的当前工作流分支提交 SHA - - 这样刻意拆分，是为了在不把长时间运行或易波动检查重新耦合回发布工作流的前提下，继续提供在线覆盖 + SHA，对预检工作流进行仅验证的试运行 +2. 按照正常的先 beta 后 stable 流程选择 `npm_dist_tag=beta`，或者仅在你有意直接发布稳定版时选择 `latest` +3. 单独运行 `OpenClaw Release Checks`，使用相同的标签，或者在你想获得实时 prompt cache、 + QA Lab 一致性和实时 Telegram 覆盖时，使用当前完整的工作流分支提交 SHA + - 之所以刻意分离，是为了在不重新耦合长时间运行或不稳定检查到发布工作流的前提下， + 仍然保留实时覆盖能力 4. 保存成功的 `preflight_run_id` -5. 再次运行 `OpenClaw NPM Release`，这次使用 `preflight_only=false`，并带上相同的 - `tag`、相同的 `npm_dist_tag`，以及保存下来的 `preflight_run_id` -6. 如果该发布先落在 `beta`，使用私有的 +5. 再次运行 `OpenClaw NPM Release`，并设置 `preflight_only=false`，同时使用相同的 + `tag`、相同的 `npm_dist_tag`，以及已保存的 `preflight_run_id` +6. 如果该发布先落在 `beta`，请使用私有的 `openclaw/releases-private/.github/workflows/openclaw-npm-dist-tags.yml` - 工作流将该 stable 版本从 `beta` 提升到 `latest` -7. 如果该发布有意直接发布到 `latest`，并且 `beta` - 也应立即跟随相同的 stable 构建，请使用同一个私有工作流让两个 dist-tag 都指向该 stable 版本，或让其计划内的自修复同步稍后再移动 `beta` + 工作流，将该稳定版从 `beta` 提升到 `latest` +7. 如果该发布是有意直接发布到 `latest`，并且 `beta` + 也应立即跟随同一个稳定版构建，请使用同一个私有工作流 + 将两个 dist-tag 都指向该稳定版，或者交由其定时 + 自愈同步稍后再推动 `beta` -dist-tag 变更位于私有仓库中是出于安全考虑，因为它仍然需要 -`NPM_TOKEN`，而公开仓库保持仅使用 OIDC 发布。 +dist-tag 变更之所以放在私有仓库中，是出于安全考虑，因为它仍然 +需要 `NPM_TOKEN`，而公开仓库保留仅 OIDC 的发布方式。 -这样，直接发布路径和 beta 优先提升路径都保持了文档化且对操作人员可见。 +这样既记录了直接发布路径，也记录了先 beta 再提升的路径，并且两者 +都对操作人员可见。 ## 公开参考 @@ -176,4 +193,4 @@ dist-tag 变更位于私有仓库中是出于安全考虑，因为它仍然需 维护者会使用私有发布文档 [`openclaw/maintainers/release/README.md`](https://github.com/openclaw/maintainers/blob/main/release/README.md) -作为实际操作手册。 +作为实际运行手册。