@rosenfan/matrix 0.1.0 → 0.1.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/.claude/skills/matrix/SKILL.md +62 -21
- package/.claude/skills/matrix/agents/openai.yaml +4 -4
- package/.claude/skills/matrix/scripts/matrix_claude.py +11 -166
- package/.claude/skills/matrix/scripts/matrix_state.py +60 -114
- package/.claude/skills/matrix-archive/SKILL.md +33 -26
- package/.claude/skills/matrix-build/SKILL.md +26 -39
- package/.claude/skills/matrix-claude/SKILL.md +22 -22
- package/.claude/skills/matrix-design/SKILL.md +28 -29
- package/.claude/skills/matrix-hotfix/SKILL.md +8 -8
- package/.claude/skills/matrix-open/SKILL.md +17 -20
- package/.claude/skills/matrix-status/SKILL.md +4 -3
- package/.claude/skills/matrix-tweak/SKILL.md +8 -8
- package/.claude/skills/matrix-verify/SKILL.md +18 -29
- package/LICENSE +21 -21
- package/README.md +255 -242
- package/README.zh-CN.md +254 -242
- package/assets/skills-zh-CN/matrix/SKILL.md +57 -5
- package/assets/skills-zh-CN/matrix-archive/SKILL.md +23 -2
- package/assets/skills-zh-CN/matrix-build/SKILL.md +26 -2
- package/assets/skills-zh-CN/matrix-claude/SKILL.md +12 -11
- package/assets/skills-zh-CN/matrix-design/SKILL.md +16 -11
- package/assets/skills-zh-CN/matrix-hotfix/SKILL.md +8 -8
- package/assets/skills-zh-CN/matrix-open/SKILL.md +16 -11
- package/assets/skills-zh-CN/matrix-status/SKILL.md +12 -11
- package/assets/skills-zh-CN/matrix-tweak/SKILL.md +8 -8
- package/assets/skills-zh-CN/matrix-verify/SKILL.md +22 -8
- package/bin/matrix.js +15 -15
- package/package.json +56 -56
- package/src/catalog.js +85 -80
- package/src/cli.js +116 -111
- package/src/distribution.js +216 -152
- package/src/installer.js +45 -45
- package/src/matt.js +45 -34
- package/src/messages.js +33 -33
- package/src/ui.js +89 -89
- package/src/workflow-transaction.js +622 -0
- package/src/workflow.js +547 -74
package/README.zh-CN.md
CHANGED
|
@@ -1,271 +1,283 @@
|
|
|
1
|
-
# Matrix Workflow
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
**[English](./README.md)** | 中文
|
|
6
|
-
|
|
7
|
-
<p align="center">
|
|
8
|
-
<img src="./assets/matrix-workflow-poster-zh.svg" alt="Matrix Workflow" width="100%">
|
|
9
|
-
</p>
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
## 目录
|
|
14
|
-
|
|
15
|
-
- [为什么需要 Matrix](#为什么需要-matrix)
|
|
16
|
-
- [它做了什么](#它做了什么)
|
|
17
|
-
- [前置条件](#前置条件)
|
|
18
|
-
- [安装](#安装)
|
|
19
|
-
- [快速开始](#快速开始)
|
|
20
|
-
- [工作流阶段](#工作流阶段)
|
|
21
|
-
- [工作原理](#工作原理)
|
|
22
|
-
- [工作流类型](#工作流类型)
|
|
23
|
-
- [与 Matt Pocock Skills 的集成](#与-matt-pocock-skills-的集成)
|
|
24
|
-
- [许可证](#许可证)
|
|
25
|
-
|
|
26
|
-
---
|
|
27
|
-
|
|
28
|
-
## 为什么需要 Matrix
|
|
29
|
-
|
|
30
|
-
[Matt Pocock 的 skills](https://github.com/mattpocock/skills)
|
|
31
|
-
|
|
32
|
-
- **无流程记忆**:你进行了 grilling,然后实现,但没有记录决策过程
|
|
33
|
-
- **阶段混乱**:设计完成了吗?我们在构建阶段吗?上下文丢失后很难判断
|
|
34
|
-
- **静默范围蔓延**:需求在构建过程中变更,却没有返回设计阶段
|
|
35
|
-
- **缺少证据**:"看起来完成了"却没有验证证明
|
|
36
|
-
|
|
37
|
-
Matrix
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## 它做了什么
|
|
42
|
-
|
|
43
|
-
Matrix
|
|
44
|
-
|
|
45
|
-
```
|
|
1
|
+
# Matrix Workflow
|
|
2
|
+
|
|
3
|
+
一个提供 Prim 与 Arch 编排的证据驱动开发工作流,灵感来自 [Comet](https://github.com/rpamis/comet)。Matrix 可以使用自身能力,也可以按事实调用已验证的 [Matt Pocock agent skills](https://github.com/mattpocock/skills),但生命周期所有权始终由 Matrix 保持。
|
|
4
|
+
|
|
5
|
+
**[English](./README.md)** | 中文
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<img src="./assets/matrix-workflow-poster-zh.svg" alt="Matrix Workflow" width="100%">
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 目录
|
|
14
|
+
|
|
15
|
+
- [为什么需要 Matrix](#为什么需要-matrix)
|
|
16
|
+
- [它做了什么](#它做了什么)
|
|
17
|
+
- [前置条件](#前置条件)
|
|
18
|
+
- [安装](#安装)
|
|
19
|
+
- [快速开始](#快速开始)
|
|
20
|
+
- [工作流阶段](#工作流阶段)
|
|
21
|
+
- [工作原理](#工作原理)
|
|
22
|
+
- [工作流类型](#工作流类型)
|
|
23
|
+
- [与 Matt Pocock Skills 的集成](#与-matt-pocock-skills-的集成)
|
|
24
|
+
- [许可证](#许可证)
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## 为什么需要 Matrix
|
|
29
|
+
|
|
30
|
+
[Matt Pocock 的 skills](https://github.com/mattpocock/skills) 提供 `/grilling`、`/tdd`、`/code-review` 等聚焦能力。但缺少统一生命周期所有者时会导致常见问题:
|
|
31
|
+
|
|
32
|
+
- **无流程记忆**:你进行了 grilling,然后实现,但没有记录决策过程
|
|
33
|
+
- **阶段混乱**:设计完成了吗?我们在构建阶段吗?上下文丢失后很难判断
|
|
34
|
+
- **静默范围蔓延**:需求在构建过程中变更,却没有返回设计阶段
|
|
35
|
+
- **缺少证据**:"看起来完成了"却没有验证证明
|
|
36
|
+
|
|
37
|
+
Matrix 通过唯一的确定性状态机解决这些问题 —— 包含明确的阶段、守卫条件和产物追踪。Skill 可以协助阶段,但生命周期始终由 Matrix 拥有。
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 它做了什么
|
|
42
|
+
|
|
43
|
+
Matrix 在同一条工作流上提供两种能力编排:
|
|
44
|
+
|
|
45
|
+
```
|
|
46
46
|
open → design → build → verify → archive
|
|
47
|
-
(开放) (设计) (构建) (验证) (归档)
|
|
48
|
-
↓ ↓ ↓ ↓ ↓
|
|
49
|
-
grill plan implement tdd commit
|
|
50
|
-
design review
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
每个阶段:
|
|
54
|
-
- 有特定的交付物(产物)
|
|
55
|
-
- 有必须通过的守卫条件
|
|
56
|
-
- 记录所有转换
|
|
57
|
-
- 可承受上下文丢失(状态存储在磁盘上)
|
|
58
47
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
## 前置条件
|
|
62
|
-
|
|
63
|
-
- 已安装 [Claude Code](https://docs.anthropic.com/claude-code)
|
|
64
|
-
- Node.js 18+(用于运行安装器)
|
|
65
|
-
- Python 3.8+ 已添加到 PATH
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
## 安装
|
|
70
|
-
|
|
71
|
-
只需全局安装一次 Matrix CLI:
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
npm install --global @rosenfan/matrix
|
|
48
|
+
Prim:Matrix 使用自身能力
|
|
49
|
+
Arch:仅在任务事实满足触发条件时调用已验证的原子 Skill
|
|
75
50
|
```
|
|
76
51
|
|
|
77
|
-
|
|
52
|
+
恢复路径由 Runtime 受控执行:
|
|
78
53
|
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
|
|
54
|
+
```text
|
|
55
|
+
build --design-gap--------------------> design
|
|
56
|
+
verify --verification-failed-----------> build
|
|
57
|
+
verify --acceptance-or-design-gap------> design
|
|
58
|
+
任意活动阶段 --abort-------------------> aborted
|
|
82
59
|
```
|
|
83
60
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
-
|
|
61
|
+
每个阶段:
|
|
62
|
+
- 有特定的交付物(产物)
|
|
63
|
+
- 有必须通过的守卫条件
|
|
64
|
+
- 记录所有转换
|
|
65
|
+
- 可承受上下文丢失(状态存储在磁盘上)
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 前置条件
|
|
70
|
+
|
|
71
|
+
- 已安装 [Claude Code](https://docs.anthropic.com/claude-code)
|
|
72
|
+
- Node.js 18+(用于运行安装器)
|
|
73
|
+
- Python 3.8+ 已添加到 PATH
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## 安装
|
|
78
|
+
|
|
79
|
+
只需全局安装一次 Matrix CLI:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
npm install --global @rosenfan/matrix
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
之后在任意项目中初始化:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
cd /path/to/your/project
|
|
89
|
+
matrix init
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
交互式初始化支持:
|
|
93
|
+
|
|
94
|
+
- 选择安装到当前项目或全局
|
|
95
|
+
- 复制 skills(推荐)或为本地开发创建符号链接
|
|
96
|
+
- 更新已有安装,并自动备份被替换的 Matrix 文件
|
|
89
97
|
- 在同一流程中安装 Matt Pocock 的配套 skills
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
98
|
+
- 选择 Prim 或 Arch 作为项目默认值,且不禁用另一种可用模式
|
|
99
|
+
|
|
100
|
+
自动化或 CI 环境可以使用:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# 使用推荐的项目级默认值,不显示交互问题
|
|
95
104
|
matrix init --yes --with-mattpocock
|
|
96
105
|
|
|
97
|
-
#
|
|
98
|
-
matrix
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
npm
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
Matrix
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
- `matrix
|
|
112
|
-
- `matrix-
|
|
113
|
-
- `matrix-
|
|
114
|
-
- `matrix-
|
|
115
|
-
- `matrix-
|
|
116
|
-
- `matrix-
|
|
117
|
-
- `matrix-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
|
144
|
-
|
|
145
|
-
| **
|
|
146
|
-
| **
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
106
|
+
# 显式选择项目默认编排
|
|
107
|
+
matrix init --yes --with-mattpocock --default-orchestration arch
|
|
108
|
+
|
|
109
|
+
# 检查安装完整性和运行环境
|
|
110
|
+
matrix doctor
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
npm 包正式发布前,也可以直接从 GitHub 安装:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
npm install --global github:Rosenfan/Matrix
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Matrix 将安装:
|
|
120
|
+
- `matrix/` — 入口点和状态管理
|
|
121
|
+
- `matrix-open/` — Open 阶段与 canonical proposal
|
|
122
|
+
- `matrix-design/` — Design、plan 与 Contract 批准
|
|
123
|
+
- `matrix-build/` — 有界实现与构建证据
|
|
124
|
+
- `matrix-verify/` — 测试和双轴审查证据
|
|
125
|
+
- `matrix-archive/` — 归档阶段
|
|
126
|
+
- `matrix-hotfix/` — 小型 Bug 快捷方式
|
|
127
|
+
- `matrix-tweak/` — 有界变更快捷方式
|
|
128
|
+
- `matrix-status/` — 检查当前状态
|
|
129
|
+
- `matrix-claude/` — 可选:导出供 Claude Code 使用
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## 快速开始
|
|
134
|
+
|
|
135
|
+
在 Claude Code 中:
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
$matrix 我想给 API 添加用户认证
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Matrix 将会:
|
|
142
|
+
1. 用工作流类型 `full` 和冻结的 `prim|arch` 编排初始化变更
|
|
143
|
+
2. 进入 `open`;Prim 直接处理,Arch 只调用已证明的需求触发能力
|
|
144
|
+
3. 创建 `proposal.md`,包含目标、范围、验收标准、风险
|
|
145
|
+
4. 守卫检查:所有章节是否内容充实?
|
|
146
|
+
5. 如果通过 → 转换到 `design`
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## 工作流阶段
|
|
151
|
+
|
|
152
|
+
| 阶段 | Arch 能力(按事实触发,不是固定序列) | 交付物 | 守卫条件 |
|
|
153
|
+
|------|----------------------------------------|--------|----------|
|
|
154
|
+
| **open** | `/grilling`、`/domain-modeling` | `proposal.md`;可选仓库约定的 context/ADR 证据 | 目标、范围、验收标准、风险存在 |
|
|
155
|
+
| **design** | `/domain-modeling`、`/research`、`/wayfinder`、`/prototype`、`/codebase-design` | `design.md`、`plan.md` | 决策、测试点、步骤已记录 |
|
|
156
|
+
| **build** | `/tdd`、`/diagnosing-bugs`、`/resolving-merge-conflicts` | 代码、`verification.md` | 已批准的精确 Contract 匹配,且已记录构建证据 |
|
|
157
|
+
| **verify** | `/code-review` | 测试和审查证据 | 测试和审查证据存在 |
|
|
158
|
+
| **archive** | 无;两种模式均由 Matrix 拥有 | 归档记录 | 验证守卫通过 |
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## 工作原理
|
|
163
|
+
|
|
164
|
+
状态存储在 `.matrix/` 目录:
|
|
165
|
+
|
|
166
|
+
```
|
|
167
|
+
.matrix/
|
|
168
|
+
├── active.json # 当前变更 ID
|
|
169
|
+
├── config.yaml
|
|
170
|
+
├── changes/
|
|
171
|
+
│ └── <change-id>/
|
|
172
|
+
│ ├── matrix.yaml # 唯一 workflow、orchestration、阶段、状态与 revision 事实
|
|
162
173
|
│ ├── events.jsonl
|
|
163
174
|
│ └── artifacts/
|
|
164
175
|
│ ├── proposal.md
|
|
165
176
|
│ ├── design.md
|
|
166
177
|
│ ├── plan.md
|
|
167
|
-
│
|
|
178
|
+
│ ├── verification.md
|
|
179
|
+
│ └── evidence-history/
|
|
168
180
|
└── archive/
|
|
169
181
|
```
|
|
170
|
-
|
|
171
|
-
状态机强制执行转换:
|
|
172
|
-
|
|
173
|
-
```bash
|
|
182
|
+
|
|
183
|
+
状态机强制执行转换:
|
|
184
|
+
|
|
185
|
+
```bash
|
|
174
186
|
# 检查守卫
|
|
175
|
-
|
|
187
|
+
matrix workflow guard open
|
|
176
188
|
|
|
177
189
|
# 推进(仅在守卫通过时)
|
|
178
|
-
|
|
179
|
-
```
|
|
190
|
+
matrix workflow transition design
|
|
180
191
|
|
|
181
|
-
|
|
192
|
+
# 验证失败时返回 Build;旧证据保留在历史目录
|
|
193
|
+
matrix workflow return build --reason verification-failed
|
|
182
194
|
|
|
183
|
-
|
|
195
|
+
# 终止变更但保留产物,不撤销工作区代码
|
|
196
|
+
matrix workflow abort --reason requirement-cancelled
|
|
184
197
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
| **hotfix** | 可复现的小型 Bug | 简化:open → build → verify → archive |
|
|
189
|
-
| **tweak** | 有界变更,无 API/架构影响 | 简化:open → build → verify → archive |
|
|
198
|
+
# 最终归档强制使用两步乐观提交
|
|
199
|
+
matrix workflow archive --dry-run
|
|
200
|
+
matrix workflow archive --expect-preflight <dry-run-返回的-sha256>
|
|
190
201
|
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
## 特别功能:matrix-claude
|
|
194
|
-
|
|
195
|
-
**默认用法**:直接使用主流程即可。无论你用 Codex 还是 Claude Code,标准流程都适用:
|
|
202
|
+
# 只读诊断中断的 Workflow
|
|
203
|
+
matrix workflow doctor
|
|
196
204
|
|
|
205
|
+
# 只恢复 doctor 明确报告的 transaction 或陈旧锁
|
|
206
|
+
matrix workflow doctor --repair --transaction <id> --strategy <continue|rollback>
|
|
207
|
+
matrix workflow doctor --repair --lock <id>
|
|
197
208
|
```
|
|
198
|
-
$matrix → open → design → build → verify → archive
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
**何时使用 `$matrix-claude`**:仅当你想**跨工具拆分工作**时 —— 用 Codex 设计,然后交给 Claude Code 实现。
|
|
202
|
-
|
|
203
|
-
| 场景 | 操作 |
|
|
204
|
-
|------|------|
|
|
205
|
-
| 一个工具完成所有工作(默认) | 直接用 `$matrix`,无需额外步骤 |
|
|
206
|
-
| Codex 设计 + Codex 实现 | 标准流程:design → build → verify |
|
|
207
|
-
| Codex 设计 + Claude Code 实现 | design → `$matrix-claude` → Claude Code → verify |
|
|
208
|
-
|
|
209
|
-
### matrix-claude 工作原理
|
|
210
|
-
|
|
211
|
-
1. 设计阶段完成,守卫通过
|
|
212
|
-
2. 运行 `$matrix-claude` → 导出冻结的设计为 `artifacts/claude-task.md`
|
|
213
|
-
3. Claude Code 读取任务包并实现
|
|
214
|
-
4. Claude Code 在 `artifacts/verification.md` 中产生证据
|
|
215
|
-
5. 返回 Matrix:构建守卫 → 验证 → 归档
|
|
216
|
-
|
|
217
|
-
此 sidecar 不会改变 Matrix 状态。它只是纯粹的导出 —— 就像为另一个工具拍一张设计快照。
|
|
218
|
-
|
|
219
|
-
---
|
|
220
209
|
|
|
210
|
+
`matrix.yaml` 是 workflow、orchestration、阶段、状态与 revision 的唯一事实来源,schema 为 `matrix/change/v2`;初始化解析出的 `prim|arch` 在整个 change 中冻结。旧 schema 会被拒绝且不会发生写入。`design -> build` 会记录 `proposal.md`、`design.md`、`plan.md` 精确字节的 SHA-256 身份;任一字节改动都会阻断 Build、Verify、Archive 和 Claude 导出,必须受控 Return 到 Design 后重新批准。最终 Archive 必须先只读 dry-run,再携带该 hash 提交;Runtime 在 Archive 事务边界内重算整个受保护 change 目录 manifest,发生漂移即拒绝。所有多文件 Workflow mutation 都由 `.matrix/transactions/` 下的持久 journal 保护;`matrix workflow doctor` 始终只读,恢复必须显式绑定其报告的 transaction/strategy 或 lock identity。终态 journal 会收缩为有界审计 receipt,未完成或冲突 journal 永不自动删除。
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
## 工作流类型
|
|
215
|
+
|
|
216
|
+
| 类型 | 使用场景 | 阶段 |
|
|
217
|
+
|------|----------|------|
|
|
218
|
+
| **full** | 新功能、架构变更 | 全部 5 个阶段 |
|
|
219
|
+
| **hotfix** | 可复现的小型 Bug | 简化:open → build → verify → archive |
|
|
220
|
+
| **tweak** | 有界变更,无 API/架构影响 | 简化:open → build → verify → archive |
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
## 特别功能:matrix-claude
|
|
225
|
+
|
|
226
|
+
**默认用法**:直接使用主流程即可。无论你用 Codex 还是 Claude Code,标准流程都适用:
|
|
227
|
+
|
|
228
|
+
```
|
|
229
|
+
$matrix → open → design → build → verify → archive
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
**何时使用 `$matrix-claude`**:仅当你想**跨工具拆分工作**时 —— 用 Codex 设计,然后交给 Claude Code 实现。
|
|
233
|
+
|
|
234
|
+
| 场景 | 操作 |
|
|
235
|
+
|------|------|
|
|
236
|
+
| 一个工具完成所有工作(默认) | 直接用 `$matrix`,无需额外步骤 |
|
|
237
|
+
| Codex 设计 + Codex 实现 | 标准流程:design → build → verify |
|
|
238
|
+
| Codex 设计 + Claude Code 实现 | design → build(批准 Contract)→ `$matrix-claude` → Claude Code → verify |
|
|
239
|
+
|
|
240
|
+
### matrix-claude 工作原理
|
|
241
|
+
|
|
242
|
+
1. 设计阶段完成,守卫通过
|
|
243
|
+
2. 运行 `$matrix-claude` → 导出冻结的设计为 `artifacts/claude-task.md`
|
|
244
|
+
3. Claude Code 读取任务包并实现
|
|
245
|
+
4. Claude Code 在 `artifacts/verification.md` 中产生证据
|
|
246
|
+
5. 返回 Matrix:构建守卫 → 验证 → 归档
|
|
247
|
+
|
|
248
|
+
此 sidecar 不会改变 Matrix 状态。它只是纯粹的导出 —— 就像为另一个工具拍一张设计快照。
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
|
|
221
252
|
## 与 Matt Pocock Skills 的集成
|
|
222
253
|
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
|
228
|
-
|
|
229
|
-
|
|
|
230
|
-
| `/
|
|
231
|
-
|
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
| Skill | Matrix 如何使用 |
|
|
255
|
-
|-------|-----------------|
|
|
256
|
-
| `/code-review` | 双轴审查:**Standards**(编码规范)+ **Spec**(需求忠实度) |
|
|
257
|
-
| `/improve-codebase-architecture` | 可选:扫描浅模块深化机会 |
|
|
258
|
-
|
|
259
|
-
---
|
|
260
|
-
|
|
261
|
-
**关键区别**:Matt Pocock 的 skills 是独立工具。Matrix 增加了:
|
|
262
|
-
- **状态持久化**:可承受上下文丢失
|
|
263
|
-
- **阶段强制**:不能跳过设计直接进入构建
|
|
264
|
-
- **证据要求**:守卫检查产物,而非断言
|
|
265
|
-
- **转换日志**:完整的阶段变更审计记录
|
|
266
|
-
|
|
267
|
-
---
|
|
268
|
-
|
|
269
|
-
## 许可证
|
|
270
|
-
|
|
271
|
-
[MIT](./LICENSE)
|
|
254
|
+
Prim 使用 Matrix 自身能力。Arch 使用初始化时验证的十项原子能力:
|
|
255
|
+
|
|
256
|
+
| 阶段 | 能力 | 触发条件 |
|
|
257
|
+
|---|---|---|
|
|
258
|
+
| open | `/grilling` | 存在重大歧义或用户明确要求压力测试 |
|
|
259
|
+
| open/design | `/domain-modeling` | 词汇、不变量或架构决定不清晰 |
|
|
260
|
+
| design | `/research` | 仓库内无法获得必需的外部事实 |
|
|
261
|
+
| design | `/wayfinder` | 模块归属或依赖接缝未知 |
|
|
262
|
+
| design | `/prototype` | 重大设计问题需要一次性实验证据 |
|
|
263
|
+
| design | `/codebase-design` | 深模块、接口或测试接缝决定尚未完成 |
|
|
264
|
+
| build | `/tdd` | 可测试接缝上的可观察行为发生变化 |
|
|
265
|
+
| build | `/diagnosing-bugs` | 存在真实失败且根因未知 |
|
|
266
|
+
| build | `/resolving-merge-conflicts` | 正在发生 merge/rebase 冲突 |
|
|
267
|
+
| verify | `/code-review` | 需要 Standards 与 Spec 双轴证据 |
|
|
268
|
+
|
|
269
|
+
`grill-with-docs`、`implement`、`improve-codebase-architecture` 不受 Matrix 管理,也不会自动调用。用户已安装的副本会作为非受管额外 Skill 保留。companion 不得推进、提交、归档或写 Matrix 状态。
|
|
270
|
+
|
|
271
|
+
---
|
|
272
|
+
|
|
273
|
+
**关键区别**:Matt Pocock 的 skills 是独立工具。Matrix 增加了:
|
|
274
|
+
- **状态持久化**:可承受上下文丢失
|
|
275
|
+
- **阶段强制**:不能跳过设计直接进入构建
|
|
276
|
+
- **证据要求**:守卫检查产物,而非断言
|
|
277
|
+
- **转换日志**:完整的阶段变更审计记录
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
## 许可证
|
|
282
|
+
|
|
283
|
+
[MIT](./LICENSE)
|
|
@@ -5,7 +5,7 @@ description: 启动、恢复并治理持久化的 Matrix 开发工作流。
|
|
|
5
5
|
|
|
6
6
|
# Matrix
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
以当前仓库的 `.matrix/` 为唯一状态来源;不得从聊天记录推断阶段。
|
|
9
9
|
|
|
10
10
|
先执行:
|
|
11
11
|
|
|
@@ -13,16 +13,68 @@ Matrix 的事实来源是当前项目的 `.matrix/`,不得从聊天记录推
|
|
|
13
13
|
matrix workflow inspect
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
只有系统明确报告 `matrix` 命令不存在时,才使用当前 Matrix Skill 目录中的 bundled runtime:
|
|
17
17
|
|
|
18
18
|
```powershell
|
|
19
19
|
node <matrix-skill-directory>/scripts/matrix-runtime.mjs inspect
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
有活动变更时,报告其 phase、冻结的 `orchestration` 以及 Arch 安装完整性,再按 Runtime 结果进入 `next_skill`。没有活动变更时,为开发请求创建简短 kebab-case ID:
|
|
23
23
|
|
|
24
24
|
```powershell
|
|
25
|
-
matrix workflow init <change-id> --workflow <full|hotfix|tweak> --title "<title>"
|
|
25
|
+
matrix workflow init <change-id> --workflow <full|hotfix|tweak> --orchestration <prim|arch> --title "<title>"
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
显式模式优先,否则使用项目 `default_orchestration`。解析后的模式在整个 change 生命周期中不可切换。
|
|
29
|
+
|
|
30
|
+
## 编排模式
|
|
31
|
+
|
|
32
|
+
- **Prim**:各阶段使用 Matrix 自身能力,不依赖 Matt Skills。
|
|
33
|
+
- **Arch**:仅在任务事实满足触发条件时,调用初始化阶段已验证的十项原子能力。
|
|
34
|
+
|
|
35
|
+
两种模式共用同一套 Matrix phase graph、产物、守卫、Return/Abort、Contract、事务与归档协议。Arch 能力不得写 Matrix 状态、推进阶段、提交、归档或创建竞争工作流。调用前说明能力与触发原因,无需重复请求 Skill 权限。
|
|
36
|
+
|
|
37
|
+
正确安装的 Arch 能力执行失败时,最多允许一次同能力的 Matrix fallback,并记录失败与证据。缺失、修改或不完整的 Arch 安装必须通过 `matrix init --with-mattpocock` 修复,不得切换活动 change 到 Prim。
|
|
38
|
+
|
|
39
|
+
## 恢复
|
|
40
|
+
|
|
41
|
+
只能通过 Runtime 恢复,不得手工修改状态:
|
|
42
|
+
|
|
43
|
+
```powershell
|
|
44
|
+
matrix workflow return design --reason design-gap
|
|
45
|
+
matrix workflow return build --reason verification-failed
|
|
46
|
+
matrix workflow return design --reason acceptance-or-design-gap
|
|
47
|
+
matrix workflow abort --reason <requirement-cancelled|superseded|no-longer-valuable|blocked|other>
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Return 会把当前 `verification.md` 轮换至按 revision 编号的证据历史。Archive 等待确认期间若验收或设计改变,只能使用 `archive -> design` 的 `acceptance-or-design-gap` Return。Abort 将终态变更移入 `.matrix/archive/`,但不会撤销工作区代码。
|
|
51
|
+
|
|
52
|
+
任何 mutation 返回 `WORKFLOW_RECOVERY_REQUIRED` 时,停止正常阶段操作并先执行只读诊断:
|
|
53
|
+
|
|
54
|
+
```powershell
|
|
55
|
+
matrix workflow doctor
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
不得推断恢复目标或策略,只能执行 doctor 返回的精确命令:
|
|
59
|
+
|
|
60
|
+
```powershell
|
|
61
|
+
matrix workflow doctor --repair --transaction <id> --strategy <continue|rollback>
|
|
62
|
+
matrix workflow doctor --repair --lock <id>
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## 精确 Contract
|
|
66
|
+
|
|
67
|
+
`design -> build` 会批准 `proposal.md`、`design.md`、`plan.md` 的精确字节 SHA-256 身份。任何后续字节变动都会阻断 Build、Verify、Archive 和 Claude 导出;必须受控 Return 至 Design 后重新批准。旧 schema 会被拒绝且不发生写入。
|
|
68
|
+
|
|
69
|
+
## 可选 Claude 交接
|
|
70
|
+
|
|
71
|
+
`$matrix-claude` 只在已批准的 Build 中使用,导出同一 Contract 快照给 Claude Code。它不拥有阶段推进或验收;直接由 Codex 实现仍使用原有 Matrix 主流程。
|
|
72
|
+
只有用户明确选择“Codex 设计、Claude Code 实现”时才使用,不得自动插入标准流程。
|
|
73
|
+
|
|
74
|
+
## 规则
|
|
75
|
+
|
|
76
|
+
- 阶段只能经 `matrix workflow transition` 正向推进。
|
|
77
|
+
- 只能经上述明确的 `matrix workflow return` 反向推进。
|
|
78
|
+
- 成功 Archive 必须使用两步乐观提交:先运行 `matrix workflow archive --dry-run`,再将其精确 hash 传给 `matrix workflow archive --expect-preflight <sha256>`;不得绕过预演。
|
|
79
|
+
- `matrix workflow doctor` 始终只读;transaction 与陈旧锁 repair 必须显式绑定 doctor 报告的 identity,不得手工编辑或删除 `.matrix/transactions/`、`.matrix/workflow.lock`。
|
|
80
|
+
- 重大架构/范围决定和 archive/commit 前应暂停等待用户确认。
|
|
@@ -5,8 +5,29 @@ description: 关闭并归档已经验证的 Matrix 变更。
|
|
|
5
5
|
|
|
6
6
|
# Matrix Archive
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
这是 Matrix 最终阶段。读取 proposal、plan 与验证证据,汇总行为变化、验证结果、残留风险和后续工作;提交归档前必须取得用户明确确认。
|
|
9
|
+
|
|
10
|
+
Prim 与 Arch 的 Archive 均完全由 Matrix 拥有;本阶段不调用 companion 实现、审查或架构能力。
|
|
11
|
+
|
|
12
|
+
## 强制两步归档
|
|
13
|
+
|
|
14
|
+
先运行只读预演并复核影响摘要,再原样提交该次预演返回的 hash:
|
|
15
|
+
|
|
16
|
+
```powershell
|
|
17
|
+
matrix workflow archive --dry-run
|
|
18
|
+
matrix workflow archive --expect-preflight <dry-run-返回的-sha256>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
裸 Archive 会被拒绝。Runtime 会重新取得项目 Archive 互斥权,并在提交前重算整个受保护 change 目录 manifest。
|
|
22
|
+
|
|
23
|
+
- `ARCHIVE_PREFLIGHT_CHANGED`:重新 dry-run 并复核新摘要。
|
|
24
|
+
- `ARCHIVE_BUSY`:稍后重试;不得移除或接管锁,陈旧锁恢复属于后续 doctor/repair change。
|
|
25
|
+
- Guard 或 Contract 失败:使用 Runtime 返回的恢复命令,不得提交。
|
|
26
|
+
|
|
27
|
+
若最终确认前发现验收或设计需要调整,使用唯一 Archive 回退路径:
|
|
9
28
|
|
|
10
29
|
```powershell
|
|
11
|
-
matrix workflow
|
|
30
|
+
matrix workflow return design --reason acceptance-or-design-gap
|
|
12
31
|
```
|
|
32
|
+
|
|
33
|
+
提交成功后,变更位于 `.matrix/archive/`,工作流完成。
|