AGENTS.md · git:20261029.469f3de · 2026-10-29 · sha256 3b4eb44cb0fb8bab
AGENTS.md git:20261029.469f3deB
Immutable. This exact content never changes and is served at /api/v1/blob/3b4eb44cb0fb8bab.
# AGENTS.md —— 项目规则（`modelmux`）
本文件只写本仓库特有的约束与流程；项目介绍见 [README.md](README.md)，详细设计见 [docs/README.md](docs/README.md)
（契约 / 池化 / 存储 / 守护进程 / 日志 / Web 控制台 / 模块注释）。
## 仓库结构与约束
目录树见 [README.md](README.md)。本仓库的结构约束如下：
1. `packages/` 只允许 `cli` / `ui` / `core` 三个直接子目录；新增包必须归入其中之一。
2. `packages/core/gateway` 是共享层，**不许出现任何渠道知识**（厂商名、渠道特有字段、渠道模型名一律不得硬编码）。
3. `packages/core/channels/<cid>` 是渠道包，只实现 4 个渠道特有模块（`cred` / `upstream` / `catalog` / `billing`）；
加上通用入口 `channel` / `cli` / `index`，`src/` 共 7 个文件，其余一律复用共享层。
工作区布局、7 文件契约与模块接口的完整说明见 [docs/CONTRACT-TS.md](docs/CONTRACT-TS.md) §1 与 §5。
## 命令与构建
用户侧的安装与常用命令见 [README.md](README.md)；这里只列仓库内开发、构建与验证命令。
### 命令
```bash
npm install # 装工作区依赖（含软链）
npm run build # 全仓编译（tsc -b 增量 + cli 单文件 bundle + copy-ui）
npm test # build + typecheck + 全部 verify:* + 全部包的测试（Windows 侧快速反馈）
npm run typecheck # 全工作区类型检查（UI 也在内；新增包必须带 typecheck 脚本）
npm run gate # 【推送前必须】推送门禁：干净 clone → npm ci → npm test
npm run build --workspace=packages/core/channels/<cid> # 只编一个渠道（也走引用链）
node packages/cli/dist/cli.js --help # 仓库级 CLI：多渠道路由，唯一网关端口 4412（REPO_DEFAULT_ADDR）
node packages/cli/dist/cli.js model list # 池视图：有哪些模型（按渠道分组）
node packages/cli/dist/cli.js model usage # 池账本：各渠道用得怎么样（每渠道一行）；--refresh 立刻重查
node packages/cli/dist/cli.js <动词> [<cid>] # 渠道动词：status / login / relogin / logout / model / bill / acct / path / log
node packages/core/channels/<cid>/dist/cli.js --help # 单渠道 CLI（调试/回归用；只有它才用该渠道的 defaultAddr）
```
1. **命令形态（动词优先）**：`mx <动词> [<cid>] [参数...]`。动词永远在第一个位置，渠道 id 是第二个位置的操作对象。
示例：`mx login traecn` / `mx status traecn` / `mx model traecn`。
2. 对齐 `git` / `docker` / `gh` / `kubectl` / `npm` 的心智（`<动词> [<对象>]`），也让 `mx login <TAB>`
能直接补全渠道名 —— 补全器只需在位置 2 补「已注册渠道」这一个维度。
3. **命令组**（名词在位置 1、子命令在位置 2）同样遵循「动词在前」：`mx model list` / `mx model usage`。
4. **渠道动词**：`status` / `login` / `relogin` / `logout` / `model` / `bill` / `acct` / `path` / `log`，可带 cid。
不带 cid 时各动词回落仓库级语义：`status` 聚合全部渠道、`bill` 全部渠道、`path` 全部渠道、
`log` 网关日志；`login` / `relogin` / `logout` 在多渠道路由下必须给 cid。
⚠ `logout` 是**本地登出**（删凭据 + 清空该渠道账号池）；它**不吊销上游会话** ——
各渠道的登出端点几乎都需要活会话（外部拿不到），要彻底登出得去官方客户端操作。
5. **仓库级动词**：`start` / `stop` / `restart` / `serve` / `web`，不接受渠道 id。
6. **反面写法 `mx <cid> <动词>` 一律不采用**：渠道名与动词共享位置 1 的命名空间会让两者二义
（一旦某个渠道叫 `model` 会引起二义），且与主流 CLI 心智相悖。
7. 命令形态的完整设计见 [docs/CONTRACT-TS.md](docs/CONTRACT-TS.md) §9；日志命令参数见 [docs/LOGGING.md](docs/LOGGING.md)。
### 单端口与 Web
1. 仓库级网关只监听**一个**端口（`REPO_DEFAULT_ADDR = 127.0.0.1:4412`），Web 控制台与网关**共用该端口**，
挂在 `REPO_UI_PREFIX = /web` 下（控制台 API 位于 `/web/api/*`）。
2. `ChannelConfig.defaultAddr` / `uiPort` 只在**单渠道独立运行**时生效；`--addr` 可覆盖。
3. 路由分工：`/` `/v1/*` `/health` 归网关；`/web` 与 `/web/*` 归控制台 handler；
不注入控制台时网关是纯 API 服务。
4. `mx web` = 「确保网关在跑 → 打开 `http://127.0.0.1:4412/web/`」，不再起独立进程。
5. Web 控制台的页面、数据通道与构建见 [docs/WEB-CONSOLE.md](docs/WEB-CONSOLE.md)；
进程生命周期见 [docs/DAEMON-SUPERVISOR.md](docs/DAEMON-SUPERVISOR.md)。
### 构建模型
1. 根 `tsconfig.json` 是 *solution* 文件（`files: []` + `references` 列出全部包），
公共编译选项在根 `tsconfig.base.json`（各包 `extends` 它）；`tsc -b` 一次调度整个依赖图，
产物落在各包 `dist/`，增量状态在 `dist/tsconfig.tsbuildinfo`。
2. `npm run build` 末尾追加 `packages/cli` 的 bundle 步骤（esbuild 内联成 `dist/cli.bundle.js`）。
**这一步不能省**：全局 `mx` / `modelmux` 的 `bin` 指向该 bundle。
3. `npm run build` 末尾还要跑 `scripts/copy-ui.mjs`，把 UI 产物拷到**两个**落点
（`packages/core/gateway/dist/ui` 与 `packages/cli/dist/ui`）—— 少拷一份，全局 `mx web` 就报「UI 未构建」。
4. 发布构建与 UI 产物落点的完整说明见 [docs/CONTRACT-TS.md](docs/CONTRACT-TS.md) §2.1 与
[docs/WEB-CONSOLE.md](docs/WEB-CONSOLE.md) 的「技术栈与构建」。
5. **`packages/ui` 不在 solution 的 references 里**：solution 是 **emit 图**（谁产 JS 谁在里面），
而 UI 的产物由 `vite build` 出（`tsc` 对它只做类型检查）。把它塞进 solution 只会逼出
假的声明产物（TS 不允许 composite + noEmit）。
⚠ 但**类型检查不能因此缺席**：`npm test` 的链里有 `npm run typecheck`（全工作区），
且 `scripts/verify-contract.mjs` 会检查**每个工作区包都有 `typecheck` 脚本** ——
新增包漏写就直接红，不会重演「UI 类型错误长期无人拦截」。
### 常见任务速查
**动作命令的唯一事实源** —— 常驻本节，不依赖技能触发（技能可能不触发，这里一定读得到）。
规则 / 契约 / 事实**不在此表**（那些在 `docs/`）；本表只回答「要做这件事，敲什么」。
| 要做的事 | 命令 |
| --- | --- |
| 起网关（幂等） | `mx start`（脚本里加 `--strict` 让超时非零退出） |
| 停 / 重启网关 | `mx stop` / `mx restart` |
| 前台调试运行 | `mx serve`（无监督直跑，不落 PID） |
| 看网关与全部渠道状态 | `mx status` |
| 看某渠道状态 | `mx status <cid>` |
| **确认没有陈旧构建** | `mx status --json` → `stale_build` 必须为 `false` |
| 看池里有哪些模型 | `mx model list` |
| 看各渠道用得怎么样 | `mx model usage` / `mx model usage --refresh` |
| 看某渠道的模型与倍率 | `mx model <cid>` / `mx model <cid> --refresh` |
| 看额度 / 账单 | `mx bill [<cid>]`（**直连上游**，不经网关）；`--accounts` 逐账号列（池内 ≥2 个账号时默认列出） |
| 登录 | `mx login <cid>`（已有凭据时幂等）；`mx login list` 看可登录渠道 |
| 强制重新授权 | `mx relogin <cid>`（清主凭据后重走授权，**不是**刷新） |
| 看账号池 | `mx acct <cid>` / `mx acct <cid> list` |
| 切生效账号 | `mx acct <cid> use <key>` |
| 加 / 删账号 | `mx acct <cid> add`（必须给 cid） / `mx acct <cid> remove <key>` |
| 看存储落点 | `mx path [<cid>]` / `mx path --all` |
| 打开 Web 控制台 | `mx web`（确保网关在跑并打印 `/web/`；加 `--open` 才开浏览器） |
| **发版（打 tag）** | 改全部版本号落点（各 `package.json` + 渠道 `channel.ts`）→ `chore(release): 发布 vX.Y.Z` 提交 → PR 合并 → 在 main 打 `vX.Y.Z` tag；**不建 Release**（见「版本与发版」） |
| **查日志 / 排查故障** | 走 `log-triage` 技能（`mx log` 的 `--kind` / `--outcome` / `--date` 组合与判读都在那儿） |
| **压缩存量日志正文**（维护，非日常） | `mx log --compact`（把已封存轮转段里仍是明文的抓取正文压成压缩态；新写入本就压缩，见 [docs/LOGGING.md](docs/LOGGING.md) §9） |
命令形态的完整设计（动词优先、为什么 `mx <cid> <动词>` 不可用）见 `.agents/skills/mx-cli/SKILL.md` §0
与 [docs/CONTRACT-TS.md](docs/CONTRACT-TS.md) §9。
> 改动 `packages/core/**`、`packages/cli/**`、`packages/ui/**` 后**必须** `npm run build`
> → `mx restart` → 确认 `stale_build=false`（见下方「改动后的执行顺序」）。
## 分支与重构
**强制**。
1. 本仓库的「大规模修改」判定（命中任一即必须开分支，与全局规则中的「大改造」同义）：
- 改动跨越 `packages/` 下两个及以上包；
- 涉及目录结构、包边界、`workspaces`、`tsconfig` references 的调整；
- 涉及契约变更（`docs/CONTRACT-TS.md`）、存储落点（`docs/STORAGE-CONVENTION.md`）、
池架构（`docs/POOL-ARCHITECTURE.md`）的规则修改；
- 对外 API 形态或模型 id 形态的变更；
- 预计改动文件数超过 20 个。
2. 大规模修改的分支流程按全局规则执行；完成后必须走完整流程：推送 → 建 PR → CI 全绿 → rebase 合并 → 删除分支。
合并方式的细则见「提交信息规范 / 合并方式」。
### 分支与 PR 的节奏（**攒够一批再走，不是每次改动都走**）
`main` 有分支保护（`enforce_admins=true` + 必需 `test (node 22)` / `test (node 24)` 双状态检查），
**没有直推这条路** —— 任何上远端的改动都只能走 PR。但 PR 的**节奏**按改动规模分：
| 改动规模 | 节奏 |
|---|---|
| 大规模改动（命中上面 5 条判定） | **立即开分支**，完成一批即走完整流程：提交 → `npm run gate` → push → 建 PR → CI 双绿 → rebase 合并 → 删分支 |
| 小改动（单包、单文件、注释、文档、UI 微调等，未命中任何一条） | **先本地 commit 攒着**（main 上直接提交、不上远端），攒够一批或需要让改动生效时，再一次性走 PR |
⚠ 无论哪种节奏，**推送前**的约束都一样，不因改动小而放宽：
1. `npm test` 全绿（含 typecheck 与全部 `verify:*`）；
2. `npm run gate`（推送门禁）全绿 —— `.githooks/pre-push` 会自动再跑一次，禁止 `--no-verify`；
3. 提交信息符合 `type(scope): 中文描述`（`verify:commits` 在 `npm test` 里校验）；
4. 文档与代码**同一个 commit** 更新。
> 一句话：**main 禁直推，改动必须走 PR；但小改动先攒本地 commit，攒够了再一个 PR 上去**，
> 不要一个 commit 开一个 PR。
## Worktree 约束
**按需使用**。仓库只有一个网关端口 4412 和共享的 `~/.modelmux` 存储根，worktree 不能用来
并行跑两个真实网关。
1. 什么时候开：
- 多个 agent 同时做互不依赖的分支；
- 一个长任务保留未提交改动，同时另一个任务要用 `main`；
- 一边 review PR 一边继续开发；
- 需要两套构建/测试产物做隔离对比（但不能同时跑真实网关 e2e）。
2. 什么时候不开：
- 简单顺序任务、单文件改动；
- 需要真实账号 + 真实网关的并行 e2e（端口与账号池状态会冲突）；
- 磁盘或安装时间不允许每棵树都跑 `npm ci`。
3. 落点：仓库同级目录 `../modelmux-worktrees/<branch>`，不要放在仓库根目录内
（`verify-docs` / `verify-storage` / npm workspaces 会扫到嵌套目录）。
4. 每棵树独立：`npm ci`、`dist/`、`node_modules/` 都不共享。
5. 全局 `mx` 指向主工作树的 bundle；在 worktree 里用 `node packages/cli/dist/cli.js`
或在该树里重新 `npm link`。
6. 并行任务用 `PLAN_ID` 绑定 `.planning/`，不要把计划文件写到别的树。
7. `.githooks/pre-push` 用 `git rev-parse --show-toplevel` 解析当前工作树；不要在 hook 里
用 hook 文件所在目录推导仓库根（linked worktree 会指到主工作树）。
8. 清理：`git worktree remove <path>`，再 `git worktree prune`。
## 文档规则
**强制**。
1. **所有文档集中在根 `docs/`**：规范与契约在 `docs/*.md`，渠道文档在 `docs/channels/<cid>/`。
渠道包目录（`packages/core/channels/<cid>/`）只放**实现**（`src/` 的 7 个文件）与包配置，
**不再带 `docs/`**。
2. 各类文档的落点：
| 类别 | 位置 | 内容 |
| --- | --- | --- |
| 契约与规范 | `docs/*.md` | 改代码前必读；索引见 `docs/README.md` |
| 渠道协议规格 | `docs/channels/<cid>/PROTOCOL.md` | 实测协议（实现的依据）+ 该渠道的使用与实测 + 参考实现清单 |
| 逆向结论层 | `docs/channels/<cid>/FINDINGS.md` / `FLOW.md` | 结论汇总与端到端数据流（可选） |
| 渠道待实现项 | `docs/channels/<cid>/ROADMAP.md` | 该渠道的功能缺口清单与验收判据（**交接给后续 Agent 用**；可选） |
3. `.md` **只允许**落在以下位置（以 `scripts/verify-docs.mjs` 的 `ALLOWED` 为准）：
- `docs/` —— 契约与规范 + 文档总入口 `docs/README.md` + 渠道文档 `docs/channels/<cid>/`
- `README.md`（**仓库根**）—— 仓库门面，GitHub 只渲染根 README
- `AGENTS.md`（**仓库根**）—— 仓库级规则，工具从根读，不能搬
- `packages/core/channels/<cid>/AGENTS.md` —— 目录级工具指令（工具从目录读，不能搬）
- `.agents/skills/<name>/`（及 `.zcode/skills/` 覆盖位）—— 项目级技能整包
（`SKILL.md` + 引用 / 模板 / 脚本；第三方技能必须带 LICENSE 与来源说明）
4. 新增或修改文档时：
- 渠道协议 → `docs/channels/<cid>/PROTOCOL.md`；**渠道目录不留 `README.md`**
（通用用法写在 `docs/channels/README.md`，渠道差异写进各自的 `PROTOCOL.md`）——
11 份一模一样的样板文档是纯负担，`verify-docs` 会拦。
- **渠道文档不要散落进仓库级 `docs/` 根**（根层只放跨渠道的规范与契约）。
- 新增 `docs/*.md` 必须同时登记到 `docs/README.md` 的文档表；新增渠道目录要登记到
`docs/channels/README.md` 的渠道表。
- **新增技能必须登记到两张表**：`docs/README.md` 的「规则文件与项目技能」表
与**仓库根 `README.md`** 的「文档」表（后者是 GitHub 唯一渲染的门面，技能入口要在彼可达）。
技能是工具按目录发现的，但「有哪些技能、各自干什么」只有文档能回答 ——
**漏登记的技能等于不存在**（`verify-docs` 会拦，2026-10-26 实测：6 个技能里 2 个漏登记）。
- markdown 链接用**相对路径**；源码注释里的引用用**仓库根相对路径**
（如 `docs/channels/catpaw/PROTOCOL.md`）。
- 跑 `npm test`：`scripts/verify-docs.mjs` 拦住落错位置的 md，`scripts/verify-storage.mjs` 校验落点规范。
5. 本仓库不设 `archive/` 目录；RUN-LOG、已结项计划、已删渠道存档随任务结束删除，需要时从 git 历史取。
6. **逆向研究代码不保留**：
- 逆向 / 探针 / 解密脚本这类**一次性研究代码**（渠道目录下的 `research/`）**不入库**；
它的价值是结论，不是代码。结论必须落到 `docs/channels/<cid>/`（`PROTOCOL.md` /
`FINDINGS.md`，每条标注证据等级），代码用完即删。
- 逆向学习用的开源反代项目可 clone 到 `packages/core/channels/<cid>/reference/<owner>_<repo>/`
（`--depth 1`），由渠道级 `.gitignore` 的 `reference/` 条目忽略，**不入库**；
- 从参考实现学到的**结论**写进 `docs/channels/<cid>/PROTOCOL.md`（每条标注来源仓库与文件）；
- 渠道 `docs/channels/<cid>/PROTOCOL.md` 必须维护「参考实现」一节，列出全部已 clone 仓库的
**GitHub 链接**与一句话用途 —— 克隆或删除参考仓库时同步更新本节。
## 代码约定
1. 渠道包 `src/` **只能有 7 个文件**（`channel` / `cli` / `index` + `cred` / `upstream` / `catalog` / `billing`）；
多出来的共享模块副本一律删除。详见 `docs/CONTRACT-TS.md` §1 与 §5。
2. 零第三方运行依赖：渠道包 `dependencies` 只允许 `@modelmux/gateway`；共享层 `dependencies` 必须为空
（见 `docs/CONTRACT-TS.md` §2）。
3. **落点由共享层按 `cid` 推导**：渠道不许自己拼路径（见 `docs/STORAGE-CONVENTION.md`）。
4. 调用渠道模块前必须包 `runInChannel(cid, …)`（`AsyncLocalStorage` 上下文；
否则渠道内部的 `paths.*` 在多渠道路由下不知道为谁解析）。见 `docs/CONTRACT-TS.md` §1 与 §3。
5. 对外模型 id 是**动态模型池**，形态为 `<cid>/<规范模型名>`（如 `loomy/kimi-k2.6`）：
渠道由请求方通过前缀显式指定；模型段按各渠道 `catalog.exposedIds()` 归一化（恒小写），
渠道内去重、**跨渠道不合并**（`catpaw/glm-5.3-flash` 与 `raccoon/glm-5.3-flash` 是两个 id）。
裸模型名（无前缀）一律 400。模型收集与匹配见 `pool-targets.ts`，契约见 `docs/CONTRACT-TS.md` §4.1，
完整规则见 `docs/POOL-ARCHITECTURE.md` §2。
6. **共享层内部单向分层**（`scripts/verify-layering.mjs` 在 `npm test` 里强制）：
`runtime(0) < pool(1) / auth(1) < http(2) < app(3)` —— **只能 import 层级 ≤ 自己的目录**，
向上依赖一律失败。`index.ts` 是桶导出，不受限。
- `runtime/` = 渠道 SDK（channel / channel-context / paths / permissions / account-pool /
secret-file / catalog-cache / model-specs（模型规格表落点）/ cli-consts / credential-shape /
snapshot / logger（日志节流）/ log-store（分层落盘））
- `pool/` = 模型池与账本；`auth/` = 登录链路
- `http/` = 网关与转发；`app/` = 顶层门面与进程编排（`app/cli/` = CLI 门面，
`app/lifecycle/` = 守护 / worker / 监督者等进程生命周期）
- 需要跨层动作时**下沉或经回调注入**，不要直接向上 import。
- 极少数必要例外列在脚本的 `ALLOWLIST`（必须写理由）；新增例外要慎重，
且条目失效时（不再向上）脚本会报错要求删除。
目录分层见 [docs/CONTRACT-TS.md](docs/CONTRACT-TS.md) §1；规则由 `scripts/verify-layering.mjs` 强制。
7. 注释两层规范（内容层底线见全局 `~/.zcode/AGENTS.md`「代码与注释」，此处是本项目特有分工）：
- **what 去文档**：协议事实（端点、字段、状态码、实测数字）只活在
`docs/channels/<cid>/PROTOCOL.md`；代码注释出现同一事实的副本 = 违规，删副本留指针。
- **why 跟函数**：设计取舍写在被治理函数的 docstring 上；实测时点绑在事实上写
（时效地雷，见全局规则第 4 条），修订记录与署名禁写。
- **文件头只做导航（≤12 行）**：一句话职责 + 关键约束 ≤3 条 + 铁律（如需要）+ 指针。
模板与细则见 [`docs/MODULE-COMMENTS.md`](docs/MODULE-COMMENTS.md)，
内容判据与正反例见 [`docs/CODE-COMMENTS.md`](docs/CODE-COMMENTS.md)。
8. **Web 控制台禁止 hover 悬浮气泡**（`packages/ui/**` 硬规则，见
[`docs/WEB-CONSOLE.md`](docs/WEB-CONSOLE.md) §「交互铁律」）：
- 不用原生 `title=` 属性、不自建 hover tooltip / popover；
- 信息要么直接可见（写进正文、允许换行不裁切），要么放进**点击后**出现的详情区；
- 按钮的无障碍名称用 `aria-label`（不产生可见气泡），不要用 `title` 兼职；
- 原因：截图 / 投屏 / 触屏 / 键盘都拿不到 hover 内容，依赖悬停等于让信息只对鼠标可见。
## 测试规则
### 已知隐患：`--test-force-exit` 会静默丢结果（待修，别把「绿」当全跑）
`packages/core/gateway` 的测试命令带 `--test-force-exit`，为的是绕过「用例都过了、进程却退不出去」。
代价是**子进程被杀之前的结果会丢**：同一命令连跑，用例数在 378 ~ 419 之间波动（稳定值 **422**）。
实测事实（2026-10-29）：
- `node --test --test-timeout=20000 tests/*.test.ts`（去掉该标志）稳定报
`# tests 422 / # pass 419 / # fail 0 / # cancelled 3`、**退出码 1** —— 因为
`accounts.test.ts` / `chat-route.test.ts` / `cli.test.ts` **跑完不退进程**，
文件级用例被超时中止（用例本身全部通过）；带该标志时这次中止**不会被上报**，于是退出码 0。
- 单个文件单独跑也一样：`--test-timeout=3000/6000/20000` 分别正好耗时 3.05s/6.06s/20.06s
—— 说明时间全花在「等进程退出」，不是用例慢。
**修法**：查清这 3 个文件为何跑完不退（探针 `.tmp/probe-leak.mjs` / `probe-leak2.mjs`；
已排除 import 侧效应与测试内的 `child_process`/`cluster`），修掉后去掉 `--test-force-exit`，
并把 `# pass` 恒等于 422 作为回归判据。**在此之前**：怀疑「测试没跑到」时用
`node --test --test-timeout=20000 tests/*.test.ts` 手工复跑一遍（会如实报出被中止的文件）。
0. **Web / UI 改动必须做浏览器视觉校验（`agent-browser` 或 `control-browser` 技能）**：
- 改 `packages/ui/**`（布局、文案、状态、交互）后，**Agent 必须在真实浏览器里打开
`http://127.0.0.1:4412/web/` 逐页校验**，不能只看编译通过或 DOM 有内容就算完成。
只改数据（文案取值、状态枚举）且不影响几何布局时可免浏览器，其余一律要跑。
- 校验项（按专业术语逐条核对，而不是「看起来差不多」）：
1. **尺寸一致性**：同类卡片 / KPI 格 / 列表行在同一栅格下宽高相等（量化对比 `offsetWidth/offsetHeight`）；
2. **对齐（alignment）**：表头与单元格的列边界重合（逐列比对 `right` / `width`）；
左对齐列左边界一致、右对齐（数值）列右边界一致；多列面板底边对齐；
3. **栅格与间距（grid & spacing）**：列宽比例符合声明的栅格（如 8/4），列间距（gap）一致；
4. **内容适配（content fit）**：长文本截断（ellipsis）而非溢出/重叠；数字列用等宽数位（tabular-nums）；
5. **居中（centering）**：声明居中的列（如状态点、操作按钮）在列内水平居中；
6. **断点行为（responsive）**：至少核验 1280px 与更窄宽度下不破版（可折叠的默认折叠）。
- 报告结论时给出**实测数字**（如「10 张卡全部 509×240」「日志 8 列头/单元格右边缘逐一相同」），
不接受「已检查，正常」这类无证据结论。
- 两个技能都可用：仓库内无副本，按名称调用用户级 `agent-browser` 或
`control-browser`（browser-use 插件）；任一可用即可。
1. **渠道不写测试，只做端到端**：
- 渠道包（`packages/core/channels/<cid>/`）**不写任何单元测试 / 集成测试 / selftest**；
没有 `tests/` 目录，`package.json` 的 `scripts.test` 也不存在 —— 渠道测试唯一正确的形式是
**端到端测试**（整个网关 + 真实客户端 + 真实账号直连上游）。
- 端到端测试由 **Agent 跑 `opencode-mx-test` skill** 完成：该 skill 用 opencode CLI
直连 `http://127.0.0.1:4412/v1`，走 `<渠道>/<模型>` 池 id 对每个渠道发起真实 Agent
会话（文件读写、工具调用、多轮对话）—— 这才是用户视角下渠道是否跑得通的最终判据。
- 契约依据：[docs/CONTRACT-TS.md](docs/CONTRACT-TS.md) §7「渠道不做测试」。
2. **临时探测脚本写在 `.tmp/`，保留复用，不虚构凭证与请求头**：
- 探测 / 验证脚本放项目根 `.tmp/` 下（已归入 `.gitignore`，**不入库、不参与文档归属校验**）；
这类脚本**用真实账号、真实上游、正确形态的请求**去验证（例如刚修复的渠道跑了通不通）。
- **禁止**编写虚构请求头、虚构凭证、伪造 UA、伪造设备指纹等「仿真测试」——
虚构的请求头/凭据即使打到假上游，也不能证明真实渠道行为；撞到真上游则直接触发风控，
轻则 429/错误码，重则账号/IP 被封。
- **`.tmp/` 脚本默认保留，不要用完即删**：逆向与排查的脚本有长期复用价值
（下次同类问题直接改改用，比重新写一遍快得多），删掉等于让下一个人重写。
- 保留的代价只是磁盘，且已被 `.gitignore` 挡住 —— 故**不需要**为「整洁」而清理；
只有确实无意义的中间产物（抓包 dump、截图、临时 JSON）才随手删。
- 脚本要能被复用，就得**一眼看懂在做什么**：文件名说清用途（`probe-<目标>.mjs`），
头部写「干什么 / 怎么跑 / 依赖什么」，**绝不打印令牌原文**（只给指纹与长度）。
- 脚本的**结论**要落文档（渠道 `PROTOCOL.md` / 技能 `references/`），
脚本本身是工具，结论才是资产；两者都留，下次既能复用脚本，也知道结论是什么。
3. **测试流程必须文档化，让后续 Agent 可复现**：
- 每修复一个渠道或改动上游协议，**同步更新该渠道 `docs/channels/<cid>/PROTOCOL.md`**，记录实测结论
（端点、方法、请求头约束、实测状态码）；**同步更新 `docs/README.md`**（索引入口）与
`AGENTS.md` 测试规则。
- 端到端测试覆盖（登录入池 / `mx model <cid> --refresh` / 最小对话 / 工具往返 / 流式 SSE）
应在渠道 `docs/channels/<cid>/PROTOCOL.md` 的「使用与实测」小节列明，
供后续 Agent 按 `opencode-mx-test` skill 复现。
4. **端到端测试要发正确形态的请求，严禁向上游发任何故意畸形/会触发风控的载荷**：
- Agent 跑 `opencode-mx-test` skill、真机手动验收、扫码入池后验证、`.tmp/` 临时脚本，
**一律只发符合上游规范的正确请求**（普通 user 文本、合法的 tool_calls 往返、流式/非流式等
正常 OpenAI 兼容形态）。
- **绝不拿真实账号去「故意发错、验证归一化是否会修」**—— 那是让畸形载荷撞上游风控，轻则
触发 429/错误码，重则账号/IP 被封。网关归一化层的职责就是让错误请求**永远到不了上游**。
- 归一化管线对 object `tool_choice` / 数组 `stop` / `max_completion_tokens` / 工具序列修复 /
`reasoning_content` 回填的「错误输入 → 归一化」覆盖，**由代码审查 + 归一化前后 diff 人工核验**，
不靠运行时发请求来「验证修复」—— 发畸形请求本身就是一次风控事件。
5. **测试红线：禁止用 MODELMUX_HOME 伪装或本机假服务替身测渠道行为**：
- 端到端测试使用真实账号（扫码入池）直连真实上游，**不能用 MODELMUX_HOME 伪装、不能用
本机假服务替身**（那测的不是真实渠道行为，结论不可信）。
- **测试模型必须低费或免费**：优先倍率 0 的免费模型；没有免费模型时先 `mx bill <cid>` /
`mx model <cid>` 看额度与倍率，选当前渠道**倍率最低**的模型。**禁止**用高倍率旗舰
（`*-pro` / `*-max` / `kimi-k3` / 不带 flash 的 `glm-5.3` 等）；确需验证高倍率模型时，
只发**单轮最小对话**（一句短问 + 限制输出），并先说明理由。
6. **不许占用、更不许杀掉 4412 上的网关**（主人正在用它当模型通路）：
- 需要独立实例做验证时，用 `--addr 127.0.0.1:<其它端口>`（控制台端口用 `--ui-port`，
模型池 id 与存储根可继续共用）—— 例如 `node packages/cli/dist/cli.js serve --addr 127.0.0.1:4499`；
- `mx stop` / `taskkill` / `kill` 只允许针对**自己起的那个实例的 pid**；
- 「挂掉能否拉回」这类验证同理：改在临时端口上做，不要拿主人的 4412 当实验对象。
## 验证与推送
### 改动后的执行顺序
**强制**。改动 `packages/core/**`、`packages/cli/**`、`packages/ui/**` 后，按顺序完成：
1. **构建**：`npm run build`
2. **重启**：`node packages/cli/dist/cli.js restart`
3. **确认无陈旧构建**：`node packages/cli/dist/cli.js status` —— 输出必须**不含** `网关在跑旧代码`；
`status --json` 的 `stale_build` 必须为 `false`。
4. **真机验证**（仅涉及 `login` / `cred` / `upstream` 的改动强制）：走一遍
`mx login <cid>` → `mx status <cid>` → 一次真实对话。
禁止事项：
- 禁止只 `build` 不 `restart`。
- 禁止以「改动很小」「只改了注释」为由跳过 `restart`。
- 禁止在 `status` 报陈旧构建时继续验证或宣称修复生效。
- 禁止修改 `packages/core/gateway/src/app/lifecycle/stale-build.ts` 的判据来让 `status` 不再报警。
实现见 `packages/core/gateway/src/app/lifecycle/stale-build.ts`；事故记录见 `docs/CONTRACT-TS.md` 第 8 节「陈旧构建」。
### 推送门禁
**强制**。推送前必须跑与 CI 等价的命令；这是独立的一步，不是 `npm test` 的附加选项。
```bash
npm run gate # 完整门禁：干净 clone → npm ci → npm test
```
`.githooks/pre-push` 会自动调用同一条命令；手动跑的意义是提前发现。实现见 `scripts/gate.sh`
（`pre-push` 只是它的薄包装，两者共用同一份逻辑）。
#### 为什么必须 clone 到干净目录
| 差异 | 后果 |
| --- | --- |
| `verify:commits` 需要完整 git 历史（CI 用 `fetch-depth: 0`） | 浅克隆会漏 |
| `npm ci` 装**平台原生依赖**（esbuild 等） | 开发机上的残留依赖不代表 CI 能装 |
| 开发工作树自带未提交改动与陈旧产物（`dist/`） | 在工作树上跑，测的不是待推的那个提交 |
门禁因此总是 **clone 一份到干净目录**（默认 `/tmp/modelmux-gate`）再跑。
#### 各阶段的强制范围
| 改动范围 | 必须跑 |
| --- | --- |
| 任何改动 | `npm run gate`（含 `npm test`） |
| `.github/workflows/**`（任意 workflow） | 必须本地先跑通再推 |
> **演示构建发布到 GitHub Pages**：https://bluechonk.github.io/modelmux/ ——
> 由 `.github/workflows/demo-pages.yml` 在 push 到 main（命中 `packages/ui/**` 等路径）时
> 构建 `DEMO=1` 的**虚构数据包**并部署；真实控制台仍是**本机工具**，不上公网。
> 改了 workflow 必须先在本地跑通同一条命令（见 [docs/WEB-CONSOLE.md](docs/WEB-CONSOLE.md) 的「演示模式」）。
### 推送前检查
1. `npm test` 全绿（自带 `build` + `typecheck` + 全部 `verify:*`：`contract` / `storage` / `docs` /
`commits` / `topology` / `layering` / `wiring`，以及全部包的测试 —— 含共享层
`packages/core/gateway/tests/`）。
2. 测试链读的是各包 `dist/`（不是 `src/`），所以编译必须在链首：`npm test` 已内置 `npm run build`；
单独跑 `npm run verify:*` 或 `npm test --workspace=packages/core/channels/<cid>` 前必须先 `npm run build`。
3. 本地推送门禁全绿后才允许推送。
4. 文档与代码**同一个 commit** 更新。
5. 仓库内不要出现运行时数据；运行时目录在 `~/.modelmux/`，构建产物 `dist/` 与依赖 `node_modules/` 不入库。
6. 推送后核对 CI 必须是 `completed / success`；用 `gh pr checks <n>` / `gh run view <id>` 查看。
交付检查清单见 [docs/CONTRACT-TS.md](docs/CONTRACT-TS.md) §10。
### 禁止事项
- 本仓库的推送门禁不允许以「改动很小」「只改了注释/文档/CI 配置」为由跳过。
- **workflow 文件不许「改完直接推，看 CI 结果再说」** —— workflow 的失败模式通常只有真跑产物才暴露
（如 CI 的 node 版本矩阵与本地不一致），推到云上再改要多一轮提交。
## 版本与发版
**强制**。全局 `~/.zcode/AGENTS.md`「标签与发布」规定「打 tag → 出 Release」，
**本仓库只做前半步**：
1. **发版 = 打 tag，到此为止。不要建 GitHub Release**（`gh release create` / `gh release edit`
一律不用，`github:release` 技能与网页「Draft a new release」同样不用）——
本仓的发布物就是 tag 本身：仓库没有任何发布流程（无 `npm publish`、无产物打包 workflow、
不做 exe/安装包，只有 web 控制台与 CLI），Release 页面只承载一份版本说明，
而那份说明的权威来源是 `git log`。
⚠ 与全局规则的这一条冲突时**以本条为准**；**Releases 页必须保持为空**（`gh release list` 无输出）。
2. **版本号连续递增，不跳号**：发版前先核 `git tag -l` 与各 `package.json` 的 `version`，
按**实际**版本推下一个号 —— 本仓按 `0.1.x` 连续走（含新功能也只升修订位，
不做 `0.1 → 0.2` 的次位跳变，与全局升位规则不同，以本条为准）。
3. **版本号落点（下面每一处都要改；新增渠道时落点随之增加）**：
- 根 `package.json`，以及 `packages/cli` / `packages/ui` / `packages/core/gateway` /
**每个渠道包**的 `package.json`；
- **每个渠道包**的 `packages/core/channels/<cid>/src/channel.ts` 里的 `version` 字段
（`mx --version` 读它）；
- 根 `package-lock.json` 的两处（顶层 `version` 与 `packages[""].version`）；
- `docs/PROGRESS.md` 的「当前版本」。
提交信息 `chore(release): 发布 vX.Y.Z`，正文按类型归纳本版变更（体例对齐 v0.1.1 / v0.1.2）。
发版提交也走 PR（`main` 有分支保护），tag 打在**合并后的 main** 上。
4. **大面积功能 / 重构之后要主动提醒发新 tag**（提醒主人，**不要自己擅自发**）。
一轮工作结束时满足下列任一情形就提醒：
- 新渠道上线或渠道下线；
- 契约级行为变更（账号池、路由、日志、存储落点、CLI 命令形态）；
- 本轮 `feat` 类提交 ≥ 5 个，或改动跨 ≥ 2 个包；
- 距上一个 tag 已积累 ≥ 20 个提交。
提醒时一并给出：候选版本号（按第 2 条推）、自上个 tag 以来的提交数与 `feat` / `fix` 分布。
## 提交信息规范
提交信息格式按全局规则执行。本仓库补充：
1. `type` 额外允许 `merge`，专供合并提交。
2. 校验器 `scripts/verify-commits.mjs` 已接入 `npm test`。
3. **合并方式**：
- PR 统一用 rebase 合并：`gh pr merge <n> --rebase`；需要压缩时用 `--squash`。
- **禁止 merge commit**：仓库已关闭 merge commit；`verify:topology` 会拦截 tree 与任一父提交
相同的冗余 merge。
- PR 标题必须是 `type(scope): 中文描述` —— squash 会直接用它作为提交信息；rebase 保留
分支里的提交信息。
- 极少数长生命周期分支确需本地 `git merge --no-ff` 时，必须先确认 merge 的 tree 与两个父提交
都不同，并写 `merge(scope): 中文描述`；否则一律用 rebase。
- GitHub Actions 在 `pull_request` 事件里构造的临时合并提交（`Merge <sha> into <sha>`）
不由人编写、也不可修改，校验器会**自动跳过**，无需处理。