mindsystem-cc 4.0.0 → 4.0.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 +246 -220
- package/agents/ms-debugger.md +2 -3
- package/agents/ms-verifier.md +4 -4
- package/bin/install.js +9 -1
- package/commands/ms/add-todo.md +1 -1
- package/commands/ms/audit-milestone.md +1 -1
- package/commands/ms/config.md +8 -10
- package/commands/ms/debug.md +1 -1
- package/commands/ms/design-phase.md +1 -1
- package/commands/ms/execute-phase.md +1 -1
- package/commands/ms/help.md +31 -22
- package/commands/ms/plan-phase.md +3 -17
- package/commands/ms/progress.md +9 -5
- package/commands/ms/research-phase.md +1 -1
- package/mindsystem/references/continuation-format.md +1 -1
- package/mindsystem/references/plan-format.md +1 -1
- package/mindsystem/references/plan-risk-assessment.md +1 -2
- package/mindsystem/references/routing/gap-closure-routing.md +44 -18
- package/mindsystem/templates/debug-subagent-prompt.md +0 -5
- package/mindsystem/workflows/adhoc.md +5 -4
- package/mindsystem/workflows/compound.md +2 -2
- package/mindsystem/workflows/discuss-phase.md +1 -1
- package/mindsystem/workflows/execute-phase.md +3 -37
- package/mindsystem/workflows/execute-plan.md +1 -1
- package/mindsystem/workflows/mockup-generation.md +1 -1
- package/mindsystem/workflows/plan-phase.md +3 -139
- package/package.json +5 -2
- package/scripts/ms-tools.py +202 -0
- package/commands/ms/check-phase.md +0 -134
- package/mindsystem/workflows/diagnose-issues.md +0 -238
- package/scripts/__pycache__/ms-tools.cpython-314.pyc +0 -0
- package/scripts/__pycache__/test_ms_tools.cpython-314-pytest-9.0.2.pyc +0 -0
- package/scripts/fixtures/scan-context/.planning/ROADMAP.md +0 -16
- package/scripts/fixtures/scan-context/.planning/adhoc/20260220-fix-token-SUMMARY.md +0 -12
- package/scripts/fixtures/scan-context/.planning/adhoc/20260225-refactor-api/adhoc-01-SUMMARY.md +0 -39
- package/scripts/fixtures/scan-context/.planning/config.json +0 -3
- package/scripts/fixtures/scan-context/.planning/debug/resolved/token-bug.md +0 -11
- package/scripts/fixtures/scan-context/.planning/knowledge/auth.md +0 -11
- package/scripts/fixtures/scan-context/.planning/phases/02-infra/02-1-SUMMARY.md +0 -20
- package/scripts/fixtures/scan-context/.planning/phases/04-setup/04-1-SUMMARY.md +0 -21
- package/scripts/fixtures/scan-context/.planning/phases/05-auth/05-1-SUMMARY.md +0 -28
- package/scripts/fixtures/scan-context/.planning/todos/add-logout.md +0 -10
- package/scripts/fixtures/scan-context/.planning/todos/done/setup-db.md +0 -10
- package/scripts/fixtures/scan-context/expected-output.json +0 -271
- package/scripts/test_ms_tools.py +0 -1701
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`. Context rot stops being the bottleneck. Every prompt in the system is tested against research on how LLMs actually follow instructions, so 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,331 +19,363 @@ 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
|
-
##
|
|
28
|
+
## How it works
|
|
35
29
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
30
|
+
```
|
|
31
|
+
[ new-milestone ] Define what to build next
|
|
32
|
+
│
|
|
33
|
+
▼
|
|
34
|
+
[ create-roadmap ] Derive requirements, map to phases
|
|
35
|
+
│
|
|
36
|
+
▼
|
|
37
|
+
╔══════════════════════════════════════════════════════════════════╗
|
|
38
|
+
║ Per Phase: ║
|
|
39
|
+
║ ║
|
|
40
|
+
║ [ discuss-phase ] (optional) Lock intent, validate context ║
|
|
41
|
+
║ │ ║
|
|
42
|
+
║ ▼ ║
|
|
43
|
+
║ [ design-phase ] (optional) Generate mockups, pick path ║
|
|
44
|
+
║ │ ║
|
|
45
|
+
║ ▼ ║
|
|
46
|
+
║ [ research-phase ] (optional) External docs, code patterns ║
|
|
47
|
+
║ │ ║
|
|
48
|
+
║ ▼ ║
|
|
49
|
+
║ [ plan-phase ] Break into context-budgeted plans ║
|
|
50
|
+
║ │ ║
|
|
51
|
+
║ ▼ ║
|
|
52
|
+
║ [ execute-phase ] Fresh subagents run each plan ║
|
|
53
|
+
║ │ ║
|
|
54
|
+
║ ▼ ║
|
|
55
|
+
║ [ verify-work ] Manual acceptance tests, inline fixes ║
|
|
56
|
+
║ │ ║
|
|
57
|
+
║ └────── repeat for next phase ──────────────────────┐ ║
|
|
58
|
+
╚═════════╦═══════════════════════════════════════════════════╧════╝
|
|
59
|
+
│
|
|
60
|
+
▼
|
|
61
|
+
[ audit-milestone ] Check requirements coverage, surface tech debt
|
|
62
|
+
│
|
|
63
|
+
▼
|
|
64
|
+
[ complete-milestone ] Archive, evolve PROJECT.md, start fresh
|
|
65
|
+
```
|
|
39
66
|
|
|
40
|
-
|
|
67
|
+
Each phase gets its own preparation depth. A database migration might skip straight to planning. A user-facing feature might need discussion, design mockups, and research first. You pick the depth.
|
|
41
68
|
|
|
42
|
-
|
|
69
|
+
Execution happens in fresh subagent contexts, so each plan gets up to 200k tokens of headroom regardless of how much planning happened in the main conversation.
|
|
43
70
|
|
|
44
|
-
|
|
71
|
+
---
|
|
45
72
|
|
|
46
|
-
|
|
73
|
+
## End-to-end walkthrough
|
|
47
74
|
|
|
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.
|
|
75
|
+
### 1. New milestone
|
|
52
76
|
|
|
53
|
-
|
|
77
|
+
```
|
|
78
|
+
/ms:new-milestone
|
|
79
|
+
```
|
|
54
80
|
|
|
55
|
-
|
|
81
|
+
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.
|
|
56
82
|
|
|
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.
|
|
83
|
+
Think of it as guided brainstorming: Claude asks the right questions rather than prescribing answers, helping you figure out what to build next.
|
|
67
84
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
## Mental Model
|
|
85
|
+
### 2. Create roadmap
|
|
71
86
|
|
|
72
87
|
```
|
|
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
|
|
88
|
+
/ms:create-roadmap
|
|
80
89
|
```
|
|
81
90
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
## Installation
|
|
91
|
+
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.
|
|
85
92
|
|
|
86
|
-
|
|
87
|
-
npx mindsystem-cc
|
|
88
|
-
```
|
|
93
|
+
Requirements define what must be TRUE when you ship, not what to build. This goal-backward framing means verification checks outcomes, not task completion.
|
|
89
94
|
|
|
90
|
-
|
|
95
|
+
**Creates:** `REQUIREMENTS.md`, `ROADMAP.md`, `STATE.md`, phase directories.
|
|
91
96
|
|
|
92
|
-
|
|
97
|
+
### 3. Discuss phase (optional, recommended)
|
|
93
98
|
|
|
94
99
|
```
|
|
95
|
-
/ms:
|
|
100
|
+
/ms:discuss-phase 1
|
|
96
101
|
```
|
|
97
102
|
|
|
98
|
-
|
|
99
|
-
<summary><strong>Non-interactive install (Docker, CI, scripts)</strong></summary>
|
|
103
|
+
This is where you catch misalignment before writing any code. 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
104
|
|
|
101
|
-
|
|
102
|
-
npx mindsystem-cc --global # Install to ~/.claude/
|
|
103
|
-
npx mindsystem-cc --local # Install to ./.claude/
|
|
104
|
-
```
|
|
105
|
+
Worth taking seriously. Decisions here propagate through everything that follows.
|
|
105
106
|
|
|
106
|
-
|
|
107
|
+
**Creates:** `CONTEXT.md` with vision, essentials, and reasoning-backed decisions.
|
|
107
108
|
|
|
108
|
-
|
|
109
|
-
<summary><strong>Staying updated</strong></summary>
|
|
110
|
-
|
|
111
|
-
Inside Claude Code:
|
|
109
|
+
### 4. Design phase (optional)
|
|
112
110
|
|
|
113
111
|
```
|
|
114
|
-
/ms:
|
|
112
|
+
/ms:design-phase 1
|
|
115
113
|
```
|
|
116
114
|
|
|
117
|
-
|
|
115
|
+
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.
|
|
116
|
+
|
|
117
|
+
The output is a `DESIGN.md` with exact design tokens (hex colors, px spacing, font weights), not descriptions of what things should look like.
|
|
118
|
+
|
|
119
|
+
### 5. Research phase (optional)
|
|
118
120
|
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
+
```
|
|
122
|
+
/ms:research-phase 1
|
|
121
123
|
```
|
|
122
124
|
|
|
123
|
-
|
|
125
|
+
Three parallel agents investigate at once: 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
126
|
|
|
125
|
-
|
|
126
|
-
<summary><strong>Development installation</strong></summary>
|
|
127
|
+
You resolve library conflicts if any come up. Otherwise, this runs with minimal input.
|
|
127
128
|
|
|
128
|
-
|
|
129
|
+
### 6. Plan phase
|
|
129
130
|
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
cd mindsystem
|
|
133
|
-
node bin/install.js --local
|
|
131
|
+
```
|
|
132
|
+
/ms:plan-phase 1
|
|
134
133
|
```
|
|
135
134
|
|
|
136
|
-
|
|
135
|
+
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, roughly 90% actionable content and 10% structure.
|
|
137
136
|
|
|
138
|
-
|
|
137
|
+
Independent plans get grouped into waves for parallel execution. A risk score (0-100) flags complex plans so you can verify them before committing.
|
|
139
138
|
|
|
140
|
-
|
|
139
|
+
You approve the plan structure and can adjust granularity.
|
|
141
140
|
|
|
142
|
-
|
|
141
|
+
**Creates:** `PLAN.md` files, `EXECUTION-ORDER.md`.
|
|
143
142
|
|
|
144
|
-
|
|
143
|
+
### 7. Execute phase
|
|
145
144
|
|
|
146
|
-
|
|
145
|
+
```
|
|
146
|
+
/ms:execute-phase 1
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
Runs without intervention. 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 just that tasks got marked complete.
|
|
147
150
|
|
|
148
|
-
|
|
151
|
+
Configurable code review produces separate commits for review changes. Patch files are generated for manual inspection.
|
|
149
152
|
|
|
150
|
-
|
|
153
|
+
After execution, knowledge consolidation updates subsystem-scoped knowledge files. Future phases touching the same subsystems start with accumulated context: decisions made, patterns established, pitfalls encountered.
|
|
154
|
+
|
|
155
|
+
**Creates:** `SUMMARY.md`, `VERIFICATION.md`, `.patch` files, knowledge file updates.
|
|
156
|
+
|
|
157
|
+
### 8. Verify work
|
|
151
158
|
|
|
152
159
|
```
|
|
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
|
|
160
|
+
/ms:verify-work 1
|
|
158
161
|
```
|
|
159
162
|
|
|
160
|
-
|
|
163
|
+
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.
|
|
164
|
+
|
|
165
|
+
For hard-to-test scenarios (error states, loading screens, role-based views), mock generation creates temporary inline states without shipping test infrastructure.
|
|
161
166
|
|
|
162
|
-
|
|
163
|
-
- `.planning/REQUIREMENTS.md` — checkable scope
|
|
164
|
-
- `.planning/ROADMAP.md` + `.planning/STATE.md` — plan and project memory
|
|
167
|
+
Fixes compound into knowledge files through automatic consolidation. This is where edge cases, UI tweaks, and small bugs get caught before moving on.
|
|
165
168
|
|
|
166
|
-
**
|
|
169
|
+
**Creates:** `UAT.md`, `uat-fixes.patch`, knowledge file updates.
|
|
167
170
|
|
|
168
|
-
###
|
|
171
|
+
### 9. Repeat
|
|
169
172
|
|
|
170
|
-
|
|
173
|
+
Run steps 3-8 for each phase. Pick the preparation depth each phase needs.
|
|
171
174
|
|
|
172
|
-
|
|
175
|
+
### 10. Audit milestone
|
|
173
176
|
|
|
174
177
|
```
|
|
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
|
|
178
|
+
/ms:audit-milestone
|
|
181
179
|
```
|
|
182
180
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
- `.planning/codebase/*` — captured conventions and structure
|
|
186
|
-
- `.planning/PROJECT.md` / `.planning/REQUIREMENTS.md` / `.planning/ROADMAP.md`
|
|
181
|
+
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`.
|
|
187
182
|
|
|
188
|
-
|
|
183
|
+
Optional code review with quality-phase decisions for high-impact findings. You decide what gets fixed vs. accepted as debt.
|
|
189
184
|
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
**Run:**
|
|
185
|
+
### 11. Complete milestone
|
|
193
186
|
|
|
194
187
|
```
|
|
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>
|
|
188
|
+
/ms:complete-milestone
|
|
200
189
|
```
|
|
201
190
|
|
|
202
|
-
|
|
191
|
+
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
192
|
|
|
204
|
-
|
|
205
|
-
- `.planning/phases/<N>-*/<N>-01-PLAN.md` + `*-SUMMARY.md`
|
|
193
|
+
Updates `MILESTONES.md` with stats and accomplishments. Fresh start for the next `/ms:new-milestone`.
|
|
206
194
|
|
|
207
|
-
|
|
195
|
+
---
|
|
208
196
|
|
|
209
|
-
|
|
197
|
+
## Features
|
|
210
198
|
|
|
211
|
-
|
|
199
|
+
### Knowledge compounding
|
|
212
200
|
|
|
213
|
-
|
|
201
|
+
This is the thing that makes the whole system worth using. Subsystem-scoped knowledge files get enriched after every phase. Execute-phase consolidates implementation decisions. Verify-work compounds fixes and edge cases. `/ms:compound` catches out-of-pipeline work like direct Claude sessions, manual edits, or merged branches.
|
|
214
202
|
|
|
215
|
-
|
|
216
|
-
/ms:plan-phase <N>
|
|
217
|
-
/ms:execute-phase <N>
|
|
218
|
-
/ms:verify-work <N>
|
|
219
|
-
```
|
|
203
|
+
Phase 1 starts from scratch. Phase 10 starts with a knowledge base that knows what works, what failed, and why.
|
|
220
204
|
|
|
221
|
-
|
|
205
|
+
### Context budget management
|
|
222
206
|
|
|
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
|
|
207
|
+
Plans target 25-45% of the context window. Execution runs in fresh subagents with no inherited drift from long planning conversations. The 50% rule ensures plans complete before quality degrades.
|
|
226
208
|
|
|
227
|
-
|
|
209
|
+
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
210
|
|
|
229
|
-
|
|
211
|
+
### Research-backed prompts
|
|
230
212
|
|
|
231
|
-
|
|
213
|
+
Unnecessary instructions aren't wasted space — they interfere with the ones that matter. Each instruction passes a reliability test: does removing this degrade output in the actual runtime context? Every command, workflow, and agent definition gets audited to cut that interference. Audited agents show 35-39% context reduction with no behavioral regression.
|
|
232
214
|
|
|
233
|
-
|
|
215
|
+
### Built-in code review
|
|
234
216
|
|
|
235
|
-
|
|
217
|
+
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`.
|
|
236
218
|
|
|
237
|
-
|
|
238
|
-
/ms:debug "Describe symptoms and what you observed"
|
|
239
|
-
```
|
|
219
|
+
### Structured debugging
|
|
240
220
|
|
|
241
|
-
|
|
221
|
+
`/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/`.
|
|
242
222
|
|
|
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>`
|
|
223
|
+
### Adhoc execution
|
|
246
224
|
|
|
247
|
-
|
|
225
|
+
For work that's too coherent for a todo but too small for a full phase. `/ms:adhoc` reads existing knowledge files, generates a plan, executes, reviews, and consolidates learnings in one context. Accepts Linear ticket IDs, todo file paths, or plain descriptions.
|
|
248
226
|
|
|
249
|
-
|
|
227
|
+
### Design mockups
|
|
250
228
|
|
|
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 "..."` |
|
|
229
|
+
`/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.
|
|
257
230
|
|
|
258
|
-
###
|
|
231
|
+
### Project health
|
|
259
232
|
|
|
260
|
-
|
|
233
|
+
`/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.
|
|
261
234
|
|
|
262
|
-
|
|
235
|
+
### Smart routing
|
|
263
236
|
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
237
|
+
`/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.
|
|
238
|
+
|
|
239
|
+
### Deferred requirements
|
|
240
|
+
|
|
241
|
+
Requirements you want but haven't shipped yet are tracked in `PROJECT.md` with origin milestone and deferral reason. `complete-milestone` triages them before archiving. `create-roadmap` picks them up as candidates for new milestones. They don't get lost.
|
|
269
242
|
|
|
270
|
-
|
|
243
|
+
### Task capture
|
|
271
244
|
|
|
272
|
-
- `.planning/
|
|
273
|
-
- Active docs stay lean; full detail lives in the version folder
|
|
245
|
+
`/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
246
|
|
|
275
|
-
|
|
247
|
+
### Codebase mapping
|
|
248
|
+
|
|
249
|
+
`/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
250
|
|
|
277
251
|
---
|
|
278
252
|
|
|
279
|
-
##
|
|
253
|
+
## Quick start
|
|
280
254
|
|
|
281
|
-
|
|
255
|
+
### New project
|
|
282
256
|
|
|
283
|
-
|
|
257
|
+
```
|
|
258
|
+
/ms:new-project
|
|
259
|
+
/ms:new-milestone
|
|
260
|
+
/ms:create-roadmap
|
|
261
|
+
/ms:plan-phase 1
|
|
262
|
+
/ms:execute-phase 1
|
|
263
|
+
/ms:verify-work 1
|
|
264
|
+
```
|
|
284
265
|
|
|
285
|
-
|
|
266
|
+
You'll get `.planning/` with your project vision, milestone context, requirements, roadmap, and the first phase implemented with commits, patch files, and knowledge files.
|
|
286
267
|
|
|
287
|
-
|
|
268
|
+
### Existing project
|
|
288
269
|
|
|
289
|
-
|
|
270
|
+
```
|
|
271
|
+
/ms:new-project
|
|
272
|
+
/ms:map-codebase
|
|
273
|
+
/ms:new-milestone
|
|
274
|
+
/ms:create-roadmap
|
|
275
|
+
/ms:plan-phase 1
|
|
276
|
+
/ms:execute-phase 1
|
|
277
|
+
```
|
|
290
278
|
|
|
291
|
-
|
|
279
|
+
Codebase mapping produces 7 documents covering your stack, conventions, and architecture. Then you define what to build, and all downstream planning respects what's already there.
|
|
292
280
|
|
|
293
|
-
|
|
281
|
+
**Returning after a break?** Run `/ms:progress` to see where you left off and what to do next.
|
|
294
282
|
|
|
295
|
-
|
|
283
|
+
---
|
|
296
284
|
|
|
297
|
-
|
|
285
|
+
## Configuration
|
|
298
286
|
|
|
299
|
-
|
|
287
|
+
Mindsystem stores project config in `.planning/config.json`. Run `/ms:config` to change these interactively.
|
|
300
288
|
|
|
301
|
-
```
|
|
289
|
+
```jsonc
|
|
302
290
|
{
|
|
291
|
+
// Canonical subsystem names. Drives knowledge file scoping.
|
|
292
|
+
// Populated by /ms:new-project, refined by /ms:doctor.
|
|
293
|
+
"subsystems": ["auth", "api", "database"],
|
|
294
|
+
|
|
295
|
+
// Code review after execution. One reviewer per tier.
|
|
296
|
+
// null → falls back to "ms-code-simplifier" (default)
|
|
297
|
+
// "ms-code-reviewer" → structural: architecture and design issues
|
|
298
|
+
// "ms-code-simplifier" → clarity: readability and maintainability
|
|
299
|
+
// "skip" → explicitly disable review
|
|
300
|
+
// "<custom-agent>" → your own reviewer agent
|
|
303
301
|
"code_review": {
|
|
304
302
|
"adhoc": null,
|
|
305
303
|
"phase": null,
|
|
306
304
|
"milestone": null
|
|
305
|
+
},
|
|
306
|
+
|
|
307
|
+
// How /ms:design-phase opens the mockup comparison page.
|
|
308
|
+
// "auto" (default) | "ask" | "off"
|
|
309
|
+
"open_mockups": "auto",
|
|
310
|
+
|
|
311
|
+
// External task tracker integration (Linear only for now).
|
|
312
|
+
// null → disabled (default)
|
|
313
|
+
"task_tracker": {
|
|
314
|
+
"type": "linear",
|
|
315
|
+
"cli": "path/to/linear-cli"
|
|
307
316
|
}
|
|
308
317
|
}
|
|
309
318
|
```
|
|
310
319
|
|
|
311
|
-
|
|
320
|
+
Linear integration requires the [Linear CLI skill](https://github.com/rolandtolnay/llm-toolkit/tree/main/skills/linear). Point `task_tracker.cli` at the downloaded script.
|
|
321
|
+
|
|
322
|
+
---
|
|
312
323
|
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
|
324
|
+
## Command reference
|
|
325
|
+
|
|
326
|
+
Full docs live in `/ms:help`.
|
|
327
|
+
|
|
328
|
+
| Command | What it does |
|
|
329
|
+
| ------- | ------------ |
|
|
330
|
+
| `/ms:help` | Show the full command reference |
|
|
331
|
+
| `/ms:progress` | Show where you are and what to run next |
|
|
332
|
+
| `/ms:new-project` | Initialize `.planning/` and capture project intent |
|
|
333
|
+
| `/ms:config` | Configure code reviewers, mockups, gitignore, git remote |
|
|
334
|
+
| `/ms:map-codebase` | Document existing repo's stack, structure, and conventions |
|
|
335
|
+
| `/ms:research-project` | Domain research saved to `.planning/research/` |
|
|
336
|
+
| `/ms:create-roadmap` | Define requirements and create phases mapped to them |
|
|
337
|
+
| `/ms:new-milestone [name]` | Discover what to build next, start new milestone |
|
|
338
|
+
| `/ms:discuss-phase <number>` | Product-informed collaborative thinking before planning |
|
|
339
|
+
| `/ms:design-phase <number>` | Generate UI/UX spec and optional HTML mockups |
|
|
340
|
+
| `/ms:review-design [scope]` | Audit and improve existing UI quality |
|
|
341
|
+
| `/ms:research-phase <number>` | Deep research for niche phase domains |
|
|
342
|
+
| `/ms:plan-phase [number]` | Create context-budgeted plans with optional risk scoring |
|
|
343
|
+
| `/ms:execute-phase <number>` | Run all unexecuted plans in fresh subagents |
|
|
344
|
+
| `/ms:verify-work [number]` | Batched manual UAT with inline fixes |
|
|
345
|
+
| `/ms:debug [description]` | Structured debugging that survives `/clear` |
|
|
346
|
+
| `/ms:adhoc <description>` | Knowledge-aware execution for discovered work |
|
|
347
|
+
| `/ms:compound [input]` | Compound out-of-pipeline changes into knowledge files |
|
|
348
|
+
| `/ms:add-phase <description>` | Append a new phase to the roadmap |
|
|
349
|
+
| `/ms:insert-phase <after> <description>` | Insert urgent work between phases |
|
|
350
|
+
| `/ms:remove-phase <number>` | Delete a future phase and renumber |
|
|
351
|
+
| `/ms:add-todo [description]` | Capture a task with priority, estimate, subsystem |
|
|
352
|
+
| `/ms:audit-milestone [name]` | Audit completion and surface gaps |
|
|
353
|
+
| `/ms:complete-milestone [name]` | Archive milestone and prepare for next |
|
|
354
|
+
| `/ms:doctor` | Health check and fix project configuration |
|
|
355
|
+
| `/ms:update` | Check for and install latest version |
|
|
356
|
+
| `/ms:release-notes` | Show full release notes with update status |
|
|
318
357
|
|
|
319
358
|
---
|
|
320
359
|
|
|
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 |
|
|
360
|
+
## Updating
|
|
361
|
+
|
|
362
|
+
Inside Claude Code:
|
|
363
|
+
|
|
364
|
+
```
|
|
365
|
+
/ms:update
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
Check what changed:
|
|
369
|
+
|
|
370
|
+
```
|
|
371
|
+
/ms:release-notes
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
From your terminal:
|
|
375
|
+
|
|
376
|
+
```bash
|
|
377
|
+
npx mindsystem-cc@latest
|
|
378
|
+
```
|
|
353
379
|
|
|
354
380
|
---
|
|
355
381
|
|
|
@@ -365,6 +391,10 @@ Full docs live in `/ms:help` (same content as `commands/ms/help.md`).
|
|
|
365
391
|
- Run `/ms:help` to verify installation.
|
|
366
392
|
- Re-run `npx mindsystem-cc` to reinstall.
|
|
367
393
|
|
|
394
|
+
**Outdated project structure after a major update?**
|
|
395
|
+
|
|
396
|
+
- Run `/ms:doctor` to detect and fix stale artifacts, missing config fields, and directory structure changes between versions.
|
|
397
|
+
|
|
368
398
|
**Updating to the latest version?**
|
|
369
399
|
|
|
370
400
|
```bash
|
|
@@ -379,8 +409,4 @@ MIT License. See [LICENSE](LICENSE) for details.
|
|
|
379
409
|
|
|
380
410
|
---
|
|
381
411
|
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
**Claude Code is powerful. Mindsystem makes it reliable.**
|
|
385
|
-
|
|
386
|
-
</div>
|
|
412
|
+
Inspired by [GSD](https://github.com/gsd-build/get-shit-done) and [Compound Engineering](https://github.com/EveryInc/compound-engineering-plugin).
|