gsd-codex-cli 1.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.codex/prompts/gsd-add-phase.md +44 -0
- package/.codex/prompts/gsd-add-todo.md +43 -0
- package/.codex/prompts/gsd-audit-milestone.md +43 -0
- package/.codex/prompts/gsd-check-todos.md +43 -0
- package/.codex/prompts/gsd-complete-milestone.md +43 -0
- package/.codex/prompts/gsd-debug.md +46 -0
- package/.codex/prompts/gsd-discuss-phase.md +43 -0
- package/.codex/prompts/gsd-execute-phase.md +43 -0
- package/.codex/prompts/gsd-help.md +43 -0
- package/.codex/prompts/gsd-insert-phase.md +43 -0
- package/.codex/prompts/gsd-list-phase-assumptions.md +43 -0
- package/.codex/prompts/gsd-map-codebase.md +43 -0
- package/.codex/prompts/gsd-new-milestone.md +43 -0
- package/.codex/prompts/gsd-new-project.md +43 -0
- package/.codex/prompts/gsd-pause-work.md +43 -0
- package/.codex/prompts/gsd-plan-milestone-gaps.md +43 -0
- package/.codex/prompts/gsd-plan-phase.md +43 -0
- package/.codex/prompts/gsd-progress.md +43 -0
- package/.codex/prompts/gsd-quick.md +43 -0
- package/.codex/prompts/gsd-remove-phase.md +43 -0
- package/.codex/prompts/gsd-research-phase.md +43 -0
- package/.codex/prompts/gsd-resume-work.md +43 -0
- package/.codex/prompts/gsd-set-profile.md +43 -0
- package/.codex/prompts/gsd-settings.md +43 -0
- package/.codex/prompts/gsd-update.md +43 -0
- package/.codex/prompts/gsd-verify-work.md +43 -0
- package/.codex/skills/get-shit-done-codex/SKILL.md +65 -0
- package/.codex/skills/get-shit-done-codex/references/compat.md +32 -0
- package/.codex/skills/get-shit-done-codex/references/windows.md +23 -0
- package/CHANGELOG.md +1434 -0
- package/LICENSE +21 -0
- package/README.md +690 -0
- package/agents/gsd-codebase-mapper.md +761 -0
- package/agents/gsd-debugger.md +1198 -0
- package/agents/gsd-executor.md +419 -0
- package/agents/gsd-integration-checker.md +423 -0
- package/agents/gsd-phase-researcher.md +469 -0
- package/agents/gsd-plan-checker.md +622 -0
- package/agents/gsd-planner.md +1159 -0
- package/agents/gsd-project-researcher.md +618 -0
- package/agents/gsd-research-synthesizer.md +236 -0
- package/agents/gsd-roadmapper.md +639 -0
- package/agents/gsd-verifier.md +541 -0
- package/bin/install-codex.js +100 -0
- package/bin/install.js +1806 -0
- package/commands/gsd/add-phase.md +39 -0
- package/commands/gsd/add-todo.md +42 -0
- package/commands/gsd/audit-milestone.md +42 -0
- package/commands/gsd/check-todos.md +41 -0
- package/commands/gsd/cleanup.md +18 -0
- package/commands/gsd/complete-milestone.md +136 -0
- package/commands/gsd/debug.md +162 -0
- package/commands/gsd/discuss-phase.md +87 -0
- package/commands/gsd/execute-phase.md +42 -0
- package/commands/gsd/health.md +22 -0
- package/commands/gsd/help.md +22 -0
- package/commands/gsd/insert-phase.md +33 -0
- package/commands/gsd/join-discord.md +18 -0
- package/commands/gsd/list-phase-assumptions.md +50 -0
- package/commands/gsd/map-codebase.md +71 -0
- package/commands/gsd/new-milestone.md +51 -0
- package/commands/gsd/new-project.md +42 -0
- package/commands/gsd/pause-work.md +35 -0
- package/commands/gsd/plan-milestone-gaps.md +40 -0
- package/commands/gsd/plan-phase.md +44 -0
- package/commands/gsd/progress.md +24 -0
- package/commands/gsd/quick.md +40 -0
- package/commands/gsd/reapply-patches.md +110 -0
- package/commands/gsd/remove-phase.md +32 -0
- package/commands/gsd/research-phase.md +187 -0
- package/commands/gsd/resume-work.md +40 -0
- package/commands/gsd/set-profile.md +34 -0
- package/commands/gsd/settings.md +36 -0
- package/commands/gsd/update.md +37 -0
- package/commands/gsd/verify-work.md +39 -0
- package/get-shit-done/bin/gsd-tools.cjs +5243 -0
- package/get-shit-done/bin/gsd-tools.test.cjs +2273 -0
- package/get-shit-done/references/checkpoints.md +775 -0
- package/get-shit-done/references/continuation-format.md +249 -0
- package/get-shit-done/references/decimal-phase-calculation.md +65 -0
- package/get-shit-done/references/git-integration.md +248 -0
- package/get-shit-done/references/git-planning-commit.md +38 -0
- package/get-shit-done/references/model-profile-resolution.md +34 -0
- package/get-shit-done/references/model-profiles.md +92 -0
- package/get-shit-done/references/phase-argument-parsing.md +61 -0
- package/get-shit-done/references/planning-config.md +196 -0
- package/get-shit-done/references/questioning.md +145 -0
- package/get-shit-done/references/tdd.md +263 -0
- package/get-shit-done/references/ui-brand.md +160 -0
- package/get-shit-done/references/verification-patterns.md +612 -0
- package/get-shit-done/templates/DEBUG.md +159 -0
- package/get-shit-done/templates/UAT.md +247 -0
- package/get-shit-done/templates/codebase/architecture.md +255 -0
- package/get-shit-done/templates/codebase/concerns.md +310 -0
- package/get-shit-done/templates/codebase/conventions.md +307 -0
- package/get-shit-done/templates/codebase/integrations.md +280 -0
- package/get-shit-done/templates/codebase/stack.md +186 -0
- package/get-shit-done/templates/codebase/structure.md +285 -0
- package/get-shit-done/templates/codebase/testing.md +480 -0
- package/get-shit-done/templates/config.json +36 -0
- package/get-shit-done/templates/context.md +283 -0
- package/get-shit-done/templates/continue-here.md +78 -0
- package/get-shit-done/templates/debug-subagent-prompt.md +91 -0
- package/get-shit-done/templates/discovery.md +146 -0
- package/get-shit-done/templates/milestone-archive.md +123 -0
- package/get-shit-done/templates/milestone.md +115 -0
- package/get-shit-done/templates/phase-prompt.md +567 -0
- package/get-shit-done/templates/planner-subagent-prompt.md +117 -0
- package/get-shit-done/templates/project.md +184 -0
- package/get-shit-done/templates/requirements.md +231 -0
- package/get-shit-done/templates/research-project/ARCHITECTURE.md +204 -0
- package/get-shit-done/templates/research-project/FEATURES.md +147 -0
- package/get-shit-done/templates/research-project/PITFALLS.md +200 -0
- package/get-shit-done/templates/research-project/STACK.md +120 -0
- package/get-shit-done/templates/research-project/SUMMARY.md +170 -0
- package/get-shit-done/templates/research.md +552 -0
- package/get-shit-done/templates/roadmap.md +202 -0
- package/get-shit-done/templates/state.md +176 -0
- package/get-shit-done/templates/summary-complex.md +59 -0
- package/get-shit-done/templates/summary-minimal.md +41 -0
- package/get-shit-done/templates/summary-standard.md +48 -0
- package/get-shit-done/templates/summary.md +246 -0
- package/get-shit-done/templates/user-setup.md +311 -0
- package/get-shit-done/templates/verification-report.md +322 -0
- package/get-shit-done/workflows/add-phase.md +111 -0
- package/get-shit-done/workflows/add-todo.md +157 -0
- package/get-shit-done/workflows/audit-milestone.md +242 -0
- package/get-shit-done/workflows/check-todos.md +176 -0
- package/get-shit-done/workflows/cleanup.md +152 -0
- package/get-shit-done/workflows/complete-milestone.md +674 -0
- package/get-shit-done/workflows/diagnose-issues.md +219 -0
- package/get-shit-done/workflows/discovery-phase.md +289 -0
- package/get-shit-done/workflows/discuss-phase.md +485 -0
- package/get-shit-done/workflows/execute-phase.md +408 -0
- package/get-shit-done/workflows/execute-plan.md +441 -0
- package/get-shit-done/workflows/health.md +156 -0
- package/get-shit-done/workflows/help.md +486 -0
- package/get-shit-done/workflows/insert-phase.md +129 -0
- package/get-shit-done/workflows/list-phase-assumptions.md +178 -0
- package/get-shit-done/workflows/map-codebase.md +327 -0
- package/get-shit-done/workflows/new-milestone.md +373 -0
- package/get-shit-done/workflows/new-project.md +1113 -0
- package/get-shit-done/workflows/pause-work.md +122 -0
- package/get-shit-done/workflows/plan-milestone-gaps.md +256 -0
- package/get-shit-done/workflows/plan-phase.md +448 -0
- package/get-shit-done/workflows/progress.md +393 -0
- package/get-shit-done/workflows/quick.md +444 -0
- package/get-shit-done/workflows/remove-phase.md +154 -0
- package/get-shit-done/workflows/research-phase.md +74 -0
- package/get-shit-done/workflows/resume-project.md +306 -0
- package/get-shit-done/workflows/set-profile.md +80 -0
- package/get-shit-done/workflows/settings.md +200 -0
- package/get-shit-done/workflows/transition.md +539 -0
- package/get-shit-done/workflows/update.md +214 -0
- package/get-shit-done/workflows/verify-phase.md +242 -0
- package/get-shit-done/workflows/verify-work.md +570 -0
- package/hooks/dist/gsd-check-update.js +62 -0
- package/hooks/dist/gsd-statusline.js +91 -0
- package/package.json +54 -0
- package/scripts/build-hooks.js +42 -0
|
@@ -0,0 +1,1113 @@
|
|
|
1
|
+
<purpose>
|
|
2
|
+
Initialize a new project through unified flow: questioning, research (optional), requirements, roadmap. This is the most leveraged moment in any project — deep questioning here means better plans, better execution, better outcomes. One workflow takes you from idea to ready-for-planning.
|
|
3
|
+
</purpose>
|
|
4
|
+
|
|
5
|
+
<required_reading>
|
|
6
|
+
Read all files referenced by the invoking prompt's execution_context before starting.
|
|
7
|
+
</required_reading>
|
|
8
|
+
|
|
9
|
+
<auto_mode>
|
|
10
|
+
## Auto Mode Detection
|
|
11
|
+
|
|
12
|
+
Check if `--auto` flag is present in $ARGUMENTS.
|
|
13
|
+
|
|
14
|
+
**If auto mode:**
|
|
15
|
+
- Skip brownfield mapping offer (assume greenfield)
|
|
16
|
+
- Skip deep questioning (extract context from provided document)
|
|
17
|
+
- Config: YOLO mode is implicit (skip that question), but ask depth/git/agents FIRST (Step 2a)
|
|
18
|
+
- After config: run Steps 6-9 automatically with smart defaults:
|
|
19
|
+
- Research: Always yes
|
|
20
|
+
- Requirements: Include all table stakes + features from provided document
|
|
21
|
+
- Requirements approval: Auto-approve
|
|
22
|
+
- Roadmap approval: Auto-approve
|
|
23
|
+
|
|
24
|
+
**Document requirement:**
|
|
25
|
+
Auto mode requires an idea document — either:
|
|
26
|
+
- File reference: `/gsd:new-project --auto @prd.md`
|
|
27
|
+
- Pasted/written text in the prompt
|
|
28
|
+
|
|
29
|
+
If no document content provided, error:
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
Error: --auto requires an idea document.
|
|
33
|
+
|
|
34
|
+
Usage:
|
|
35
|
+
/gsd:new-project --auto @your-idea.md
|
|
36
|
+
/gsd:new-project --auto [paste or write your idea here]
|
|
37
|
+
|
|
38
|
+
The document should describe what you want to build.
|
|
39
|
+
```
|
|
40
|
+
</auto_mode>
|
|
41
|
+
|
|
42
|
+
<process>
|
|
43
|
+
|
|
44
|
+
## 1. Setup
|
|
45
|
+
|
|
46
|
+
**MANDATORY FIRST STEP — Execute these checks before ANY user interaction:**
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
INIT=$(node ~/.claude/get-shit-done/bin/gsd-tools.cjs init new-project)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Parse JSON for: `researcher_model`, `synthesizer_model`, `roadmapper_model`, `commit_docs`, `project_exists`, `has_codebase_map`, `planning_exists`, `has_existing_code`, `has_package_file`, `is_brownfield`, `needs_codebase_map`, `has_git`.
|
|
53
|
+
|
|
54
|
+
**If `project_exists` is true:** Error — project already initialized. Use `/gsd:progress`.
|
|
55
|
+
|
|
56
|
+
**If `has_git` is false:** Initialize git:
|
|
57
|
+
```bash
|
|
58
|
+
git init
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## 2. Brownfield Offer
|
|
62
|
+
|
|
63
|
+
**If auto mode:** Skip to Step 4 (assume greenfield, synthesize PROJECT.md from provided document).
|
|
64
|
+
|
|
65
|
+
**If `needs_codebase_map` is true** (from init — existing code detected but no codebase map):
|
|
66
|
+
|
|
67
|
+
Use AskUserQuestion:
|
|
68
|
+
- header: "Codebase"
|
|
69
|
+
- question: "I detected existing code in this directory. Would you like to map the codebase first?"
|
|
70
|
+
- options:
|
|
71
|
+
- "Map codebase first" — Run /gsd:map-codebase to understand existing architecture (Recommended)
|
|
72
|
+
- "Skip mapping" — Proceed with project initialization
|
|
73
|
+
|
|
74
|
+
**If "Map codebase first":**
|
|
75
|
+
```
|
|
76
|
+
Run `/gsd:map-codebase` first, then return to `/gsd:new-project`
|
|
77
|
+
```
|
|
78
|
+
Exit command.
|
|
79
|
+
|
|
80
|
+
**If "Skip mapping" OR `needs_codebase_map` is false:** Continue to Step 3.
|
|
81
|
+
|
|
82
|
+
## 2a. Auto Mode Config (auto mode only)
|
|
83
|
+
|
|
84
|
+
**If auto mode:** Collect config settings upfront before processing the idea document.
|
|
85
|
+
|
|
86
|
+
YOLO mode is implicit (auto = YOLO). Ask remaining config questions:
|
|
87
|
+
|
|
88
|
+
**Round 1 — Core settings (3 questions, no Mode question):**
|
|
89
|
+
|
|
90
|
+
```
|
|
91
|
+
AskUserQuestion([
|
|
92
|
+
{
|
|
93
|
+
header: "Depth",
|
|
94
|
+
question: "How thorough should planning be?",
|
|
95
|
+
multiSelect: false,
|
|
96
|
+
options: [
|
|
97
|
+
{ label: "Quick (Recommended)", description: "Ship fast (3-5 phases, 1-3 plans each)" },
|
|
98
|
+
{ label: "Standard", description: "Balanced scope and speed (5-8 phases, 3-5 plans each)" },
|
|
99
|
+
{ label: "Comprehensive", description: "Thorough coverage (8-12 phases, 5-10 plans each)" }
|
|
100
|
+
]
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
header: "Execution",
|
|
104
|
+
question: "Run plans in parallel?",
|
|
105
|
+
multiSelect: false,
|
|
106
|
+
options: [
|
|
107
|
+
{ label: "Parallel (Recommended)", description: "Independent plans run simultaneously" },
|
|
108
|
+
{ label: "Sequential", description: "One plan at a time" }
|
|
109
|
+
]
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
header: "Git Tracking",
|
|
113
|
+
question: "Commit planning docs to git?",
|
|
114
|
+
multiSelect: false,
|
|
115
|
+
options: [
|
|
116
|
+
{ label: "Yes (Recommended)", description: "Planning docs tracked in version control" },
|
|
117
|
+
{ label: "No", description: "Keep .planning/ local-only (add to .gitignore)" }
|
|
118
|
+
]
|
|
119
|
+
}
|
|
120
|
+
])
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
**Round 2 — Workflow agents (same as Step 5):**
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
AskUserQuestion([
|
|
127
|
+
{
|
|
128
|
+
header: "Research",
|
|
129
|
+
question: "Research before planning each phase? (adds tokens/time)",
|
|
130
|
+
multiSelect: false,
|
|
131
|
+
options: [
|
|
132
|
+
{ label: "Yes (Recommended)", description: "Investigate domain, find patterns, surface gotchas" },
|
|
133
|
+
{ label: "No", description: "Plan directly from requirements" }
|
|
134
|
+
]
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
header: "Plan Check",
|
|
138
|
+
question: "Verify plans will achieve their goals? (adds tokens/time)",
|
|
139
|
+
multiSelect: false,
|
|
140
|
+
options: [
|
|
141
|
+
{ label: "Yes (Recommended)", description: "Catch gaps before execution starts" },
|
|
142
|
+
{ label: "No", description: "Execute plans without verification" }
|
|
143
|
+
]
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
header: "Verifier",
|
|
147
|
+
question: "Verify work satisfies requirements after each phase? (adds tokens/time)",
|
|
148
|
+
multiSelect: false,
|
|
149
|
+
options: [
|
|
150
|
+
{ label: "Yes (Recommended)", description: "Confirm deliverables match phase goals" },
|
|
151
|
+
{ label: "No", description: "Trust execution, skip verification" }
|
|
152
|
+
]
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
header: "AI Models",
|
|
156
|
+
question: "Which AI models for planning agents?",
|
|
157
|
+
multiSelect: false,
|
|
158
|
+
options: [
|
|
159
|
+
{ label: "Balanced (Recommended)", description: "Sonnet for most agents — good quality/cost ratio" },
|
|
160
|
+
{ label: "Quality", description: "Opus for research/roadmap — higher cost, deeper analysis" },
|
|
161
|
+
{ label: "Budget", description: "Haiku where possible — fastest, lowest cost" }
|
|
162
|
+
]
|
|
163
|
+
}
|
|
164
|
+
])
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
Create `.planning/config.json` with mode set to "yolo":
|
|
168
|
+
|
|
169
|
+
```json
|
|
170
|
+
{
|
|
171
|
+
"mode": "yolo",
|
|
172
|
+
"depth": "[selected]",
|
|
173
|
+
"parallelization": true|false,
|
|
174
|
+
"commit_docs": true|false,
|
|
175
|
+
"model_profile": "quality|balanced|budget",
|
|
176
|
+
"workflow": {
|
|
177
|
+
"research": true|false,
|
|
178
|
+
"plan_check": true|false,
|
|
179
|
+
"verifier": true|false
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
**If commit_docs = No:** Add `.planning/` to `.gitignore`.
|
|
185
|
+
|
|
186
|
+
**Commit config.json:**
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
mkdir -p .planning
|
|
190
|
+
node ~/.claude/get-shit-done/bin/gsd-tools.cjs commit "chore: add project config" --files .planning/config.json
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
Proceed to Step 4 (skip Steps 3 and 5).
|
|
194
|
+
|
|
195
|
+
## 3. Deep Questioning
|
|
196
|
+
|
|
197
|
+
**If auto mode:** Skip (already handled in Step 2a). Extract project context from provided document instead and proceed to Step 4.
|
|
198
|
+
|
|
199
|
+
**Display stage banner:**
|
|
200
|
+
|
|
201
|
+
```
|
|
202
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
203
|
+
GSD ► QUESTIONING
|
|
204
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
**Open the conversation:**
|
|
208
|
+
|
|
209
|
+
Ask inline (freeform, NOT AskUserQuestion):
|
|
210
|
+
|
|
211
|
+
"What do you want to build?"
|
|
212
|
+
|
|
213
|
+
Wait for their response. This gives you the context needed to ask intelligent follow-up questions.
|
|
214
|
+
|
|
215
|
+
**Follow the thread:**
|
|
216
|
+
|
|
217
|
+
Based on what they said, ask follow-up questions that dig into their response. Use AskUserQuestion with options that probe what they mentioned — interpretations, clarifications, concrete examples.
|
|
218
|
+
|
|
219
|
+
Keep following threads. Each answer opens new threads to explore. Ask about:
|
|
220
|
+
- What excited them
|
|
221
|
+
- What problem sparked this
|
|
222
|
+
- What they mean by vague terms
|
|
223
|
+
- What it would actually look like
|
|
224
|
+
- What's already decided
|
|
225
|
+
|
|
226
|
+
Consult `questioning.md` for techniques:
|
|
227
|
+
- Challenge vagueness
|
|
228
|
+
- Make abstract concrete
|
|
229
|
+
- Surface assumptions
|
|
230
|
+
- Find edges
|
|
231
|
+
- Reveal motivation
|
|
232
|
+
|
|
233
|
+
**Check context (background, not out loud):**
|
|
234
|
+
|
|
235
|
+
As you go, mentally check the context checklist from `questioning.md`. If gaps remain, weave questions naturally. Don't suddenly switch to checklist mode.
|
|
236
|
+
|
|
237
|
+
**Decision gate:**
|
|
238
|
+
|
|
239
|
+
When you could write a clear PROJECT.md, use AskUserQuestion:
|
|
240
|
+
|
|
241
|
+
- header: "Ready?"
|
|
242
|
+
- question: "I think I understand what you're after. Ready to create PROJECT.md?"
|
|
243
|
+
- options:
|
|
244
|
+
- "Create PROJECT.md" — Let's move forward
|
|
245
|
+
- "Keep exploring" — I want to share more / ask me more
|
|
246
|
+
|
|
247
|
+
If "Keep exploring" — ask what they want to add, or identify gaps and probe naturally.
|
|
248
|
+
|
|
249
|
+
Loop until "Create PROJECT.md" selected.
|
|
250
|
+
|
|
251
|
+
## 4. Write PROJECT.md
|
|
252
|
+
|
|
253
|
+
**If auto mode:** Synthesize from provided document. No "Ready?" gate was shown — proceed directly to commit.
|
|
254
|
+
|
|
255
|
+
Synthesize all context into `.planning/PROJECT.md` using the template from `templates/project.md`.
|
|
256
|
+
|
|
257
|
+
**For greenfield projects:**
|
|
258
|
+
|
|
259
|
+
Initialize requirements as hypotheses:
|
|
260
|
+
|
|
261
|
+
```markdown
|
|
262
|
+
## Requirements
|
|
263
|
+
|
|
264
|
+
### Validated
|
|
265
|
+
|
|
266
|
+
(None yet — ship to validate)
|
|
267
|
+
|
|
268
|
+
### Active
|
|
269
|
+
|
|
270
|
+
- [ ] [Requirement 1]
|
|
271
|
+
- [ ] [Requirement 2]
|
|
272
|
+
- [ ] [Requirement 3]
|
|
273
|
+
|
|
274
|
+
### Out of Scope
|
|
275
|
+
|
|
276
|
+
- [Exclusion 1] — [why]
|
|
277
|
+
- [Exclusion 2] — [why]
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
All Active requirements are hypotheses until shipped and validated.
|
|
281
|
+
|
|
282
|
+
**For brownfield projects (codebase map exists):**
|
|
283
|
+
|
|
284
|
+
Infer Validated requirements from existing code:
|
|
285
|
+
|
|
286
|
+
1. Read `.planning/codebase/ARCHITECTURE.md` and `STACK.md`
|
|
287
|
+
2. Identify what the codebase already does
|
|
288
|
+
3. These become the initial Validated set
|
|
289
|
+
|
|
290
|
+
```markdown
|
|
291
|
+
## Requirements
|
|
292
|
+
|
|
293
|
+
### Validated
|
|
294
|
+
|
|
295
|
+
- ✓ [Existing capability 1] — existing
|
|
296
|
+
- ✓ [Existing capability 2] — existing
|
|
297
|
+
- ✓ [Existing capability 3] — existing
|
|
298
|
+
|
|
299
|
+
### Active
|
|
300
|
+
|
|
301
|
+
- [ ] [New requirement 1]
|
|
302
|
+
- [ ] [New requirement 2]
|
|
303
|
+
|
|
304
|
+
### Out of Scope
|
|
305
|
+
|
|
306
|
+
- [Exclusion 1] — [why]
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
**Key Decisions:**
|
|
310
|
+
|
|
311
|
+
Initialize with any decisions made during questioning:
|
|
312
|
+
|
|
313
|
+
```markdown
|
|
314
|
+
## Key Decisions
|
|
315
|
+
|
|
316
|
+
| Decision | Rationale | Outcome |
|
|
317
|
+
|----------|-----------|---------|
|
|
318
|
+
| [Choice from questioning] | [Why] | — Pending |
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
**Last updated footer:**
|
|
322
|
+
|
|
323
|
+
```markdown
|
|
324
|
+
---
|
|
325
|
+
*Last updated: [date] after initialization*
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
Do not compress. Capture everything gathered.
|
|
329
|
+
|
|
330
|
+
**Commit PROJECT.md:**
|
|
331
|
+
|
|
332
|
+
```bash
|
|
333
|
+
mkdir -p .planning
|
|
334
|
+
node ~/.claude/get-shit-done/bin/gsd-tools.cjs commit "docs: initialize project" --files .planning/PROJECT.md
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
## 5. Workflow Preferences
|
|
338
|
+
|
|
339
|
+
**If auto mode:** Skip — config was collected in Step 2a. Proceed to Step 5.5.
|
|
340
|
+
|
|
341
|
+
**Check for global defaults** at `~/.gsd/defaults.json`. If the file exists, offer to use saved defaults:
|
|
342
|
+
|
|
343
|
+
```
|
|
344
|
+
AskUserQuestion([
|
|
345
|
+
{
|
|
346
|
+
question: "Use your saved default settings? (from ~/.gsd/defaults.json)",
|
|
347
|
+
header: "Defaults",
|
|
348
|
+
multiSelect: false,
|
|
349
|
+
options: [
|
|
350
|
+
{ label: "Yes (Recommended)", description: "Use saved defaults, skip settings questions" },
|
|
351
|
+
{ label: "No", description: "Configure settings manually" }
|
|
352
|
+
]
|
|
353
|
+
}
|
|
354
|
+
])
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
If "Yes": read `~/.gsd/defaults.json`, use those values for config.json, and skip directly to **Commit config.json** below.
|
|
358
|
+
|
|
359
|
+
If "No" or `~/.gsd/defaults.json` doesn't exist: proceed with the questions below.
|
|
360
|
+
|
|
361
|
+
**Round 1 — Core workflow settings (4 questions):**
|
|
362
|
+
|
|
363
|
+
```
|
|
364
|
+
questions: [
|
|
365
|
+
{
|
|
366
|
+
header: "Mode",
|
|
367
|
+
question: "How do you want to work?",
|
|
368
|
+
multiSelect: false,
|
|
369
|
+
options: [
|
|
370
|
+
{ label: "YOLO (Recommended)", description: "Auto-approve, just execute" },
|
|
371
|
+
{ label: "Interactive", description: "Confirm at each step" }
|
|
372
|
+
]
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
header: "Depth",
|
|
376
|
+
question: "How thorough should planning be?",
|
|
377
|
+
multiSelect: false,
|
|
378
|
+
options: [
|
|
379
|
+
{ label: "Quick", description: "Ship fast (3-5 phases, 1-3 plans each)" },
|
|
380
|
+
{ label: "Standard", description: "Balanced scope and speed (5-8 phases, 3-5 plans each)" },
|
|
381
|
+
{ label: "Comprehensive", description: "Thorough coverage (8-12 phases, 5-10 plans each)" }
|
|
382
|
+
]
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
header: "Execution",
|
|
386
|
+
question: "Run plans in parallel?",
|
|
387
|
+
multiSelect: false,
|
|
388
|
+
options: [
|
|
389
|
+
{ label: "Parallel (Recommended)", description: "Independent plans run simultaneously" },
|
|
390
|
+
{ label: "Sequential", description: "One plan at a time" }
|
|
391
|
+
]
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
header: "Git Tracking",
|
|
395
|
+
question: "Commit planning docs to git?",
|
|
396
|
+
multiSelect: false,
|
|
397
|
+
options: [
|
|
398
|
+
{ label: "Yes (Recommended)", description: "Planning docs tracked in version control" },
|
|
399
|
+
{ label: "No", description: "Keep .planning/ local-only (add to .gitignore)" }
|
|
400
|
+
]
|
|
401
|
+
}
|
|
402
|
+
]
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
**Round 2 — Workflow agents:**
|
|
406
|
+
|
|
407
|
+
These spawn additional agents during planning/execution. They add tokens and time but improve quality.
|
|
408
|
+
|
|
409
|
+
| Agent | When it runs | What it does |
|
|
410
|
+
|-------|--------------|--------------|
|
|
411
|
+
| **Researcher** | Before planning each phase | Investigates domain, finds patterns, surfaces gotchas |
|
|
412
|
+
| **Plan Checker** | After plan is created | Verifies plan actually achieves the phase goal |
|
|
413
|
+
| **Verifier** | After phase execution | Confirms must-haves were delivered |
|
|
414
|
+
|
|
415
|
+
All recommended for important projects. Skip for quick experiments.
|
|
416
|
+
|
|
417
|
+
```
|
|
418
|
+
questions: [
|
|
419
|
+
{
|
|
420
|
+
header: "Research",
|
|
421
|
+
question: "Research before planning each phase? (adds tokens/time)",
|
|
422
|
+
multiSelect: false,
|
|
423
|
+
options: [
|
|
424
|
+
{ label: "Yes (Recommended)", description: "Investigate domain, find patterns, surface gotchas" },
|
|
425
|
+
{ label: "No", description: "Plan directly from requirements" }
|
|
426
|
+
]
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
header: "Plan Check",
|
|
430
|
+
question: "Verify plans will achieve their goals? (adds tokens/time)",
|
|
431
|
+
multiSelect: false,
|
|
432
|
+
options: [
|
|
433
|
+
{ label: "Yes (Recommended)", description: "Catch gaps before execution starts" },
|
|
434
|
+
{ label: "No", description: "Execute plans without verification" }
|
|
435
|
+
]
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
header: "Verifier",
|
|
439
|
+
question: "Verify work satisfies requirements after each phase? (adds tokens/time)",
|
|
440
|
+
multiSelect: false,
|
|
441
|
+
options: [
|
|
442
|
+
{ label: "Yes (Recommended)", description: "Confirm deliverables match phase goals" },
|
|
443
|
+
{ label: "No", description: "Trust execution, skip verification" }
|
|
444
|
+
]
|
|
445
|
+
},
|
|
446
|
+
{
|
|
447
|
+
header: "AI Models",
|
|
448
|
+
question: "Which AI models for planning agents?",
|
|
449
|
+
multiSelect: false,
|
|
450
|
+
options: [
|
|
451
|
+
{ label: "Balanced (Recommended)", description: "Sonnet for most agents — good quality/cost ratio" },
|
|
452
|
+
{ label: "Quality", description: "Opus for research/roadmap — higher cost, deeper analysis" },
|
|
453
|
+
{ label: "Budget", description: "Haiku where possible — fastest, lowest cost" }
|
|
454
|
+
]
|
|
455
|
+
}
|
|
456
|
+
]
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
Create `.planning/config.json` with all settings:
|
|
460
|
+
|
|
461
|
+
```json
|
|
462
|
+
{
|
|
463
|
+
"mode": "yolo|interactive",
|
|
464
|
+
"depth": "quick|standard|comprehensive",
|
|
465
|
+
"parallelization": true|false,
|
|
466
|
+
"commit_docs": true|false,
|
|
467
|
+
"model_profile": "quality|balanced|budget",
|
|
468
|
+
"workflow": {
|
|
469
|
+
"research": true|false,
|
|
470
|
+
"plan_check": true|false,
|
|
471
|
+
"verifier": true|false
|
|
472
|
+
}
|
|
473
|
+
}
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
**If commit_docs = No:**
|
|
477
|
+
- Set `commit_docs: false` in config.json
|
|
478
|
+
- Add `.planning/` to `.gitignore` (create if needed)
|
|
479
|
+
|
|
480
|
+
**If commit_docs = Yes:**
|
|
481
|
+
- No additional gitignore entries needed
|
|
482
|
+
|
|
483
|
+
**Commit config.json:**
|
|
484
|
+
|
|
485
|
+
```bash
|
|
486
|
+
node ~/.claude/get-shit-done/bin/gsd-tools.cjs commit "chore: add project config" --files .planning/config.json
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
**Note:** Run `/gsd:settings` anytime to update these preferences.
|
|
490
|
+
|
|
491
|
+
## 5.5. Resolve Model Profile
|
|
492
|
+
|
|
493
|
+
Use models from init: `researcher_model`, `synthesizer_model`, `roadmapper_model`.
|
|
494
|
+
|
|
495
|
+
## 6. Research Decision
|
|
496
|
+
|
|
497
|
+
**If auto mode:** Default to "Research first" without asking.
|
|
498
|
+
|
|
499
|
+
Use AskUserQuestion:
|
|
500
|
+
- header: "Research"
|
|
501
|
+
- question: "Research the domain ecosystem before defining requirements?"
|
|
502
|
+
- options:
|
|
503
|
+
- "Research first (Recommended)" — Discover standard stacks, expected features, architecture patterns
|
|
504
|
+
- "Skip research" — I know this domain well, go straight to requirements
|
|
505
|
+
|
|
506
|
+
**If "Research first":**
|
|
507
|
+
|
|
508
|
+
Display stage banner:
|
|
509
|
+
```
|
|
510
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
511
|
+
GSD ► RESEARCHING
|
|
512
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
513
|
+
|
|
514
|
+
Researching [domain] ecosystem...
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
Create research directory:
|
|
518
|
+
```bash
|
|
519
|
+
mkdir -p .planning/research
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
**Determine milestone context:**
|
|
523
|
+
|
|
524
|
+
Check if this is greenfield or subsequent milestone:
|
|
525
|
+
- If no "Validated" requirements in PROJECT.md → Greenfield (building from scratch)
|
|
526
|
+
- If "Validated" requirements exist → Subsequent milestone (adding to existing app)
|
|
527
|
+
|
|
528
|
+
Display spawning indicator:
|
|
529
|
+
```
|
|
530
|
+
◆ Spawning 4 researchers in parallel...
|
|
531
|
+
→ Stack research
|
|
532
|
+
→ Features research
|
|
533
|
+
→ Architecture research
|
|
534
|
+
→ Pitfalls research
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
Spawn 4 parallel gsd-project-researcher agents with rich context:
|
|
538
|
+
|
|
539
|
+
```
|
|
540
|
+
Task(prompt="First, read ~/.claude/agents/gsd-project-researcher.md for your role and instructions.
|
|
541
|
+
|
|
542
|
+
<research_type>
|
|
543
|
+
Project Research — Stack dimension for [domain].
|
|
544
|
+
</research_type>
|
|
545
|
+
|
|
546
|
+
<milestone_context>
|
|
547
|
+
[greenfield OR subsequent]
|
|
548
|
+
|
|
549
|
+
Greenfield: Research the standard stack for building [domain] from scratch.
|
|
550
|
+
Subsequent: Research what's needed to add [target features] to an existing [domain] app. Don't re-research the existing system.
|
|
551
|
+
</milestone_context>
|
|
552
|
+
|
|
553
|
+
<question>
|
|
554
|
+
What's the standard 2025 stack for [domain]?
|
|
555
|
+
</question>
|
|
556
|
+
|
|
557
|
+
<project_context>
|
|
558
|
+
[PROJECT.md summary - core value, constraints, what they're building]
|
|
559
|
+
</project_context>
|
|
560
|
+
|
|
561
|
+
<downstream_consumer>
|
|
562
|
+
Your STACK.md feeds into roadmap creation. Be prescriptive:
|
|
563
|
+
- Specific libraries with versions
|
|
564
|
+
- Clear rationale for each choice
|
|
565
|
+
- What NOT to use and why
|
|
566
|
+
</downstream_consumer>
|
|
567
|
+
|
|
568
|
+
<quality_gate>
|
|
569
|
+
- [ ] Versions are current (verify with Context7/official docs, not training data)
|
|
570
|
+
- [ ] Rationale explains WHY, not just WHAT
|
|
571
|
+
- [ ] Confidence levels assigned to each recommendation
|
|
572
|
+
</quality_gate>
|
|
573
|
+
|
|
574
|
+
<output>
|
|
575
|
+
Write to: .planning/research/STACK.md
|
|
576
|
+
Use template: ~/.claude/get-shit-done/templates/research-project/STACK.md
|
|
577
|
+
</output>
|
|
578
|
+
", subagent_type="general-purpose", model="{researcher_model}", description="Stack research")
|
|
579
|
+
|
|
580
|
+
Task(prompt="First, read ~/.claude/agents/gsd-project-researcher.md for your role and instructions.
|
|
581
|
+
|
|
582
|
+
<research_type>
|
|
583
|
+
Project Research — Features dimension for [domain].
|
|
584
|
+
</research_type>
|
|
585
|
+
|
|
586
|
+
<milestone_context>
|
|
587
|
+
[greenfield OR subsequent]
|
|
588
|
+
|
|
589
|
+
Greenfield: What features do [domain] products have? What's table stakes vs differentiating?
|
|
590
|
+
Subsequent: How do [target features] typically work? What's expected behavior?
|
|
591
|
+
</milestone_context>
|
|
592
|
+
|
|
593
|
+
<question>
|
|
594
|
+
What features do [domain] products have? What's table stakes vs differentiating?
|
|
595
|
+
</question>
|
|
596
|
+
|
|
597
|
+
<project_context>
|
|
598
|
+
[PROJECT.md summary]
|
|
599
|
+
</project_context>
|
|
600
|
+
|
|
601
|
+
<downstream_consumer>
|
|
602
|
+
Your FEATURES.md feeds into requirements definition. Categorize clearly:
|
|
603
|
+
- Table stakes (must have or users leave)
|
|
604
|
+
- Differentiators (competitive advantage)
|
|
605
|
+
- Anti-features (things to deliberately NOT build)
|
|
606
|
+
</downstream_consumer>
|
|
607
|
+
|
|
608
|
+
<quality_gate>
|
|
609
|
+
- [ ] Categories are clear (table stakes vs differentiators vs anti-features)
|
|
610
|
+
- [ ] Complexity noted for each feature
|
|
611
|
+
- [ ] Dependencies between features identified
|
|
612
|
+
</quality_gate>
|
|
613
|
+
|
|
614
|
+
<output>
|
|
615
|
+
Write to: .planning/research/FEATURES.md
|
|
616
|
+
Use template: ~/.claude/get-shit-done/templates/research-project/FEATURES.md
|
|
617
|
+
</output>
|
|
618
|
+
", subagent_type="general-purpose", model="{researcher_model}", description="Features research")
|
|
619
|
+
|
|
620
|
+
Task(prompt="First, read ~/.claude/agents/gsd-project-researcher.md for your role and instructions.
|
|
621
|
+
|
|
622
|
+
<research_type>
|
|
623
|
+
Project Research — Architecture dimension for [domain].
|
|
624
|
+
</research_type>
|
|
625
|
+
|
|
626
|
+
<milestone_context>
|
|
627
|
+
[greenfield OR subsequent]
|
|
628
|
+
|
|
629
|
+
Greenfield: How are [domain] systems typically structured? What are major components?
|
|
630
|
+
Subsequent: How do [target features] integrate with existing [domain] architecture?
|
|
631
|
+
</milestone_context>
|
|
632
|
+
|
|
633
|
+
<question>
|
|
634
|
+
How are [domain] systems typically structured? What are major components?
|
|
635
|
+
</question>
|
|
636
|
+
|
|
637
|
+
<project_context>
|
|
638
|
+
[PROJECT.md summary]
|
|
639
|
+
</project_context>
|
|
640
|
+
|
|
641
|
+
<downstream_consumer>
|
|
642
|
+
Your ARCHITECTURE.md informs phase structure in roadmap. Include:
|
|
643
|
+
- Component boundaries (what talks to what)
|
|
644
|
+
- Data flow (how information moves)
|
|
645
|
+
- Suggested build order (dependencies between components)
|
|
646
|
+
</downstream_consumer>
|
|
647
|
+
|
|
648
|
+
<quality_gate>
|
|
649
|
+
- [ ] Components clearly defined with boundaries
|
|
650
|
+
- [ ] Data flow direction explicit
|
|
651
|
+
- [ ] Build order implications noted
|
|
652
|
+
</quality_gate>
|
|
653
|
+
|
|
654
|
+
<output>
|
|
655
|
+
Write to: .planning/research/ARCHITECTURE.md
|
|
656
|
+
Use template: ~/.claude/get-shit-done/templates/research-project/ARCHITECTURE.md
|
|
657
|
+
</output>
|
|
658
|
+
", subagent_type="general-purpose", model="{researcher_model}", description="Architecture research")
|
|
659
|
+
|
|
660
|
+
Task(prompt="First, read ~/.claude/agents/gsd-project-researcher.md for your role and instructions.
|
|
661
|
+
|
|
662
|
+
<research_type>
|
|
663
|
+
Project Research — Pitfalls dimension for [domain].
|
|
664
|
+
</research_type>
|
|
665
|
+
|
|
666
|
+
<milestone_context>
|
|
667
|
+
[greenfield OR subsequent]
|
|
668
|
+
|
|
669
|
+
Greenfield: What do [domain] projects commonly get wrong? Critical mistakes?
|
|
670
|
+
Subsequent: What are common mistakes when adding [target features] to [domain]?
|
|
671
|
+
</milestone_context>
|
|
672
|
+
|
|
673
|
+
<question>
|
|
674
|
+
What do [domain] projects commonly get wrong? Critical mistakes?
|
|
675
|
+
</question>
|
|
676
|
+
|
|
677
|
+
<project_context>
|
|
678
|
+
[PROJECT.md summary]
|
|
679
|
+
</project_context>
|
|
680
|
+
|
|
681
|
+
<downstream_consumer>
|
|
682
|
+
Your PITFALLS.md prevents mistakes in roadmap/planning. For each pitfall:
|
|
683
|
+
- Warning signs (how to detect early)
|
|
684
|
+
- Prevention strategy (how to avoid)
|
|
685
|
+
- Which phase should address it
|
|
686
|
+
</downstream_consumer>
|
|
687
|
+
|
|
688
|
+
<quality_gate>
|
|
689
|
+
- [ ] Pitfalls are specific to this domain (not generic advice)
|
|
690
|
+
- [ ] Prevention strategies are actionable
|
|
691
|
+
- [ ] Phase mapping included where relevant
|
|
692
|
+
</quality_gate>
|
|
693
|
+
|
|
694
|
+
<output>
|
|
695
|
+
Write to: .planning/research/PITFALLS.md
|
|
696
|
+
Use template: ~/.claude/get-shit-done/templates/research-project/PITFALLS.md
|
|
697
|
+
</output>
|
|
698
|
+
", subagent_type="general-purpose", model="{researcher_model}", description="Pitfalls research")
|
|
699
|
+
```
|
|
700
|
+
|
|
701
|
+
After all 4 agents complete, spawn synthesizer to create SUMMARY.md:
|
|
702
|
+
|
|
703
|
+
```
|
|
704
|
+
Task(prompt="
|
|
705
|
+
<task>
|
|
706
|
+
Synthesize research outputs into SUMMARY.md.
|
|
707
|
+
</task>
|
|
708
|
+
|
|
709
|
+
<research_files>
|
|
710
|
+
Read these files:
|
|
711
|
+
- .planning/research/STACK.md
|
|
712
|
+
- .planning/research/FEATURES.md
|
|
713
|
+
- .planning/research/ARCHITECTURE.md
|
|
714
|
+
- .planning/research/PITFALLS.md
|
|
715
|
+
</research_files>
|
|
716
|
+
|
|
717
|
+
<output>
|
|
718
|
+
Write to: .planning/research/SUMMARY.md
|
|
719
|
+
Use template: ~/.claude/get-shit-done/templates/research-project/SUMMARY.md
|
|
720
|
+
Commit after writing.
|
|
721
|
+
</output>
|
|
722
|
+
", subagent_type="gsd-research-synthesizer", model="{synthesizer_model}", description="Synthesize research")
|
|
723
|
+
```
|
|
724
|
+
|
|
725
|
+
Display research complete banner and key findings:
|
|
726
|
+
```
|
|
727
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
728
|
+
GSD ► RESEARCH COMPLETE ✓
|
|
729
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
730
|
+
|
|
731
|
+
## Key Findings
|
|
732
|
+
|
|
733
|
+
**Stack:** [from SUMMARY.md]
|
|
734
|
+
**Table Stakes:** [from SUMMARY.md]
|
|
735
|
+
**Watch Out For:** [from SUMMARY.md]
|
|
736
|
+
|
|
737
|
+
Files: `.planning/research/`
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
**If "Skip research":** Continue to Step 7.
|
|
741
|
+
|
|
742
|
+
## 7. Define Requirements
|
|
743
|
+
|
|
744
|
+
Display stage banner:
|
|
745
|
+
```
|
|
746
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
747
|
+
GSD ► DEFINING REQUIREMENTS
|
|
748
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
749
|
+
```
|
|
750
|
+
|
|
751
|
+
**Load context:**
|
|
752
|
+
|
|
753
|
+
Read PROJECT.md and extract:
|
|
754
|
+
- Core value (the ONE thing that must work)
|
|
755
|
+
- Stated constraints (budget, timeline, tech limitations)
|
|
756
|
+
- Any explicit scope boundaries
|
|
757
|
+
|
|
758
|
+
**If research exists:** Read research/FEATURES.md and extract feature categories.
|
|
759
|
+
|
|
760
|
+
**If auto mode:**
|
|
761
|
+
- Auto-include all table stakes features (users expect these)
|
|
762
|
+
- Include features explicitly mentioned in provided document
|
|
763
|
+
- Auto-defer differentiators not mentioned in document
|
|
764
|
+
- Skip per-category AskUserQuestion loops
|
|
765
|
+
- Skip "Any additions?" question
|
|
766
|
+
- Skip requirements approval gate
|
|
767
|
+
- Generate REQUIREMENTS.md and commit directly
|
|
768
|
+
|
|
769
|
+
**Present features by category (interactive mode only):**
|
|
770
|
+
|
|
771
|
+
```
|
|
772
|
+
Here are the features for [domain]:
|
|
773
|
+
|
|
774
|
+
## Authentication
|
|
775
|
+
**Table stakes:**
|
|
776
|
+
- Sign up with email/password
|
|
777
|
+
- Email verification
|
|
778
|
+
- Password reset
|
|
779
|
+
- Session management
|
|
780
|
+
|
|
781
|
+
**Differentiators:**
|
|
782
|
+
- Magic link login
|
|
783
|
+
- OAuth (Google, GitHub)
|
|
784
|
+
- 2FA
|
|
785
|
+
|
|
786
|
+
**Research notes:** [any relevant notes]
|
|
787
|
+
|
|
788
|
+
---
|
|
789
|
+
|
|
790
|
+
## [Next Category]
|
|
791
|
+
...
|
|
792
|
+
```
|
|
793
|
+
|
|
794
|
+
**If no research:** Gather requirements through conversation instead.
|
|
795
|
+
|
|
796
|
+
Ask: "What are the main things users need to be able to do?"
|
|
797
|
+
|
|
798
|
+
For each capability mentioned:
|
|
799
|
+
- Ask clarifying questions to make it specific
|
|
800
|
+
- Probe for related capabilities
|
|
801
|
+
- Group into categories
|
|
802
|
+
|
|
803
|
+
**Scope each category:**
|
|
804
|
+
|
|
805
|
+
For each category, use AskUserQuestion:
|
|
806
|
+
|
|
807
|
+
- header: "[Category]" (max 12 chars)
|
|
808
|
+
- question: "Which [category] features are in v1?"
|
|
809
|
+
- multiSelect: true
|
|
810
|
+
- options:
|
|
811
|
+
- "[Feature 1]" — [brief description]
|
|
812
|
+
- "[Feature 2]" — [brief description]
|
|
813
|
+
- "[Feature 3]" — [brief description]
|
|
814
|
+
- "None for v1" — Defer entire category
|
|
815
|
+
|
|
816
|
+
Track responses:
|
|
817
|
+
- Selected features → v1 requirements
|
|
818
|
+
- Unselected table stakes → v2 (users expect these)
|
|
819
|
+
- Unselected differentiators → out of scope
|
|
820
|
+
|
|
821
|
+
**Identify gaps:**
|
|
822
|
+
|
|
823
|
+
Use AskUserQuestion:
|
|
824
|
+
- header: "Additions"
|
|
825
|
+
- question: "Any requirements research missed? (Features specific to your vision)"
|
|
826
|
+
- options:
|
|
827
|
+
- "No, research covered it" — Proceed
|
|
828
|
+
- "Yes, let me add some" — Capture additions
|
|
829
|
+
|
|
830
|
+
**Validate core value:**
|
|
831
|
+
|
|
832
|
+
Cross-check requirements against Core Value from PROJECT.md. If gaps detected, surface them.
|
|
833
|
+
|
|
834
|
+
**Generate REQUIREMENTS.md:**
|
|
835
|
+
|
|
836
|
+
Create `.planning/REQUIREMENTS.md` with:
|
|
837
|
+
- v1 Requirements grouped by category (checkboxes, REQ-IDs)
|
|
838
|
+
- v2 Requirements (deferred)
|
|
839
|
+
- Out of Scope (explicit exclusions with reasoning)
|
|
840
|
+
- Traceability section (empty, filled by roadmap)
|
|
841
|
+
|
|
842
|
+
**REQ-ID format:** `[CATEGORY]-[NUMBER]` (AUTH-01, CONTENT-02)
|
|
843
|
+
|
|
844
|
+
**Requirement quality criteria:**
|
|
845
|
+
|
|
846
|
+
Good requirements are:
|
|
847
|
+
- **Specific and testable:** "User can reset password via email link" (not "Handle password reset")
|
|
848
|
+
- **User-centric:** "User can X" (not "System does Y")
|
|
849
|
+
- **Atomic:** One capability per requirement (not "User can login and manage profile")
|
|
850
|
+
- **Independent:** Minimal dependencies on other requirements
|
|
851
|
+
|
|
852
|
+
Reject vague requirements. Push for specificity:
|
|
853
|
+
- "Handle authentication" → "User can log in with email/password and stay logged in across sessions"
|
|
854
|
+
- "Support sharing" → "User can share post via link that opens in recipient's browser"
|
|
855
|
+
|
|
856
|
+
**Present full requirements list (interactive mode only):**
|
|
857
|
+
|
|
858
|
+
Show every requirement (not counts) for user confirmation:
|
|
859
|
+
|
|
860
|
+
```
|
|
861
|
+
## v1 Requirements
|
|
862
|
+
|
|
863
|
+
### Authentication
|
|
864
|
+
- [ ] **AUTH-01**: User can create account with email/password
|
|
865
|
+
- [ ] **AUTH-02**: User can log in and stay logged in across sessions
|
|
866
|
+
- [ ] **AUTH-03**: User can log out from any page
|
|
867
|
+
|
|
868
|
+
### Content
|
|
869
|
+
- [ ] **CONT-01**: User can create posts with text
|
|
870
|
+
- [ ] **CONT-02**: User can edit their own posts
|
|
871
|
+
|
|
872
|
+
[... full list ...]
|
|
873
|
+
|
|
874
|
+
---
|
|
875
|
+
|
|
876
|
+
Does this capture what you're building? (yes / adjust)
|
|
877
|
+
```
|
|
878
|
+
|
|
879
|
+
If "adjust": Return to scoping.
|
|
880
|
+
|
|
881
|
+
**Commit requirements:**
|
|
882
|
+
|
|
883
|
+
```bash
|
|
884
|
+
node ~/.claude/get-shit-done/bin/gsd-tools.cjs commit "docs: define v1 requirements" --files .planning/REQUIREMENTS.md
|
|
885
|
+
```
|
|
886
|
+
|
|
887
|
+
## 8. Create Roadmap
|
|
888
|
+
|
|
889
|
+
Display stage banner:
|
|
890
|
+
```
|
|
891
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
892
|
+
GSD ► CREATING ROADMAP
|
|
893
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
894
|
+
|
|
895
|
+
◆ Spawning roadmapper...
|
|
896
|
+
```
|
|
897
|
+
|
|
898
|
+
Spawn gsd-roadmapper agent with context:
|
|
899
|
+
|
|
900
|
+
```
|
|
901
|
+
Task(prompt="
|
|
902
|
+
<planning_context>
|
|
903
|
+
|
|
904
|
+
**Project:**
|
|
905
|
+
@.planning/PROJECT.md
|
|
906
|
+
|
|
907
|
+
**Requirements:**
|
|
908
|
+
@.planning/REQUIREMENTS.md
|
|
909
|
+
|
|
910
|
+
**Research (if exists):**
|
|
911
|
+
@.planning/research/SUMMARY.md
|
|
912
|
+
|
|
913
|
+
**Config:**
|
|
914
|
+
@.planning/config.json
|
|
915
|
+
|
|
916
|
+
</planning_context>
|
|
917
|
+
|
|
918
|
+
<instructions>
|
|
919
|
+
Create roadmap:
|
|
920
|
+
1. Derive phases from requirements (don't impose structure)
|
|
921
|
+
2. Map every v1 requirement to exactly one phase
|
|
922
|
+
3. Derive 2-5 success criteria per phase (observable user behaviors)
|
|
923
|
+
4. Validate 100% coverage
|
|
924
|
+
5. Write files immediately (ROADMAP.md, STATE.md, update REQUIREMENTS.md traceability)
|
|
925
|
+
6. Return ROADMAP CREATED with summary
|
|
926
|
+
|
|
927
|
+
Write files first, then return. This ensures artifacts persist even if context is lost.
|
|
928
|
+
</instructions>
|
|
929
|
+
", subagent_type="gsd-roadmapper", model="{roadmapper_model}", description="Create roadmap")
|
|
930
|
+
```
|
|
931
|
+
|
|
932
|
+
**Handle roadmapper return:**
|
|
933
|
+
|
|
934
|
+
**If `## ROADMAP BLOCKED`:**
|
|
935
|
+
- Present blocker information
|
|
936
|
+
- Work with user to resolve
|
|
937
|
+
- Re-spawn when resolved
|
|
938
|
+
|
|
939
|
+
**If `## ROADMAP CREATED`:**
|
|
940
|
+
|
|
941
|
+
Read the created ROADMAP.md and present it nicely inline:
|
|
942
|
+
|
|
943
|
+
```
|
|
944
|
+
---
|
|
945
|
+
|
|
946
|
+
## Proposed Roadmap
|
|
947
|
+
|
|
948
|
+
**[N] phases** | **[X] requirements mapped** | All v1 requirements covered ✓
|
|
949
|
+
|
|
950
|
+
| # | Phase | Goal | Requirements | Success Criteria |
|
|
951
|
+
|---|-------|------|--------------|------------------|
|
|
952
|
+
| 1 | [Name] | [Goal] | [REQ-IDs] | [count] |
|
|
953
|
+
| 2 | [Name] | [Goal] | [REQ-IDs] | [count] |
|
|
954
|
+
| 3 | [Name] | [Goal] | [REQ-IDs] | [count] |
|
|
955
|
+
...
|
|
956
|
+
|
|
957
|
+
### Phase Details
|
|
958
|
+
|
|
959
|
+
**Phase 1: [Name]**
|
|
960
|
+
Goal: [goal]
|
|
961
|
+
Requirements: [REQ-IDs]
|
|
962
|
+
Success criteria:
|
|
963
|
+
1. [criterion]
|
|
964
|
+
2. [criterion]
|
|
965
|
+
3. [criterion]
|
|
966
|
+
|
|
967
|
+
**Phase 2: [Name]**
|
|
968
|
+
Goal: [goal]
|
|
969
|
+
Requirements: [REQ-IDs]
|
|
970
|
+
Success criteria:
|
|
971
|
+
1. [criterion]
|
|
972
|
+
2. [criterion]
|
|
973
|
+
|
|
974
|
+
[... continue for all phases ...]
|
|
975
|
+
|
|
976
|
+
---
|
|
977
|
+
```
|
|
978
|
+
|
|
979
|
+
**If auto mode:** Skip approval gate — auto-approve and commit directly.
|
|
980
|
+
|
|
981
|
+
**CRITICAL: Ask for approval before committing (interactive mode only):**
|
|
982
|
+
|
|
983
|
+
Use AskUserQuestion:
|
|
984
|
+
- header: "Roadmap"
|
|
985
|
+
- question: "Does this roadmap structure work for you?"
|
|
986
|
+
- options:
|
|
987
|
+
- "Approve" — Commit and continue
|
|
988
|
+
- "Adjust phases" — Tell me what to change
|
|
989
|
+
- "Review full file" — Show raw ROADMAP.md
|
|
990
|
+
|
|
991
|
+
**If "Approve":** Continue to commit.
|
|
992
|
+
|
|
993
|
+
**If "Adjust phases":**
|
|
994
|
+
- Get user's adjustment notes
|
|
995
|
+
- Re-spawn roadmapper with revision context:
|
|
996
|
+
```
|
|
997
|
+
Task(prompt="
|
|
998
|
+
<revision>
|
|
999
|
+
User feedback on roadmap:
|
|
1000
|
+
[user's notes]
|
|
1001
|
+
|
|
1002
|
+
Current ROADMAP.md: @.planning/ROADMAP.md
|
|
1003
|
+
|
|
1004
|
+
Update the roadmap based on feedback. Edit files in place.
|
|
1005
|
+
Return ROADMAP REVISED with changes made.
|
|
1006
|
+
</revision>
|
|
1007
|
+
", subagent_type="gsd-roadmapper", model="{roadmapper_model}", description="Revise roadmap")
|
|
1008
|
+
```
|
|
1009
|
+
- Present revised roadmap
|
|
1010
|
+
- Loop until user approves
|
|
1011
|
+
|
|
1012
|
+
**If "Review full file":** Display raw `cat .planning/ROADMAP.md`, then re-ask.
|
|
1013
|
+
|
|
1014
|
+
**Commit roadmap (after approval or auto mode):**
|
|
1015
|
+
|
|
1016
|
+
```bash
|
|
1017
|
+
node ~/.claude/get-shit-done/bin/gsd-tools.cjs commit "docs: create roadmap ([N] phases)" --files .planning/ROADMAP.md .planning/STATE.md .planning/REQUIREMENTS.md
|
|
1018
|
+
```
|
|
1019
|
+
|
|
1020
|
+
## 9. Done
|
|
1021
|
+
|
|
1022
|
+
Present completion summary:
|
|
1023
|
+
|
|
1024
|
+
```
|
|
1025
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
1026
|
+
GSD ► PROJECT INITIALIZED ✓
|
|
1027
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
1028
|
+
|
|
1029
|
+
**[Project Name]**
|
|
1030
|
+
|
|
1031
|
+
| Artifact | Location |
|
|
1032
|
+
|----------------|-----------------------------|
|
|
1033
|
+
| Project | `.planning/PROJECT.md` |
|
|
1034
|
+
| Config | `.planning/config.json` |
|
|
1035
|
+
| Research | `.planning/research/` |
|
|
1036
|
+
| Requirements | `.planning/REQUIREMENTS.md` |
|
|
1037
|
+
| Roadmap | `.planning/ROADMAP.md` |
|
|
1038
|
+
|
|
1039
|
+
**[N] phases** | **[X] requirements** | Ready to build ✓
|
|
1040
|
+
```
|
|
1041
|
+
|
|
1042
|
+
**If auto mode:**
|
|
1043
|
+
|
|
1044
|
+
```
|
|
1045
|
+
╔══════════════════════════════════════════╗
|
|
1046
|
+
║ AUTO-ADVANCING → DISCUSS PHASE 1 ║
|
|
1047
|
+
╚══════════════════════════════════════════╝
|
|
1048
|
+
```
|
|
1049
|
+
|
|
1050
|
+
Exit skill and invoke SlashCommand("/gsd:discuss-phase 1 --auto")
|
|
1051
|
+
|
|
1052
|
+
**If interactive mode:**
|
|
1053
|
+
|
|
1054
|
+
```
|
|
1055
|
+
───────────────────────────────────────────────────────────────
|
|
1056
|
+
|
|
1057
|
+
## ▶ Next Up
|
|
1058
|
+
|
|
1059
|
+
**Phase 1: [Phase Name]** — [Goal from ROADMAP.md]
|
|
1060
|
+
|
|
1061
|
+
/gsd:discuss-phase 1 — gather context and clarify approach
|
|
1062
|
+
|
|
1063
|
+
<sub>/clear first → fresh context window</sub>
|
|
1064
|
+
|
|
1065
|
+
---
|
|
1066
|
+
|
|
1067
|
+
**Also available:**
|
|
1068
|
+
- /gsd:plan-phase 1 — skip discussion, plan directly
|
|
1069
|
+
|
|
1070
|
+
───────────────────────────────────────────────────────────────
|
|
1071
|
+
```
|
|
1072
|
+
|
|
1073
|
+
</process>
|
|
1074
|
+
|
|
1075
|
+
<output>
|
|
1076
|
+
|
|
1077
|
+
- `.planning/PROJECT.md`
|
|
1078
|
+
- `.planning/config.json`
|
|
1079
|
+
- `.planning/research/` (if research selected)
|
|
1080
|
+
- `STACK.md`
|
|
1081
|
+
- `FEATURES.md`
|
|
1082
|
+
- `ARCHITECTURE.md`
|
|
1083
|
+
- `PITFALLS.md`
|
|
1084
|
+
- `SUMMARY.md`
|
|
1085
|
+
- `.planning/REQUIREMENTS.md`
|
|
1086
|
+
- `.planning/ROADMAP.md`
|
|
1087
|
+
- `.planning/STATE.md`
|
|
1088
|
+
|
|
1089
|
+
</output>
|
|
1090
|
+
|
|
1091
|
+
<success_criteria>
|
|
1092
|
+
|
|
1093
|
+
- [ ] .planning/ directory created
|
|
1094
|
+
- [ ] Git repo initialized
|
|
1095
|
+
- [ ] Brownfield detection completed
|
|
1096
|
+
- [ ] Deep questioning completed (threads followed, not rushed)
|
|
1097
|
+
- [ ] PROJECT.md captures full context → **committed**
|
|
1098
|
+
- [ ] config.json has workflow mode, depth, parallelization → **committed**
|
|
1099
|
+
- [ ] Research completed (if selected) — 4 parallel agents spawned → **committed**
|
|
1100
|
+
- [ ] Requirements gathered (from research or conversation)
|
|
1101
|
+
- [ ] User scoped each category (v1/v2/out of scope)
|
|
1102
|
+
- [ ] REQUIREMENTS.md created with REQ-IDs → **committed**
|
|
1103
|
+
- [ ] gsd-roadmapper spawned with context
|
|
1104
|
+
- [ ] Roadmap files written immediately (not draft)
|
|
1105
|
+
- [ ] User feedback incorporated (if any)
|
|
1106
|
+
- [ ] ROADMAP.md created with phases, requirement mappings, success criteria
|
|
1107
|
+
- [ ] STATE.md initialized
|
|
1108
|
+
- [ ] REQUIREMENTS.md traceability updated
|
|
1109
|
+
- [ ] User knows next step is `/gsd:discuss-phase 1`
|
|
1110
|
+
|
|
1111
|
+
**Atomic commits:** Each phase commits its artifacts immediately. If context is lost, artifacts persist.
|
|
1112
|
+
|
|
1113
|
+
</success_criteria>
|