CLAUDE.md · diff
git:20261003.f7fea2c to git:20261008.a0989bc
1 added, 31 removed. Audit A to B.
- # TeamAI CLI
-
- CLI for syncing team skills, rules, docs, and env across AI coding tools. Package: [`teamai-cli`](https://www.npmjs.com/package/teamai-cli).
-
- TypeScript, Node 20+ (`npm run lint` needs ^20.19 or >=22.12), tsup (ESM), Vitest. Commands: `npm run build`, `npx tsc --noEmit`, `npm run lint`, `npx vitest run`, `npm run test:e2e`.
-
- ## Git
-
- - Default branch: `main`. Worktrees and PRs based on `origin/main`.
- - PR only to `Tencent/teamai-cli`. Before push, check `git log origin/main..HEAD`; rebase or cherry-pick if unrelated commits appear.
- - **必须使用 Worktree**:改代码前先 `EnterWorktree`,禁止在主工作目录修改。
-
- ## Rules
-
- - CLI user-facing output must be English. No Chinese in production code. Tests assert English output.
- - Keep bilingual docs in sync (`README` / `*.zh-CN.md`, `docs/usage-guide.*`). Behavior changes must update every affected doc (including `docs/designs/`); grep old wording before opening the PR.
- - **README 精简**:尽量少改动 README,保持简洁。确需改动时,所有语言版本(`README.md` 及全部 `README.*.md`,改前先 `ls README*` 确认清单)必须全部改完并保持一致。
- - **`skill-data/` 与文档同等对待**:那是 agent 真正读到的内容。行为变更必须同步更新受影响的 skill(`core` / `setup` / `wiki` / `share`),并在 PR 前 grep 旧措辞。
- - `skill-data/core/references/commands.md` 由 Commander 命令表生成,改动命令或 flag 后运行 `npx vitest run commands-reference -u` 重新生成。
- - **尽量不改 teamai skill 正文**:用法与 flag 的真源是 CLI 自己的 help(`teamai --help`、`teamai <cmd> --help`)和由它生成的 `commands.md`。想让 agent 更会用某命令,先把命令的 `description` / `option` help 文本写清楚,让 skill 指向 help,而不是把用法抄进 skill;只有工作流本身变化时才动 skill 正文。
- - 部署到 agent 的只有 `skills/teamai/SKILL.md`(发现入口),保持与版本无关:新增工作流是在 `skill-data/` 下加目录 + 在 stub 里加一行,不要把内容写进 stub。
- - **奥卡姆剃刀**:避免过早添加新 CLI 命令;非必要不加;优先复用或扩展现有命令与选项。
-
- ## PR 前测试
-
- 改动运行时行为的 PR(docs-only / tests-only 之外),`npm run build` 后必须用真实 CLI 对本次改动做端到端验证,不能只跑 type check / unit test;**一次代表性的 real-CLI 运行即可**,把实际通过的验证记录贴进 PR。docs-only / tests-only 的改动无需 e2e 记录。
-
- 不要求覆盖下面的完整 provider × agent 矩阵——额外 provider / agent 的覆盖交给 CI,或在本地环境不具备时说明即可:
-
- - Agent:Claude、Codex、CodeBuddy、OpenCode
- - Provider:`git`、`gitlab`、`github`
+ @AGENTS.md