@modus-ai/modus 0.2.1 → 0.2.2
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/README.md
CHANGED
|
@@ -7,6 +7,235 @@
|
|
|
7
7
|
<a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" /></a>
|
|
8
8
|
</p>
|
|
9
9
|
|
|
10
|
+
## 项目简介
|
|
11
|
+
|
|
12
|
+
Spring 出现之前，每个 Java 项目都在重复解决同一批问题：对象怎么管理、事务怎么处理、依赖怎么注入——有了 Spring，这些问题不再属于「每个项目」，而是属于「框架」。
|
|
13
|
+
|
|
14
|
+
**AI Coding 正处在 Spring 出现之前的阶段。**
|
|
15
|
+
|
|
16
|
+
每个团队都在独立回答同一批问题：AI 怎么理解我们的业务上下文？编码规范怎么让 AI 遵守？多人协作时 AI 行为怎么保持一致？最佳实践怎么沉淀下来不随人员流动消失？没有框架，每个项目自己摸索，低水平重复，经验留在个人脑袋里。
|
|
17
|
+
|
|
18
|
+
**Modus 要做 AI Coding 的 Spring。**
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
### 框架的核心：Command 串联一切
|
|
23
|
+
|
|
24
|
+
Modus 对外只暴露 **Command（斜杠命令）**，这是框架与使用者之间唯一的契约。一条命令背后，框架自动完成依赖注入——专业分工的 SubAgent、携带团队最佳实践的 Skill、守住架构红线的 Rule、积累业务知识的知识体系，全部在命令触发时按需装配：
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
/modus:harness ← 使用者只需知道这一行
|
|
28
|
+
│
|
|
29
|
+
├── SubAgent（专业分工智能体） 需求分析 / 编码 / 测试 / 安全审计，各司其职
|
|
30
|
+
├── Skill （流程知识文档） 团队执行规程，一次沉淀，跨项目、跨人员共享复用
|
|
31
|
+
├── Rule （项目宪法） 架构约束与编码规范，AI 不可逾越的硬性边界
|
|
32
|
+
└── 知识体系（三层 Skill） 业务域 / 技术决策 / 团队规范，随每次交付自动积累
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
就像 Spring 用 `@Transactional` 解决了所有项目的事务问题，Modus 用 `/modus:harness` 解决了所有团队的全流程 AI 研发问题。**你不需要理解内部机制，框架替你处理好了。**
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
### 框架的价值：解决 AI Coding 的四个根本性问题
|
|
40
|
+
|
|
41
|
+
| AI Coding 的根本问题 | Spring 当年的解法 | Modus 的解法 |
|
|
42
|
+
|---------------------|-----------------|-------------|
|
|
43
|
+
| AI 不了解我的项目业务 | IoC 容器统一管理依赖 | 三层知识体系，业务上下文按需注入 |
|
|
44
|
+
| AI 不遵守我的团队规范 | AOP 切面统一处理横切关注点 | Rule 项目宪法，全局强约束，AI 不可绕过 |
|
|
45
|
+
| AI 行为每次不一致 | 约定优于配置，标准化行为模式 | Skill 固化最佳实践，Command 保证执行路径可复现 |
|
|
46
|
+
| 经验随人员流动消失 | Spring 生态让经验沉淀为社区标准 | 知识体系随每次交付自动积累，越用越快 |
|
|
47
|
+
|
|
48
|
+
**结果是：** 第 1 次用 Modus 开发约 45 分钟，第 N 次约 15 分钟——不是因为 AI 变聪明了，而是框架帮你把项目知识、团队规范、执行流程都预装好了，冷启动成本趋近于零。
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
### 框架的生态：覆盖研效全链路每个节点
|
|
53
|
+
|
|
54
|
+
就像 Spring 从 Core 扩展到 MVC、Security、Cloud，Modus 的目标是为研效全链路每个节点提供开箱即用的 Command 与配套资产（**当前已完成代码开发全链路，各节点持续扩充中**）：
|
|
55
|
+
|
|
56
|
+
| 研效节点 | 建设状态 | 代表 Command |
|
|
57
|
+
|---------|---------|-------------|
|
|
58
|
+
| 项目冷启动 | ✅ 已完成 | `modus init` — 自动扫描代码库，生成三层知识体系 |
|
|
59
|
+
| 需求创建 | ✅ 已完成 | `/modus:auto` — 读取 Story，四维评分，智能推荐执行路径 |
|
|
60
|
+
| 评估设计 | ✅ 已完成 | `/modus:plan` · `/modus:spec` — 规划设计，产出物人工确认 |
|
|
61
|
+
| 代码开发 | ✅ 已完成 | `/modus:vibe` · `/modus:harness` — 轻量编码到全自动双 Loop |
|
|
62
|
+
| 测试 | ✅ 已完成 | Harness 内置 — 单测 / 性能 / 安全 / CR 四路并行 |
|
|
63
|
+
| 部署发布 | ✅ 已完成 | Harness 内置 — CI 监控 + 逐级灰度冒烟 + 上线日志监控 |
|
|
64
|
+
|
|
65
|
+
每个节点均有结构化产出物（`01-analysis.md` → `07-deploy-status.md`）作为决策留痕，支持断点续跑，确保 AI 行为可追溯、可审计、可接手。
|
|
66
|
+
|
|
67
|
+
## 建设能力
|
|
68
|
+
|
|
69
|
+
### 项目冷启动
|
|
70
|
+
|
|
71
|
+
**SubAgent**
|
|
72
|
+
|
|
73
|
+
| 名称 | 说明 |
|
|
74
|
+
|------|------|
|
|
75
|
+
| `Skills Builder SubAgent` | 知识生命周期管家——初始化、增量更新、ARCHIVE 提取，五种调用模式覆盖知识全流程，团队级可复用 |
|
|
76
|
+
|
|
77
|
+
**Commands**
|
|
78
|
+
|
|
79
|
+
| 名称 | 说明 |
|
|
80
|
+
|------|------|
|
|
81
|
+
| `/modus:init` | 一键扫描代码库，自动识别业务域，生成三层知识底座 + 知识全景目录，存量老项目当天可接入 |
|
|
82
|
+
|
|
83
|
+
**Skills**
|
|
84
|
+
|
|
85
|
+
| 名称 | 说明 |
|
|
86
|
+
|------|------|
|
|
87
|
+
| `modus-init` | 定义 `/modus:init` 完整执行逻辑（8 步流程、多平台扫描、Skill 生成规范），可复用到任意项目 |
|
|
88
|
+
| `modus-harness-00-skills-builder` | Skill 创建 / 增量更新 / 知识提取的核心引擎，被所有工作流命令共享调用 |
|
|
89
|
+
|
|
90
|
+
**目的**
|
|
91
|
+
|
|
92
|
+
1. 三层知识体系，分层按需加载
|
|
93
|
+
2. Skill 结构统一，防腐可复用
|
|
94
|
+
3. 项目宪法，全局强约束落地
|
|
95
|
+
4. 自动梳理老项目，零人工整理
|
|
96
|
+
5. 多平台规则融合，存量不浪费
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
### 需求创建
|
|
101
|
+
|
|
102
|
+
**Commands**
|
|
103
|
+
|
|
104
|
+
| 名称 | 说明 |
|
|
105
|
+
|------|------|
|
|
106
|
+
| `/modus:auto` | 读取 TAPD Story，四维评分后推荐最优执行模式，自动透传上下文启动，避免工具错配 |
|
|
107
|
+
|
|
108
|
+
**Skills**
|
|
109
|
+
|
|
110
|
+
| 名称 | 说明 |
|
|
111
|
+
|------|------|
|
|
112
|
+
| `modus-auto` | 四维评分判定树 + 模式推荐逻辑，可复用于任何需要智能分流的研效场景 |
|
|
113
|
+
|
|
114
|
+
**目的**
|
|
115
|
+
|
|
116
|
+
1. TAPD 直连，零手动录入
|
|
117
|
+
2. 四维评分，精准路由模式
|
|
118
|
+
3. 难度分级，工具按需匹配
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
### 评估设计
|
|
123
|
+
|
|
124
|
+
**SubAgent**
|
|
125
|
+
|
|
126
|
+
| 名称 | 说明 |
|
|
127
|
+
|------|------|
|
|
128
|
+
| `SA01 需求分析 SubAgent` | 将 TAPD Story 翻译为精确技术规格，方法级影响范围 + Sprint 拆分，为后续 Agent 建立统一上下文 |
|
|
129
|
+
| `SA01.5 设计方案 SubAgent` | 在需求与编码之间插入设计推导层，生成 LLM 可直接消费的 design-brief，减少编码时的架构歧义 |
|
|
130
|
+
|
|
131
|
+
**Commands**
|
|
132
|
+
|
|
133
|
+
| 名称 | 说明 |
|
|
134
|
+
|------|------|
|
|
135
|
+
| `/modus:plan` | 上下文感知规划，六维复杂度分级 + 精准 3 问澄清 + plan.md，Build 确认后直接驱动编码 |
|
|
136
|
+
| `/modus:spec` | 规范驱动开发，生成 GIVEN/WHEN/THEN 行为规格 + 四层产出物，归档自动合并主规格库 |
|
|
137
|
+
|
|
138
|
+
**Skills**
|
|
139
|
+
|
|
140
|
+
| 名称 | 说明 |
|
|
141
|
+
|------|------|
|
|
142
|
+
| `modus-plan` | `/modus:plan` 完整执行逻辑，含复杂度评估、知识检索、3 问澄清、Build 确认循环，可复用 |
|
|
143
|
+
| `modus-spec` | `/modus:spec` 执行逻辑，含 delta specs、冲突检测、可选 verify、主规格库归档，可复用 |
|
|
144
|
+
| `modus-design-brief` | 结构化设计方案生成（落盘 + 内联双模式），被 plan/spec/vibe 共享调用，可独立复用 |
|
|
145
|
+
| `modus-harness-01-analysis` | Harness 需求分析 SubAgent 行为定义，方法级影响范围提取 + HANDOFF 协议，可复用 |
|
|
146
|
+
| `modus-harness-01-5-design` | Harness 设计推导 SubAgent 行为定义，架构澄清 + design-brief 生成，可复用 |
|
|
147
|
+
|
|
148
|
+
**目的**
|
|
149
|
+
|
|
150
|
+
1. 设计前置，质量风险左移
|
|
151
|
+
2. 四层文档，职责清晰可追溯
|
|
152
|
+
3. 规格库唯一权威来源
|
|
153
|
+
4. 断点续跑，决策全程留痕
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
### 代码开发
|
|
158
|
+
|
|
159
|
+
**SubAgent**
|
|
160
|
+
|
|
161
|
+
| 名称 | 说明 |
|
|
162
|
+
|------|------|
|
|
163
|
+
| `SA02 代码开发 SubAgent` | 按 Sprint 逐层实现（数据→服务→编排→接口），编译 Gate 自动验证，P1/P2 精准重入修复 |
|
|
164
|
+
|
|
165
|
+
**Commands**
|
|
166
|
+
|
|
167
|
+
| 名称 | 说明 |
|
|
168
|
+
|------|------|
|
|
169
|
+
| `/modus:vibe` | 氛围编程——渐进加载业务上下文后直接编码，适合轻量任务，人工随时介入 |
|
|
170
|
+
| `/modus:harness` | 全自动双 Loop 流程入口，8 个 SubAgent 从需求到部署全程闭环，一条命令驱动 |
|
|
171
|
+
|
|
172
|
+
**Skills**
|
|
173
|
+
|
|
174
|
+
| 名称 | 说明 |
|
|
175
|
+
|------|------|
|
|
176
|
+
| `modus-vibe` | 三级渐进加载逻辑 + 编码执行规范，节省约 59% token，可复用于任意上下文感知编码场景 |
|
|
177
|
+
| `modus-harness` | Harness Orchestrator 调度中枢，双 Loop 调度规则 + Gate 机制 + HANDOFF 协议，核心可复用 |
|
|
178
|
+
| `modus-harness-02-dev` | 代码开发 SubAgent 行为定义，Sprint 分层实现 + self-code-review + 编译验证，可复用 |
|
|
179
|
+
|
|
180
|
+
**目的**
|
|
181
|
+
|
|
182
|
+
1. 上下文感知，消除冷启动
|
|
183
|
+
2. 编译 Gate，代码质量前置
|
|
184
|
+
3. Sprint 分层，逐步可验证
|
|
185
|
+
4. Token 节省约 59%
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
### 测试
|
|
190
|
+
|
|
191
|
+
**SubAgent**
|
|
192
|
+
|
|
193
|
+
| 名称 | 说明 |
|
|
194
|
+
|------|------|
|
|
195
|
+
| `SA03 代码测试 SubAgent` | 三路径单元测试生成（Happy Path / 边界 / 异常），覆盖并发 + 事务 + 权限场景 |
|
|
196
|
+
| `SA04 性能审计 SubAgent` | 静态检测 N+1 / 大数据量 / 深分页风险，量化每个风险影响条数，高/中/低分级 |
|
|
197
|
+
| `SA05 安全审计 SubAgent` | 检测多租户隔离漏洞 / 权限缺失 / SQL 注入 / 敏感信息泄露，严重/高/低分级 |
|
|
198
|
+
| `SA06 代码评审 SubAgent` | 综合质量评估，P1/P2 触发 Loop 2 精准重入，唯一出口是通过所有质量门 |
|
|
199
|
+
|
|
200
|
+
**Skills**
|
|
201
|
+
|
|
202
|
+
| 名称 | 说明 |
|
|
203
|
+
|------|------|
|
|
204
|
+
| `modus-harness-03-test` | 单元测试生成规范 + 三路径覆盖逻辑，可复用为独立测试 Agent |
|
|
205
|
+
| `modus-harness-04-perf` | N+1 检测规则库 + 性能风险分级模型，可复用为独立性能审计 Agent |
|
|
206
|
+
| `modus-harness-05-security` | 多租户安全规则 + SQL 注入 / 权限检查规范，可复用为独立安全审计 Agent |
|
|
207
|
+
| `modus-harness-06-review` | CR 问题分级标准 + Loop 2 重入触发逻辑，可复用为独立代码评审 Agent |
|
|
208
|
+
|
|
209
|
+
**目的**
|
|
210
|
+
|
|
211
|
+
1. 三专项并行，节省 2/3 时间
|
|
212
|
+
2. P1/P2 自动闭环，无需人工协调
|
|
213
|
+
3. 专项分工，覆盖无死角
|
|
214
|
+
4. 质量标准客观统一可量化
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
### 部署发布
|
|
219
|
+
|
|
220
|
+
**SubAgent**
|
|
221
|
+
|
|
222
|
+
| 名称 | 说明 |
|
|
223
|
+
|------|------|
|
|
224
|
+
| `SA07 部署发布 SubAgent` | CI 监控 + 灰度逐级冒烟 + 上线后 30 分钟日志监控，prd 等待人工确认，可复用为独立部署验证 Agent |
|
|
225
|
+
|
|
226
|
+
**Skills**
|
|
227
|
+
|
|
228
|
+
| 名称 | 说明 |
|
|
229
|
+
|------|------|
|
|
230
|
+
| `modus-harness-07-deploy` | 部署验证完整流程定义（CI 状态轮询 / 冒烟测试 / 日志监控），可复用到任意 CI/CD 场景 |
|
|
231
|
+
|
|
232
|
+
**目的**
|
|
233
|
+
|
|
234
|
+
1. 灰度逐级，prd 人工确认
|
|
235
|
+
2. 上线监控，异常及时感知
|
|
236
|
+
3. ARCHIVE 知识沉淀，经验复利积累
|
|
237
|
+
4. 全流程产出物，上线有据可查
|
|
238
|
+
|
|
10
239
|
## 设计哲学
|
|
11
240
|
|
|
12
241
|
```
|