mindsystem-cc 4.0.0 → 4.0.1
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
|
@@ -2,22 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
# MINDSYSTEM
|
|
4
4
|
|
|
5
|
-
**
|
|
5
|
+
**A meta-prompting and context engineering system for Claude Code.**
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
_Built on the philosophy of [GSD](https://github.com/glittercowboy/get-shit-done) by TÂCHES._
|
|
10
|
-
|
|
11
|
-
[](https://www.npmjs.com/package/mindsystem-cc)
|
|
12
|
-
[](LICENSE)
|
|
13
|
-
|
|
14
|
-
<br>
|
|
7
|
+
Every piece of work makes the next one better. Mindsystem structures your Claude Code sessions into plannable, executable, verifiable phases — and compounds what it learns into persistent knowledge files that survive `/clear`. The result: context rot stops being the bottleneck, and quality stays consistent from phase 1 to phase 20.
|
|
15
8
|
|
|
16
9
|
```bash
|
|
17
10
|
npx mindsystem-cc
|
|
18
11
|
```
|
|
19
12
|
|
|
20
|
-
|
|
13
|
+
[](https://www.npmjs.com/package/mindsystem-cc)
|
|
14
|
+
[](LICENSE)
|
|
21
15
|
|
|
22
16
|
<br>
|
|
23
17
|
|
|
@@ -25,278 +19,255 @@ npx mindsystem-cc
|
|
|
25
19
|
|
|
26
20
|
<br>
|
|
27
21
|
|
|
28
|
-
[
|
|
22
|
+
[How It Works](#how-it-works) · [Walkthrough](#end-to-end-walkthrough) · [Features](#features) · [Quick Start](#quick-start) · [Config](#configuration) · [Commands](#command-reference) · [Troubleshooting](#troubleshooting)
|
|
29
23
|
|
|
30
24
|
</div>
|
|
31
25
|
|
|
32
26
|
---
|
|
33
27
|
|
|
34
|
-
##
|
|
35
|
-
|
|
36
|
-
> _"I'm a solo developer. I don't write code — Claude Code does. Other spec-driven development tools exist; BMAD, Speckit... But they all seem to make things way more complicated than they need to be. I'm not a 50-person software company. I don't want to play enterprise theater. I'm just a creative person trying to build great things that work."_
|
|
37
|
-
>
|
|
38
|
-
> — **TÂCHES**, creator of the original [GSD](https://github.com/glittercowboy/get-shit-done)
|
|
28
|
+
## How It Works
|
|
39
29
|
|
|
40
|
-
|
|
30
|
+
```
|
|
31
|
+
new-milestone Define what to build next
|
|
32
|
+
│
|
|
33
|
+
create-roadmap Derive requirements, map to phases
|
|
34
|
+
│
|
|
35
|
+
▼
|
|
36
|
+
┌─────────────────┐
|
|
37
|
+
│ Per Phase: │
|
|
38
|
+
│ │
|
|
39
|
+
│ discuss-phase ──┤ (optional) Lock intent, validate assumptions
|
|
40
|
+
│ design-phase ──┤ (optional) Generate mockups, pick direction
|
|
41
|
+
│ research-phase ─┤ (optional) External docs, codebase patterns, community practices
|
|
42
|
+
│ │
|
|
43
|
+
│ plan-phase ─────┤ Break into context-budgeted plans
|
|
44
|
+
│ execute-phase ──┤ Fresh subagents run each plan autonomously
|
|
45
|
+
│ verify-work ────┤ Manual acceptance tests, inline fixes
|
|
46
|
+
│ │
|
|
47
|
+
│ ← repeat ───────┘
|
|
48
|
+
│
|
|
49
|
+
audit-milestone Check requirements coverage, surface tech debt
|
|
50
|
+
│
|
|
51
|
+
complete-milestone Archive, evolve PROJECT.md, clean slate
|
|
52
|
+
```
|
|
41
53
|
|
|
42
|
-
|
|
54
|
+
Each phase gets its own preparation depth. A database migration might skip straight to planning. A user-facing feature might warrant discussion, design mockups, and research first. You pick the depth; the system adapts.
|
|
43
55
|
|
|
44
|
-
|
|
56
|
+
Execution happens in fresh subagent contexts — each plan gets up to 200k tokens of headroom at peak quality, regardless of how much planning you did in the main conversation.
|
|
45
57
|
|
|
46
|
-
|
|
58
|
+
---
|
|
47
59
|
|
|
48
|
-
-
|
|
49
|
-
- **A single source of truth.** Your `.planning/` folder holds what you're building and what you've proven works — not a scrolling chat transcript.
|
|
50
|
-
- **Reviewable diffs.** Every change creates a commit _and_ a `.patch` file you can inspect, apply, or throw away.
|
|
51
|
-
- **Smart division of labor.** Scripts handle mechanics. Models handle judgment calls and code.
|
|
60
|
+
## End-to-End Walkthrough
|
|
52
61
|
|
|
53
|
-
###
|
|
62
|
+
### 1. New Milestone
|
|
54
63
|
|
|
55
|
-
|
|
64
|
+
```
|
|
65
|
+
/ms:new-milestone
|
|
66
|
+
```
|
|
56
67
|
|
|
57
|
-
|
|
58
|
-
- **Mock-assisted testing.** Generate mock states for tricky scenarios (errors, empty states, role-based views) without shipping mock code.
|
|
59
|
-
- **Patch files everywhere.** Phase execution and UAT fixes produce `.patch` files (`{phase}-changes.patch`, `{phase}-uat-fixes.patch`) so you can diff before you commit.
|
|
60
|
-
- **UI quality tools.** `/ms:design-phase` writes UI/UX specs. `/ms:review-design` audits existing UI and suggests improvements.
|
|
61
|
-
- **Fast research via CLI.** `ms-lookup` searches APIs (Context7 docs, Perplexity) with caching and JSON output. Example: `ms-lookup docs react "useEffect cleanup"`.
|
|
62
|
-
- **Lean milestone management.** Finishing a milestone consolidates decisions into `vX.Y-DECISIONS.md` and archives the rest, keeping `.planning/` tidy.
|
|
63
|
-
- **Configurable code reviews.** Reviewers run after execution and at milestone audits, creating separate commits. Milestone reviews can be report-only — you decide what gets fixed.
|
|
64
|
-
- **Design mockups.** `/ms:design-phase` generates parallel HTML/CSS mockup variants to explore visual directions before locking a design spec.
|
|
65
|
-
- **Cross-milestone learnings.** Milestone completion extracts curated patterns into `LEARNINGS.md` so planning in future milestones starts smarter.
|
|
66
|
-
- **Structured tech debt.** `/ms:audit-milestone` maintains `TECH-DEBT.md` — a single source of truth for debt items with severity, source, and suggested fixes.
|
|
68
|
+
Claude reads your project history — tech debt, deferred requirements, validated decisions — and surfaces strategic directions. You articulate the vision. The output is a `MILESTONE-CONTEXT.md` that grounds everything downstream.
|
|
67
69
|
|
|
68
|
-
|
|
70
|
+
This is dream extraction: Claude acts as product owner, helping you think through what to build next by asking the right questions rather than prescribing answers.
|
|
69
71
|
|
|
70
|
-
|
|
72
|
+
### 2. Create Roadmap
|
|
71
73
|
|
|
72
74
|
```
|
|
73
|
-
|
|
74
|
-
↓
|
|
75
|
-
EXECUTE Fresh subagents run each task (commits + .patch files)
|
|
76
|
-
↓
|
|
77
|
-
VERIFY You test manually, Mindsystem fixes inline, repeat until done
|
|
78
|
-
↓
|
|
79
|
-
SHIP Audit milestone, archive decisions, start fresh
|
|
75
|
+
/ms:create-roadmap
|
|
80
76
|
```
|
|
81
77
|
|
|
82
|
-
|
|
78
|
+
Claude derives requirements from your milestone context, assigns each a `REQ-ID`, and maps them to phases with success criteria. You approve scope and phase grouping.
|
|
83
79
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
npx mindsystem-cc
|
|
88
|
-
```
|
|
80
|
+
Requirements define what must be TRUE when you ship, not what to build. This goal-backward framing means verification can check outcomes, not task completion.
|
|
89
81
|
|
|
90
|
-
|
|
82
|
+
**Creates:** `REQUIREMENTS.md`, `ROADMAP.md`, `STATE.md`, phase directories.
|
|
91
83
|
|
|
92
|
-
|
|
84
|
+
### 3. Discuss Phase (optional, recommended)
|
|
93
85
|
|
|
94
86
|
```
|
|
95
|
-
/ms:
|
|
87
|
+
/ms:discuss-phase 1
|
|
96
88
|
```
|
|
97
89
|
|
|
98
|
-
|
|
99
|
-
<summary><strong>Non-interactive install (Docker, CI, scripts)</strong></summary>
|
|
90
|
+
The most impactful human moment in the pipeline. Claude loads milestone context, feature knowledge files, and competitor research — then surfaces its assumptions with confidence levels. You validate intent, make tradeoff decisions, correct misunderstandings.
|
|
100
91
|
|
|
101
|
-
|
|
102
|
-
npx mindsystem-cc --global # Install to ~/.claude/
|
|
103
|
-
npx mindsystem-cc --local # Install to ./.claude/
|
|
104
|
-
```
|
|
92
|
+
Everything downstream flows from decisions made here. The assumption-based briefing catches misalignment before a single line of code is written.
|
|
105
93
|
|
|
106
|
-
|
|
94
|
+
**Creates:** `CONTEXT.md` with vision, essentials, and reasoning-backed decisions.
|
|
107
95
|
|
|
108
|
-
|
|
109
|
-
<summary><strong>Staying updated</strong></summary>
|
|
110
|
-
|
|
111
|
-
Inside Claude Code:
|
|
96
|
+
### 4. Design Phase (optional)
|
|
112
97
|
|
|
113
98
|
```
|
|
114
|
-
/ms:
|
|
99
|
+
/ms:design-phase 1
|
|
115
100
|
```
|
|
116
101
|
|
|
117
|
-
|
|
102
|
+
Claude generates parallel HTML/CSS mockup variants and a side-by-side comparison page that opens in your browser. You pick a direction, iterate with feedback.
|
|
118
103
|
|
|
119
|
-
|
|
120
|
-
|
|
104
|
+
The output is a `DESIGN.md` with exact design tokens — hex colors, px spacing, font weights — not descriptions of what things should look like. Implementable, not interpretive.
|
|
105
|
+
|
|
106
|
+
### 5. Research Phase (optional)
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
/ms:research-phase 1
|
|
121
110
|
```
|
|
122
111
|
|
|
123
|
-
|
|
112
|
+
Three parallel agents investigate simultaneously: one queries external documentation through Perplexity and Context7, one analyzes your codebase for existing patterns, one surveys community best practices. Claude synthesizes findings into `RESEARCH.md` with confidence levels and source attribution.
|
|
124
113
|
|
|
125
|
-
|
|
126
|
-
<summary><strong>Development installation</strong></summary>
|
|
114
|
+
You resolve library conflicts if any arise. Otherwise, this phase runs with minimal input.
|
|
127
115
|
|
|
128
|
-
|
|
116
|
+
### 6. Plan Phase
|
|
129
117
|
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
cd mindsystem
|
|
133
|
-
node bin/install.js --local
|
|
118
|
+
```
|
|
119
|
+
/ms:plan-phase 1
|
|
134
120
|
```
|
|
135
121
|
|
|
136
|
-
|
|
122
|
+
Claude breaks the phase into tasks, groups them into plans targeting 25-45% of the context budget. Plans are pure markdown — no YAML frontmatter, no XML containers. The plan IS the executable prompt, with ~90% actionable content and ~10% structure.
|
|
137
123
|
|
|
138
|
-
|
|
124
|
+
Independent plans are grouped into waves for parallel execution. A risk score (0-100) flags complex plans for optional verification before you commit to running them.
|
|
139
125
|
|
|
140
|
-
|
|
126
|
+
You approve the plan structure and can adjust granularity.
|
|
127
|
+
|
|
128
|
+
**Creates:** `PLAN.md` files, `EXECUTION-ORDER.md`.
|
|
129
|
+
|
|
130
|
+
### 7. Execute Phase
|
|
131
|
+
|
|
132
|
+
```
|
|
133
|
+
/ms:execute-phase 1
|
|
134
|
+
```
|
|
141
135
|
|
|
142
|
-
|
|
136
|
+
Fully autonomous. Each plan runs in a fresh subagent with the full context window available. Goal-backward verification checks that the phase achieved its intended outcome — not that tasks were marked complete.
|
|
143
137
|
|
|
144
|
-
|
|
138
|
+
Configurable code review produces separate commits for review changes. Patch files are generated for manual inspection.
|
|
145
139
|
|
|
146
|
-
|
|
140
|
+
After execution, knowledge consolidation updates subsystem-scoped knowledge files. Future phases that touch the same subsystems start with accumulated context about decisions made, patterns established, and pitfalls encountered.
|
|
147
141
|
|
|
148
|
-
**
|
|
142
|
+
**Creates:** `SUMMARY.md`, `VERIFICATION.md`, `.patch` files, knowledge file updates.
|
|
149
143
|
|
|
150
|
-
|
|
144
|
+
### 8. Verify Work
|
|
151
145
|
|
|
152
146
|
```
|
|
153
|
-
/ms:
|
|
154
|
-
/ms:research-project # optional (recommended when domain is new)
|
|
155
|
-
/ms:create-roadmap
|
|
156
|
-
/ms:plan-phase 1
|
|
157
|
-
/ms:execute-phase 1
|
|
147
|
+
/ms:verify-work 1
|
|
158
148
|
```
|
|
159
149
|
|
|
160
|
-
|
|
150
|
+
The quality gate. You run manual acceptance tests presented in batches of 4. Claude fixes issues inline or via subagent, then asks you to re-test until passing.
|
|
161
151
|
|
|
162
|
-
-
|
|
163
|
-
- `.planning/REQUIREMENTS.md` — checkable scope
|
|
164
|
-
- `.planning/ROADMAP.md` + `.planning/STATE.md` — plan and project memory
|
|
152
|
+
For hard-to-test scenarios — error states, loading screens, role-based views — mock generation creates temporary inline states without shipping test infrastructure.
|
|
165
153
|
|
|
166
|
-
|
|
154
|
+
Fixes compound into knowledge files through automatic consolidation. This is where edge cases, UI tweaks, and small bugs get caught before moving on.
|
|
167
155
|
|
|
168
|
-
|
|
156
|
+
**Creates:** `UAT.md`, `uat-fixes.patch`, knowledge file updates.
|
|
169
157
|
|
|
170
|
-
|
|
158
|
+
### 9. Repeat
|
|
171
159
|
|
|
172
|
-
|
|
160
|
+
Run steps 3-8 for each phase. Pick the preparation depth each phase needs.
|
|
161
|
+
|
|
162
|
+
### 10. Audit Milestone
|
|
173
163
|
|
|
174
164
|
```
|
|
175
|
-
/ms:
|
|
176
|
-
/ms:new-project
|
|
177
|
-
/ms:research-project # optional (use for new domain areas)
|
|
178
|
-
/ms:create-roadmap
|
|
179
|
-
/ms:plan-phase 1
|
|
180
|
-
/ms:execute-phase 1
|
|
165
|
+
/ms:audit-milestone
|
|
181
166
|
```
|
|
182
167
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
- `.planning/codebase/*` — captured conventions and structure
|
|
186
|
-
- `.planning/PROJECT.md` / `.planning/REQUIREMENTS.md` / `.planning/ROADMAP.md`
|
|
187
|
-
|
|
188
|
-
### Add feature (existing product)
|
|
168
|
+
Claude checks requirements coverage against `REQ-IDs`, spawns an integration checker for cross-phase wiring, aggregates untested UAT assumptions, and consolidates tech debt into `TECH-DEBT.md` with severity tiers and `TD-IDs`.
|
|
189
169
|
|
|
190
|
-
|
|
170
|
+
Optional code review with quality-phase decisions for high-impact findings — you decide what gets fixed vs. accepted as debt.
|
|
191
171
|
|
|
192
|
-
|
|
172
|
+
### 11. Complete Milestone
|
|
193
173
|
|
|
194
174
|
```
|
|
195
|
-
/ms:
|
|
196
|
-
/ms:discuss-phase <N> # optional (lock intent before planning)
|
|
197
|
-
/ms:design-phase <N> # optional (UI-heavy)
|
|
198
|
-
/ms:plan-phase <N>
|
|
199
|
-
/ms:execute-phase <N>
|
|
175
|
+
/ms:complete-milestone
|
|
200
176
|
```
|
|
201
177
|
|
|
202
|
-
|
|
178
|
+
Full `PROJECT.md` evolution: validates core value proposition, moves shipped requirements to validated, triages deferred items. Archives the milestone to `.planning/milestones/{name}/` with the roadmap, requirements, and phase summaries.
|
|
203
179
|
|
|
204
|
-
|
|
205
|
-
- `.planning/phases/<N>-*/<N>-01-PLAN.md` + `*-SUMMARY.md`
|
|
180
|
+
Updates `MILESTONES.md` with stats and accomplishments. Clean slate for the next `/ms:new-milestone`.
|
|
206
181
|
|
|
207
|
-
|
|
182
|
+
---
|
|
208
183
|
|
|
209
|
-
|
|
184
|
+
## Features
|
|
210
185
|
|
|
211
|
-
|
|
186
|
+
### Knowledge Compounding
|
|
212
187
|
|
|
213
|
-
|
|
188
|
+
The core differentiator. Subsystem-scoped knowledge files are enriched after every phase. Execute-phase consolidates implementation decisions. Verify-work compounds fixes and edge cases. `/ms:compound` catches out-of-pipeline work — direct Claude sessions, manual edits, merged branches.
|
|
214
189
|
|
|
215
|
-
|
|
216
|
-
/ms:plan-phase <N>
|
|
217
|
-
/ms:execute-phase <N>
|
|
218
|
-
/ms:verify-work <N>
|
|
219
|
-
```
|
|
190
|
+
The effect accumulates: phase 1 starts from scratch; phase 10 starts with a knowledge base that captures what works, what failed, and why.
|
|
220
191
|
|
|
221
|
-
|
|
192
|
+
### Context Budget Management
|
|
222
193
|
|
|
223
|
-
-
|
|
224
|
-
- `.planning/phases/<N>-*/<N>-VERIFICATION.md` — phase goal verification report
|
|
225
|
-
- `.planning/phases/<N>-*/<N>-UAT.md` + `<N>-uat-fixes.patch` — manual test log and fixes diff
|
|
194
|
+
Plans target 25-45% of the context window. Execution runs in fresh subagents — no inherited drift from long planning conversations. The 50% rule ensures plans complete before quality degrades.
|
|
226
195
|
|
|
227
|
-
|
|
196
|
+
Orchestration metadata (wave grouping, dependencies) lives in `EXECUTION-ORDER.md`, separate from plans. Plans carry only what the executor needs: context, changes, verification, must-haves.
|
|
228
197
|
|
|
229
|
-
|
|
198
|
+
### Built-in Code Review
|
|
230
199
|
|
|
231
|
-
|
|
200
|
+
Configurable per tier — adhoc, phase, or milestone. Runs after execution and produces separate commits for inspection. Ships with structural analysis (`ms-code-reviewer`) and clarity-focused simplification (`ms-code-simplifier`), but you can point any tier at your own custom reviewer agent via `.planning/config.json`.
|
|
232
201
|
|
|
233
|
-
|
|
202
|
+
### Structured Debugging
|
|
234
203
|
|
|
235
|
-
|
|
204
|
+
`/ms:debug` creates investigation state that persists across `/clear`. Scientific method: gather evidence, form hypotheses, test. Resume any debug session by running `/ms:debug` with no arguments. Archives resolved issues to `.planning/debug/resolved/`.
|
|
236
205
|
|
|
237
|
-
|
|
238
|
-
/ms:debug "Describe symptoms and what you observed"
|
|
239
|
-
```
|
|
206
|
+
### Adhoc Execution
|
|
240
207
|
|
|
241
|
-
|
|
208
|
+
Work that's too coherent for a todo but too small for formal phase planning. `/ms:adhoc` reads existing knowledge files, generates a standard-format plan, executes, reviews, and consolidates learnings — all in one context. Accepts Linear ticket IDs, todo file paths, or plain descriptions.
|
|
242
209
|
|
|
243
|
-
|
|
244
|
-
- **Must happen before next phase:** `/ms:insert-phase <after> "Hotfix: <bug>"` → `/ms:plan-phase <N>` → `/ms:execute-phase <N>`
|
|
245
|
-
- **Belongs in current phase after verification gaps:** `/ms:plan-phase <N> --gaps` → `/ms:execute-phase <N>`
|
|
210
|
+
### Design Mockups
|
|
246
211
|
|
|
247
|
-
|
|
212
|
+
`/ms:design-phase` generates parallel HTML/CSS variant mockups with a side-by-side comparison page. Design tokens in the output are exact values (hex, px, font-weight), not descriptions. `/ms:review-design` audits existing screens using screenshots for retroactive design improvement.
|
|
248
213
|
|
|
249
|
-
|
|
214
|
+
### Project Health
|
|
250
215
|
|
|
251
|
-
|
|
252
|
-
| ----------------------------- | -------------------------------- |
|
|
253
|
-
| Non-urgent work for later | `/ms:add-phase "..."` |
|
|
254
|
-
| Urgent work before next phase | `/ms:insert-phase <after> "..."` |
|
|
255
|
-
| Task to capture for later | `/ms:add-todo "..."` |
|
|
256
|
-
| Discovered work to do now | `/ms:adhoc "..."` |
|
|
216
|
+
`/ms:doctor` runs 10 health checks: subsystem vocabulary, directory structure, milestone naming, knowledge files, CLI wrappers, API keys, version freshness. Fixes are applied in dependency order with atomic commits. Safe to run repeatedly.
|
|
257
217
|
|
|
258
|
-
###
|
|
218
|
+
### Smart Routing
|
|
259
219
|
|
|
260
|
-
|
|
220
|
+
`/ms:progress` reads project state and tells you what to run next. Visual progress bar, recent work summary, pending todos, active debug sessions. Reconstructs `STATE.md` from artifacts if it's missing. Also detects available updates.
|
|
261
221
|
|
|
262
|
-
|
|
222
|
+
### Deferred Requirements
|
|
263
223
|
|
|
264
|
-
|
|
265
|
-
/ms:audit-milestone
|
|
266
|
-
/ms:complete-milestone
|
|
267
|
-
/ms:new-milestone
|
|
268
|
-
```
|
|
224
|
+
Requirements you want but haven't shipped track in `PROJECT.md` with origin milestone and deferral reason. `complete-milestone` triages them before archiving; `create-roadmap` consumes them as candidates for new milestones. Nothing falls through the cracks.
|
|
269
225
|
|
|
270
|
-
|
|
226
|
+
### Task Capture
|
|
271
227
|
|
|
272
|
-
- `.planning/
|
|
273
|
-
- Active docs stay lean; full detail lives in the version folder
|
|
228
|
+
`/ms:add-todo` with Linear-inspired metadata: priority (1-4), estimate (XS-XL), inferred subsystem. Todos live as flat files in `.planning/todos/`. Address them later via `/ms:adhoc`, which reads the problem description, executes the work, and moves the todo to `done/`.
|
|
274
229
|
|
|
275
|
-
|
|
230
|
+
### Codebase Mapping
|
|
231
|
+
|
|
232
|
+
`/ms:map-codebase` spawns 4 parallel agents producing 7 structured documents: stack, architecture, conventions, testing, integrations, directory structure, and concerns. Use on brownfield projects so Mindsystem respects your existing patterns.
|
|
276
233
|
|
|
277
234
|
---
|
|
278
235
|
|
|
279
|
-
##
|
|
236
|
+
## Quick Start
|
|
280
237
|
|
|
281
|
-
|
|
238
|
+
### New project
|
|
282
239
|
|
|
283
|
-
|
|
240
|
+
```
|
|
241
|
+
/ms:new-project
|
|
242
|
+
/ms:create-roadmap
|
|
243
|
+
/ms:plan-phase 1
|
|
244
|
+
/ms:execute-phase 1
|
|
245
|
+
/ms:verify-work 1
|
|
246
|
+
```
|
|
284
247
|
|
|
285
|
-
|
|
248
|
+
You'll get `.planning/` with your project vision, requirements, roadmap, and the first phase implemented with commits, patch files, and knowledge files.
|
|
249
|
+
|
|
250
|
+
### Existing project
|
|
251
|
+
|
|
252
|
+
```
|
|
253
|
+
/ms:new-project
|
|
254
|
+
/ms:map-codebase
|
|
255
|
+
/ms:create-roadmap
|
|
256
|
+
/ms:plan-phase 1
|
|
257
|
+
/ms:execute-phase 1
|
|
258
|
+
```
|
|
286
259
|
|
|
287
|
-
|
|
260
|
+
Codebase mapping produces 7 documents covering your stack, conventions, and architecture. All downstream planning and execution respects what's already there.
|
|
288
261
|
|
|
289
|
-
**
|
|
262
|
+
**Returning after a break?** Run `/ms:progress` — it shows where you left off and what to do next.
|
|
290
263
|
|
|
291
264
|
---
|
|
292
265
|
|
|
293
266
|
## Configuration
|
|
294
267
|
|
|
295
|
-
Mindsystem stores project config in `.planning/config.json`.
|
|
268
|
+
Mindsystem stores project config in `.planning/config.json`. Run `/ms:config` to set up code reviewers, mockup preferences, gitignore patterns, and git remote.
|
|
296
269
|
|
|
297
|
-
### Code review
|
|
298
|
-
|
|
299
|
-
After `/ms:execute-phase` (and optionally `/ms:audit-milestone`), Mindsystem runs a reviewer that produces a **separate commit** for easy inspection.
|
|
270
|
+
### Code review tiers
|
|
300
271
|
|
|
301
272
|
```json
|
|
302
273
|
{
|
|
@@ -308,48 +279,70 @@ After `/ms:execute-phase` (and optionally `/ms:audit-milestone`), Mindsystem run
|
|
|
308
279
|
}
|
|
309
280
|
```
|
|
310
281
|
|
|
311
|
-
|
|
282
|
+
| Value | Behavior |
|
|
283
|
+
| ----- | -------- |
|
|
284
|
+
| `null` | No reviewer (default) |
|
|
285
|
+
| `"ms-code-reviewer"` | Structural analysis — architectural and design issues |
|
|
286
|
+
| `"ms-code-simplifier"` | Clarity-focused — improves readability and maintainability |
|
|
287
|
+
| `"skip"` | Disable review for that tier |
|
|
288
|
+
|
|
289
|
+
---
|
|
312
290
|
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
|
291
|
+
## Command Reference
|
|
292
|
+
|
|
293
|
+
Full docs live in `/ms:help`.
|
|
294
|
+
|
|
295
|
+
| Command | What it does |
|
|
296
|
+
| ------- | ------------ |
|
|
297
|
+
| `/ms:help` | Show the full command reference |
|
|
298
|
+
| `/ms:progress` | Show where you are and what to run next |
|
|
299
|
+
| `/ms:new-project` | Initialize `.planning/` and capture project intent |
|
|
300
|
+
| `/ms:config` | Configure code reviewers, mockups, gitignore, git remote |
|
|
301
|
+
| `/ms:map-codebase` | Document existing repo's stack, structure, and conventions |
|
|
302
|
+
| `/ms:research-project` | Domain research saved to `.planning/research/` |
|
|
303
|
+
| `/ms:create-roadmap` | Define requirements and create phases mapped to them |
|
|
304
|
+
| `/ms:new-milestone [name]` | Discover what to build next, start new milestone |
|
|
305
|
+
| `/ms:discuss-phase <number>` | Product-informed collaborative thinking before planning |
|
|
306
|
+
| `/ms:design-phase <number>` | Generate UI/UX spec and optional HTML mockups |
|
|
307
|
+
| `/ms:review-design [scope]` | Audit and improve existing UI quality |
|
|
308
|
+
| `/ms:research-phase <number>` | Deep research for niche phase domains |
|
|
309
|
+
| `/ms:plan-phase [number]` | Create context-budgeted plans with optional risk scoring |
|
|
310
|
+
| `/ms:execute-phase <number>` | Run all unexecuted plans in fresh subagents |
|
|
311
|
+
| `/ms:verify-work [number]` | Batched manual UAT with inline fixes |
|
|
312
|
+
| `/ms:debug [description]` | Structured debugging that survives `/clear` |
|
|
313
|
+
| `/ms:adhoc <description>` | Knowledge-aware execution for discovered work |
|
|
314
|
+
| `/ms:compound [input]` | Compound out-of-pipeline changes into knowledge files |
|
|
315
|
+
| `/ms:add-phase <description>` | Append a new phase to the roadmap |
|
|
316
|
+
| `/ms:insert-phase <after> <description>` | Insert urgent work between phases |
|
|
317
|
+
| `/ms:remove-phase <number>` | Delete a future phase and renumber |
|
|
318
|
+
| `/ms:add-todo [description]` | Capture a task with priority, estimate, subsystem |
|
|
319
|
+
| `/ms:audit-milestone [name]` | Audit completion and surface gaps |
|
|
320
|
+
| `/ms:complete-milestone [name]` | Archive milestone and prepare for next |
|
|
321
|
+
| `/ms:doctor` | Health check and fix project configuration |
|
|
322
|
+
| `/ms:update` | Check for and install latest version |
|
|
323
|
+
| `/ms:release-notes` | Show full release notes with update status |
|
|
318
324
|
|
|
319
325
|
---
|
|
320
326
|
|
|
321
|
-
##
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
| `/ms:verify-work [number]` | Batched manual UAT with inline fixes |
|
|
341
|
-
| `/ms:debug [issue description]` | Structured debugging that survives `/clear` |
|
|
342
|
-
| `/ms:adhoc <description>` | Execute discovered work with knowledge-aware planning |
|
|
343
|
-
| `/ms:add-phase <description>` | Append a new phase to the roadmap |
|
|
344
|
-
| `/ms:insert-phase <after> <description>` | Insert urgent work between phases |
|
|
345
|
-
| `/ms:remove-phase <number>` | Delete a future phase and renumber |
|
|
346
|
-
| `/ms:audit-milestone [version]` | Audit completion and surface gaps |
|
|
347
|
-
| `/ms:complete-milestone <version>` | Archive and consolidate decisions |
|
|
348
|
-
| `/ms:new-milestone [name]` | Discover what to build next, start new milestone |
|
|
349
|
-
| `/ms:add-todo [description]` | Capture a deferred task in `.planning/todos/` |
|
|
350
|
-
| `/ms:check-todos [area]` | List pending todos and route into work |
|
|
351
|
-
| `/ms:doctor` | Health check and fix project configuration |
|
|
352
|
-
| `/ms:release-notes` | Show full release notes with update status |
|
|
327
|
+
## Updating
|
|
328
|
+
|
|
329
|
+
Inside Claude Code:
|
|
330
|
+
|
|
331
|
+
```
|
|
332
|
+
/ms:update
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
Check what changed:
|
|
336
|
+
|
|
337
|
+
```
|
|
338
|
+
/ms:release-notes
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
From your terminal:
|
|
342
|
+
|
|
343
|
+
```bash
|
|
344
|
+
npx mindsystem-cc@latest
|
|
345
|
+
```
|
|
353
346
|
|
|
354
347
|
---
|
|
355
348
|
|
|
@@ -365,6 +358,10 @@ Full docs live in `/ms:help` (same content as `commands/ms/help.md`).
|
|
|
365
358
|
- Run `/ms:help` to verify installation.
|
|
366
359
|
- Re-run `npx mindsystem-cc` to reinstall.
|
|
367
360
|
|
|
361
|
+
**Outdated project structure after a major update?**
|
|
362
|
+
|
|
363
|
+
- Run `/ms:doctor` to detect and fix stale artifacts, missing config fields, and directory structure changes between versions.
|
|
364
|
+
|
|
368
365
|
**Updating to the latest version?**
|
|
369
366
|
|
|
370
367
|
```bash
|
|
@@ -376,11 +373,3 @@ npx mindsystem-cc@latest
|
|
|
376
373
|
## License
|
|
377
374
|
|
|
378
375
|
MIT License. See [LICENSE](LICENSE) for details.
|
|
379
|
-
|
|
380
|
-
---
|
|
381
|
-
|
|
382
|
-
<div align="center">
|
|
383
|
-
|
|
384
|
-
**Claude Code is powerful. Mindsystem makes it reliable.**
|
|
385
|
-
|
|
386
|
-
</div>
|
package/commands/ms/help.md
CHANGED
|
@@ -61,7 +61,7 @@ Initialize → (Optional Research) → Roadmap → Plan → Execute → Verify
|
|
|
61
61
|
|
|
62
62
|
Common deviations:
|
|
63
63
|
- Existing repo: `/ms:map-codebase` after `/ms:new-project` (or before — either works)
|
|
64
|
-
- Plan looks wrong: `/ms:discuss-phase <phase>`
|
|
64
|
+
- Plan looks wrong: `/ms:discuss-phase <phase>`
|
|
65
65
|
- Unknown domain: `/ms:research-project` or `/ms:research-phase <phase>`
|
|
66
66
|
- Phase prep: `/ms:discuss-phase` → `/ms:design-phase` → `/ms:research-phase` → `/ms:plan-phase` (all optional before plan)
|
|
67
67
|
- Execution gaps: `/ms:plan-phase <phase> --gaps` then `/ms:execute-phase <phase>`
|
|
@@ -202,16 +202,6 @@ Usage: `/ms:execute-phase 5`
|
|
|
202
202
|
|
|
203
203
|
### Verification
|
|
204
204
|
|
|
205
|
-
**`/ms:check-phase <number>`**
|
|
206
|
-
Verify phase plans before execution (optional quality gate).
|
|
207
|
-
|
|
208
|
-
- Use when: the phase is complex or risky and you want a “will this actually achieve the goal?” sanity check before executing.
|
|
209
|
-
- Spawns plan checker agent to analyze PLAN.md files
|
|
210
|
-
- Checks requirement coverage, task completeness, dependencies
|
|
211
|
-
- Use for complex phases before committing to execution
|
|
212
|
-
|
|
213
|
-
Usage: `/ms:check-phase 5`
|
|
214
|
-
|
|
215
205
|
**`/ms:verify-work [number]`**
|
|
216
206
|
User acceptance testing of phase or plan.
|
|
217
207
|
|
|
@@ -479,7 +469,6 @@ Usage: `/ms:release-notes`
|
|
|
479
469
|
|
|
480
470
|
```
|
|
481
471
|
/ms:plan-phase 5 # Create one or more PLAN.md files
|
|
482
|
-
/ms:check-phase 5 # (optional) Sanity check: plans will achieve goal
|
|
483
472
|
/ms:execute-phase 5 # Execute; produces SUMMARY + VERIFICATION
|
|
484
473
|
# If gaps found during verification:
|
|
485
474
|
/ms:plan-phase 5 --gaps # Create additional plans to close verifier gaps
|
|
@@ -195,7 +195,7 @@ Execution order lives in a single `EXECUTION-ORDER.md` file alongside the plans.
|
|
|
195
195
|
|----------|--------|
|
|
196
196
|
| How does the verifier find must-haves? | Reads `## Must-Haves` section |
|
|
197
197
|
| How does the executor know the subsystem? | Reads inline metadata (`**Subsystem:**`) |
|
|
198
|
-
| How
|
|
198
|
+
| How is plan verification done? | Reads EXECUTION-ORDER.md + plan structure |
|
|
199
199
|
| What triggers TDD lazy-loading? | `**Type:** tdd` in inline metadata |
|
|
200
200
|
| How does the executor know why an approach was chosen? | Reads `## Context` section |
|
|
201
201
|
| How does the executor find existing utilities? | Reads `**Files:**` lines and inline references in `## Changes` |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Optional verification step for plan-phase workflow. Calculates risk score from already-loaded context and prompts user to verify or skip.
|
|
3
3
|
|
|
4
4
|
<purpose>
|
|
5
|
-
Provide lightweight risk assessment after plan creation to help users decide whether to run
|
|
5
|
+
Provide lightweight risk assessment after plan creation to help users decide whether to run plan verification before execution.
|
|
6
6
|
|
|
7
7
|
**Key principle:** All information is already in context from earlier workflow steps. No additional file reads or subagent spawns needed for scoring.
|
|
8
8
|
</purpose>
|
package/package.json
CHANGED
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: ms:check-phase
|
|
3
|
-
description: Verify phase plans before execution (optional quality gate)
|
|
4
|
-
arguments: phase
|
|
5
|
-
allowed-tools:
|
|
6
|
-
- Read
|
|
7
|
-
- Bash
|
|
8
|
-
- Glob
|
|
9
|
-
- Grep
|
|
10
|
-
- Task
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
<objective>
|
|
14
|
-
On-demand plan verification. Use when a plan seems large or complex and you want a structured review before executing.
|
|
15
|
-
|
|
16
|
-
This spawns ms-plan-checker to analyze your PLAN.md files against the phase goal.
|
|
17
|
-
</objective>
|
|
18
|
-
|
|
19
|
-
<what_it_checks>
|
|
20
|
-
1. **Requirement Coverage** — Does every phase requirement have tasks addressing it?
|
|
21
|
-
2. **Task Completeness** — Does every change have Files, implementation details, and verification?
|
|
22
|
-
3. **Dependency Correctness** — Are plan dependencies valid and acyclic?
|
|
23
|
-
4. **Key Links Planned** — Are artifacts wired together, not just created in isolation?
|
|
24
|
-
5. **Scope Sanity** — Are plans reasonably sized for context budget (target 25-45%)?
|
|
25
|
-
6. **Verification Derivation** — Are Must-Haves user-observable, not implementation-focused?
|
|
26
|
-
7. **Context Compliance** — Do plans honor decisions from CONTEXT.md?
|
|
27
|
-
</what_it_checks>
|
|
28
|
-
|
|
29
|
-
<process>
|
|
30
|
-
|
|
31
|
-
<step name="validate_phase">
|
|
32
|
-
Phase number from $ARGUMENTS (required).
|
|
33
|
-
|
|
34
|
-
```bash
|
|
35
|
-
PHASE=$ARGUMENTS
|
|
36
|
-
PADDED=$(printf "%02d" $PHASE 2>/dev/null || echo "$PHASE")
|
|
37
|
-
PHASE_DIR=$(ls -d .planning/phases/${PADDED}-* .planning/phases/${PHASE}-* 2>/dev/null | head -1)
|
|
38
|
-
|
|
39
|
-
if [ -z "$PHASE_DIR" ]; then
|
|
40
|
-
echo "Error: Phase $PHASE not found in .planning/phases/"
|
|
41
|
-
exit 1
|
|
42
|
-
fi
|
|
43
|
-
|
|
44
|
-
echo "Phase directory: $PHASE_DIR"
|
|
45
|
-
ls "$PHASE_DIR"/*-PLAN.md 2>/dev/null
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
If no PLAN.md files found, remind user to run `/ms:plan-phase` first.
|
|
49
|
-
</step>
|
|
50
|
-
|
|
51
|
-
<step name="spawn_checker">
|
|
52
|
-
Spawn the plan checker agent:
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
Task(
|
|
56
|
-
subagent_type="ms-plan-checker",
|
|
57
|
-
prompt="""
|
|
58
|
-
Verify plans for phase $ARGUMENTS.
|
|
59
|
-
|
|
60
|
-
1. Read .planning/ROADMAP.md to get the phase goal
|
|
61
|
-
2. Read all *-PLAN.md files in the phase directory
|
|
62
|
-
3. Read CONTEXT.md if it exists in the phase directory
|
|
63
|
-
4. Run all 7 verification dimensions (dimension 7 only if CONTEXT.md exists)
|
|
64
|
-
5. Return structured result
|
|
65
|
-
|
|
66
|
-
Phase directory: $PHASE_DIR
|
|
67
|
-
""",
|
|
68
|
-
description="Verify phase $ARGUMENTS plans"
|
|
69
|
-
)
|
|
70
|
-
```
|
|
71
|
-
</step>
|
|
72
|
-
|
|
73
|
-
<step name="present_results">
|
|
74
|
-
Present the checker's findings clearly.
|
|
75
|
-
|
|
76
|
-
**Format for VERIFICATION PASSED:**
|
|
77
|
-
|
|
78
|
-
```
|
|
79
|
-
## Plan Verification: PASSED
|
|
80
|
-
|
|
81
|
-
Phase: [name] | Plans: [count] | Tasks: [total count]
|
|
82
|
-
|
|
83
|
-
All checks passed.
|
|
84
|
-
|
|
85
|
-
Ready to execute: `/ms:execute-phase $ARGUMENTS`
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
**Format for ISSUES FOUND:**
|
|
89
|
-
|
|
90
|
-
```
|
|
91
|
-
## Plan Verification: ISSUES FOUND
|
|
92
|
-
|
|
93
|
-
Phase: [name] | Plans: [count] | Issues: [X blockers, Y warnings]
|
|
94
|
-
|
|
95
|
-
### Blockers (must fix)
|
|
96
|
-
|
|
97
|
-
1. **[dimension]** [description]
|
|
98
|
-
Plan: [which plan] | Fix: [specific fix hint]
|
|
99
|
-
|
|
100
|
-
### Warnings (should fix)
|
|
101
|
-
|
|
102
|
-
1. **[dimension]** [description]
|
|
103
|
-
Fix: [hint]
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
|
|
107
|
-
Options:
|
|
108
|
-
- Fix the issues and run `/ms:check-phase $ARGUMENTS` again
|
|
109
|
-
- Proceed anyway: `/ms:execute-phase $ARGUMENTS` (not recommended if blockers exist)
|
|
110
|
-
```
|
|
111
|
-
</step>
|
|
112
|
-
|
|
113
|
-
</process>
|
|
114
|
-
|
|
115
|
-
<examples>
|
|
116
|
-
**Check before executing a complex phase:**
|
|
117
|
-
```
|
|
118
|
-
/ms:check-phase 5
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
**Typical workflow:**
|
|
122
|
-
```
|
|
123
|
-
/ms:plan-phase 5 # Interactive planning in main context
|
|
124
|
-
# ... review and iterate ...
|
|
125
|
-
/ms:check-phase 5 # Optional verification for complex plans
|
|
126
|
-
/ms:execute-phase 5 # Execute
|
|
127
|
-
```
|
|
128
|
-
</examples>
|
|
129
|
-
|
|
130
|
-
<success_criteria>
|
|
131
|
-
- Blockers and warnings presented distinctly — blockers have plan name and fix hint
|
|
132
|
-
- Output includes actionable next command (`/ms:execute-phase` or `/ms:check-phase` rerun)
|
|
133
|
-
- Checker agent spawned with correct phase directory path
|
|
134
|
-
</success_criteria>
|