teamai-cli 0.16.9 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "teamai-cli",
3
- "version": "0.16.9",
3
+ "version": "0.17.0",
4
4
  "description": "TeamAI — the team harness for AI agents (skill sync + shared knowledge base, powered by Git)",
5
5
  "type": "module",
6
6
  "bin": {
@@ -48,8 +48,10 @@
48
48
  "dependencies": {
49
49
  "chalk": "^5.3.0",
50
50
  "commander": "^12.1.0",
51
+ "fflate": "^0.8.3",
51
52
  "fs-extra": "^11.2.0",
52
53
  "gray-matter": "^4.0.3",
54
+ "listr2": "^9.0.5",
53
55
  "ora": "^8.1.0",
54
56
  "simple-git": "^3.27.0",
55
57
  "smol-toml": "^1.3.1",
@@ -0,0 +1,120 @@
1
+ # team-wiki-codebase — 大型代码库 AI 认知工程
2
+
3
+ > Team Wiki 插件内置 skill:方法论、脚本与 Agent 规范均随 `team-wiki install` / `upgrade` 部署到项目的 `.codebuddy/`、`.cursor/` 等目录。
4
+
5
+ ## 为什么需要这个 skill
6
+
7
+ 大型项目的 AI 理解困境:
8
+
9
+ | 痛点 | 具体表现 |
10
+ |------|---------|
11
+ | **上下文装不下** | 10+ 仓库、数十万行代码,远超 AI 上下文窗口 |
12
+ | **关系看不清** | 微服务间的 RPC/MQ/DB 依赖散落在各仓库,没有全局视图 |
13
+ | **规则记不住** | 业务约束、状态机、配置参数隐藏在深层调用链中 |
14
+ | **回答不准确** | AI 只看到局部代码,缺乏全局架构认知,容易幻觉 |
15
+ | **token 消耗大** | 每次提问都要重新读大量源码,效率极低 |
16
+
17
+ ## 怎么解决
18
+
19
+ 通过架构逆向工程,将海量代码**压缩为结构化知识库**:
20
+
21
+ - 每个结论有代码 `文件:行号` 作为证据
22
+ - 每条组件关系有置信度标注(`EXTRACTED` / `INFERRED` / `AMBIGUOUS`)
23
+ - 每次生成后有准确性统计,超标自动警告
24
+ - AI 读知识库而非读源码,**约 1/50 的 token 消耗**获得全局架构认知
25
+ - Phase 0 可用 `team-wiki compile code --extract ast,heuristic` 生成可证据化的结构边(TS/JS/Python/Go)
26
+
27
+ ---
28
+
29
+ ## 产出体系
30
+
31
+ ```
32
+ <output_dir>/
33
+ ├── README.md ← 检索路由指引(AI 专用)
34
+ ├── {项目名} 技术架构.md ← 系统全貌,~200KB
35
+ ├── {项目名} 业务架构.md ← 产品能力 + 生命周期
36
+ ├── {项目名} 部署架构.md ← 部署拓扑
37
+ ├── XX_{组件名}设计说明.md × N ← 每组件一份,含 AI 快速理解表
38
+ ├── XX_{项目名}核心API产品代码映射.md ← 产品约束→代码位置 桥梁文档
39
+ ├── XX_{项目名}产品规则速查表.md
40
+ ├── XX_{项目名}业务开发规范SOP.md
41
+ ├── {反模式/RPC契约/排障记录} × N
42
+ ├── _manifest.json ← 机器可读 manifest(供 team-wiki compile 快路径)
43
+ └── graph/ ← Graph RAG 图谱文档集
44
+ ├── G1 组件依赖关系矩阵
45
+ ├── G2 调用链路全景 + 状态机
46
+ ├── G3 数据流与存储依赖图
47
+ ├── G4 错误码组件映射表
48
+ ├── G5 跨组件交互场景手册(≥10个时序图)
49
+ ├── G6 知识图谱三元组(≥100条,含置信度)
50
+ ├── G7 架构风险与影响面分析
51
+ ├── G8 核心配置参数索引
52
+ └── G9 业务规则约束矩阵 + AI 推理决策树
53
+ ```
54
+
55
+ ---
56
+
57
+ ## 执行流程
58
+
59
+ ```
60
+ Phase 0 → 初始化:收集路径、项目名、产品文档来源;可选 CLI ast+heuristic 结构基线
61
+
62
+ Phase K1 → 架构逆向:关键文件提取 → 分层分析 → 组件关系矩阵
63
+ ⛔ 确认点① 架构理解确认
64
+
65
+ Phase K2 → 文档生成(分批并行):
66
+ 批次1~4: Type-4 组件文档(并行子 Agent 分发)
67
+ ⛔ 确认点② 文档质量抽查
68
+ 批次5~7: 架构总览 + 桥梁文档 + 知识增强
69
+
70
+ Phase K3 → AI-Native 增强:
71
+ search-anchor + 双向链接 + 检索路由规则
72
+ Graph RAG 图谱文档集 G1~G9(置信度三态标注)
73
+
74
+ Phase K4 → 质量评估:
75
+ validate_kb.py 自动检验
76
+ 全库准确性审计([UNVERIFIED] 统计 + 接口覆盖率)
77
+ 跨文档一致性校验(矛盾检测 + 自动修复)
78
+ RAG 检索抽检(7类问题)
79
+ AI 端到端验证(10~15 个标准问题 + 代码回溯)
80
+ 生成质量报告
81
+ ```
82
+
83
+ 支持 `--update` 增量更新(基于文件 hash 缓存,只重跑变更组件)。
84
+
85
+ ---
86
+
87
+ ## 文件结构
88
+
89
+ ```
90
+ team-wiki-codebase/
91
+ ├── SKILL.md ← 主执行指令(AI 加载)
92
+ ├── README.md ← 本文件
93
+ ├── scripts/
94
+ │ ├── scan_repo.py ← 仓库扫描辅助工具
95
+ │ └── validate_kb.py ← 知识库质量校验工具
96
+ └── references/
97
+ ├── agents/
98
+ │ ├── kb-doc-generator.md ← Type-1~8 文档生成专职 Agent
99
+ │ └── graph-rag-agent.md ← G1~G9 图谱文档专职 Agent
100
+ ├── methodology/
101
+ │ ├── phase0-collection.md ← 源材料采集方法
102
+ │ ├── phase1-reverse-engineering.md ← 架构逆向工程方法
103
+ │ ├── phase2-document-types.md ← 九大文档类型规范与质量标准
104
+ │ ├── phase3-ai-enhancement.md ← AI-Native 增强方法
105
+ │ └── phase4-quality.md ← 质量评估 Checklist
106
+ └── templates/
107
+ └── project-overview.md ← 知识库 README 模板(含认知边界声明)
108
+ ```
109
+
110
+ ---
111
+
112
+ ## 质量标准
113
+
114
+ | 维度 | 达标标准 |
115
+ |------|---------|
116
+ | 覆盖率 | ≥90% P0 核心组件有文档 |
117
+ | 准确性 | [UNVERIFIED] < 15% |
118
+ | 结构质量 | 死链接=0,search-anchor 覆盖率≥95% |
119
+ | AI 可用性 | RAG 检索抽检准确率≥85% |
120
+ | 关系可信度 | AMBIGUOUS 关系 < 10%,全部列入待确认清单 |