get-research-done 1.1.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/LICENSE +21 -0
- package/README.md +560 -0
- package/agents/grd-architect.md +789 -0
- package/agents/grd-codebase-mapper.md +738 -0
- package/agents/grd-critic.md +1065 -0
- package/agents/grd-debugger.md +1203 -0
- package/agents/grd-evaluator.md +948 -0
- package/agents/grd-executor.md +784 -0
- package/agents/grd-explorer.md +2063 -0
- package/agents/grd-graduator.md +484 -0
- package/agents/grd-integration-checker.md +423 -0
- package/agents/grd-phase-researcher.md +641 -0
- package/agents/grd-plan-checker.md +745 -0
- package/agents/grd-planner.md +1386 -0
- package/agents/grd-project-researcher.md +865 -0
- package/agents/grd-research-synthesizer.md +256 -0
- package/agents/grd-researcher.md +2361 -0
- package/agents/grd-roadmapper.md +605 -0
- package/agents/grd-verifier.md +778 -0
- package/bin/install.js +1294 -0
- package/commands/grd/add-phase.md +207 -0
- package/commands/grd/add-todo.md +193 -0
- package/commands/grd/architect.md +283 -0
- package/commands/grd/audit-milestone.md +277 -0
- package/commands/grd/check-todos.md +228 -0
- package/commands/grd/complete-milestone.md +136 -0
- package/commands/grd/debug.md +169 -0
- package/commands/grd/discuss-phase.md +86 -0
- package/commands/grd/evaluate.md +1095 -0
- package/commands/grd/execute-phase.md +339 -0
- package/commands/grd/explore.md +258 -0
- package/commands/grd/graduate.md +323 -0
- package/commands/grd/help.md +482 -0
- package/commands/grd/insert-phase.md +227 -0
- package/commands/grd/insights.md +231 -0
- package/commands/grd/join-discord.md +18 -0
- package/commands/grd/list-phase-assumptions.md +50 -0
- package/commands/grd/map-codebase.md +71 -0
- package/commands/grd/new-milestone.md +721 -0
- package/commands/grd/new-project.md +1008 -0
- package/commands/grd/pause-work.md +134 -0
- package/commands/grd/plan-milestone-gaps.md +295 -0
- package/commands/grd/plan-phase.md +525 -0
- package/commands/grd/progress.md +364 -0
- package/commands/grd/quick-explore.md +236 -0
- package/commands/grd/quick.md +309 -0
- package/commands/grd/remove-phase.md +349 -0
- package/commands/grd/research-phase.md +200 -0
- package/commands/grd/research.md +681 -0
- package/commands/grd/resume-work.md +40 -0
- package/commands/grd/set-profile.md +106 -0
- package/commands/grd/settings.md +136 -0
- package/commands/grd/update.md +172 -0
- package/commands/grd/verify-work.md +219 -0
- package/get-research-done/config/default.json +15 -0
- package/get-research-done/references/checkpoints.md +1078 -0
- package/get-research-done/references/continuation-format.md +249 -0
- package/get-research-done/references/git-integration.md +254 -0
- package/get-research-done/references/model-profiles.md +73 -0
- package/get-research-done/references/planning-config.md +94 -0
- package/get-research-done/references/questioning.md +141 -0
- package/get-research-done/references/tdd.md +263 -0
- package/get-research-done/references/ui-brand.md +160 -0
- package/get-research-done/references/verification-patterns.md +612 -0
- package/get-research-done/templates/DEBUG.md +159 -0
- package/get-research-done/templates/UAT.md +247 -0
- package/get-research-done/templates/archive-reason.md +195 -0
- package/get-research-done/templates/codebase/architecture.md +255 -0
- package/get-research-done/templates/codebase/concerns.md +310 -0
- package/get-research-done/templates/codebase/conventions.md +307 -0
- package/get-research-done/templates/codebase/integrations.md +280 -0
- package/get-research-done/templates/codebase/stack.md +186 -0
- package/get-research-done/templates/codebase/structure.md +285 -0
- package/get-research-done/templates/codebase/testing.md +480 -0
- package/get-research-done/templates/config.json +35 -0
- package/get-research-done/templates/context.md +283 -0
- package/get-research-done/templates/continue-here.md +78 -0
- package/get-research-done/templates/critic-log.md +288 -0
- package/get-research-done/templates/data-report.md +173 -0
- package/get-research-done/templates/debug-subagent-prompt.md +91 -0
- package/get-research-done/templates/decision-log.md +58 -0
- package/get-research-done/templates/decision.md +138 -0
- package/get-research-done/templates/discovery.md +146 -0
- package/get-research-done/templates/experiment-readme.md +104 -0
- package/get-research-done/templates/graduated-script.md +180 -0
- package/get-research-done/templates/iteration-summary.md +234 -0
- package/get-research-done/templates/milestone-archive.md +123 -0
- package/get-research-done/templates/milestone.md +115 -0
- package/get-research-done/templates/objective.md +271 -0
- package/get-research-done/templates/phase-prompt.md +567 -0
- package/get-research-done/templates/planner-subagent-prompt.md +117 -0
- package/get-research-done/templates/project.md +184 -0
- package/get-research-done/templates/requirements.md +231 -0
- package/get-research-done/templates/research-project/ARCHITECTURE.md +204 -0
- package/get-research-done/templates/research-project/FEATURES.md +147 -0
- package/get-research-done/templates/research-project/PITFALLS.md +200 -0
- package/get-research-done/templates/research-project/STACK.md +120 -0
- package/get-research-done/templates/research-project/SUMMARY.md +170 -0
- package/get-research-done/templates/research.md +529 -0
- package/get-research-done/templates/roadmap.md +202 -0
- package/get-research-done/templates/scorecard.json +113 -0
- package/get-research-done/templates/state.md +287 -0
- package/get-research-done/templates/summary.md +246 -0
- package/get-research-done/templates/user-setup.md +311 -0
- package/get-research-done/templates/verification-report.md +322 -0
- package/get-research-done/workflows/complete-milestone.md +756 -0
- package/get-research-done/workflows/diagnose-issues.md +231 -0
- package/get-research-done/workflows/discovery-phase.md +289 -0
- package/get-research-done/workflows/discuss-phase.md +433 -0
- package/get-research-done/workflows/execute-phase.md +657 -0
- package/get-research-done/workflows/execute-plan.md +1844 -0
- package/get-research-done/workflows/list-phase-assumptions.md +178 -0
- package/get-research-done/workflows/map-codebase.md +322 -0
- package/get-research-done/workflows/resume-project.md +307 -0
- package/get-research-done/workflows/transition.md +556 -0
- package/get-research-done/workflows/verify-phase.md +628 -0
- package/get-research-done/workflows/verify-work.md +596 -0
- package/hooks/dist/grd-check-update.js +61 -0
- package/hooks/dist/grd-statusline.js +84 -0
- package/package.json +47 -0
- package/scripts/audit-help-commands.sh +115 -0
- package/scripts/build-hooks.js +42 -0
- package/scripts/verify-all-commands.sh +246 -0
- package/scripts/verify-architect-warning.sh +35 -0
- package/scripts/verify-insights-mode.sh +40 -0
- package/scripts/verify-quick-mode.sh +20 -0
- package/scripts/verify-revise-data-routing.sh +139 -0
|
@@ -0,0 +1,364 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grd:progress
|
|
3
|
+
description: Check project progress, show context, and route to next action (execute or plan)
|
|
4
|
+
allowed-tools:
|
|
5
|
+
- Read
|
|
6
|
+
- Bash
|
|
7
|
+
- Grep
|
|
8
|
+
- Glob
|
|
9
|
+
- SlashCommand
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
<objective>
|
|
13
|
+
Check project progress, summarize recent work and what's ahead, then intelligently route to the next action - either executing an existing plan or creating the next one.
|
|
14
|
+
|
|
15
|
+
Provides situational awareness before continuing work.
|
|
16
|
+
</objective>
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
<process>
|
|
20
|
+
|
|
21
|
+
<step name="verify">
|
|
22
|
+
**Verify planning structure exists:**
|
|
23
|
+
|
|
24
|
+
Use Bash (not Glob) to check—Glob respects .gitignore but .planning/ is often gitignored:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
test -d .planning && echo "exists" || echo "missing"
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
If no `.planning/` directory:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
No planning structure found.
|
|
34
|
+
|
|
35
|
+
Run /grd:new-project to start a new project.
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Exit.
|
|
39
|
+
|
|
40
|
+
If missing STATE.md: suggest `/grd:new-project`.
|
|
41
|
+
|
|
42
|
+
**If ROADMAP.md missing but PROJECT.md exists:**
|
|
43
|
+
|
|
44
|
+
This means a milestone was completed and archived. Go to **Route F** (between milestones).
|
|
45
|
+
|
|
46
|
+
If missing both ROADMAP.md and PROJECT.md: suggest `/grd:new-project`.
|
|
47
|
+
</step>
|
|
48
|
+
|
|
49
|
+
<step name="load">
|
|
50
|
+
**Load full project context:**
|
|
51
|
+
|
|
52
|
+
- Read `.planning/STATE.md` for living memory (position, decisions, issues)
|
|
53
|
+
- Read `.planning/ROADMAP.md` for phase structure and objectives
|
|
54
|
+
- Read `.planning/PROJECT.md` for current state (What This Is, Core Value, Requirements)
|
|
55
|
+
- Read `.planning/config.json` for settings (model_profile, workflow toggles)
|
|
56
|
+
</step>
|
|
57
|
+
|
|
58
|
+
<step name="recent">
|
|
59
|
+
**Gather recent work context:**
|
|
60
|
+
|
|
61
|
+
- Find the 2-3 most recent SUMMARY.md files
|
|
62
|
+
- Extract from each: what was accomplished, key decisions, any issues logged
|
|
63
|
+
- This shows "what we've been working on"
|
|
64
|
+
</step>
|
|
65
|
+
|
|
66
|
+
<step name="position">
|
|
67
|
+
**Parse current position:**
|
|
68
|
+
|
|
69
|
+
- From STATE.md: current phase, plan number, status
|
|
70
|
+
- Calculate: total plans, completed plans, remaining plans
|
|
71
|
+
- Note any blockers or concerns
|
|
72
|
+
- Check for CONTEXT.md: For phases without PLAN.md files, check if `{phase}-CONTEXT.md` exists in phase directory
|
|
73
|
+
- Count pending todos: `ls .planning/todos/pending/*.md 2>/dev/null | wc -l`
|
|
74
|
+
- Check for active debug sessions: `ls .planning/debug/*.md 2>/dev/null | grep -v resolved | wc -l`
|
|
75
|
+
</step>
|
|
76
|
+
|
|
77
|
+
<step name="report">
|
|
78
|
+
**Present rich status report:**
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
# [Project Name]
|
|
82
|
+
|
|
83
|
+
**Progress:** [████████░░] 8/10 plans complete
|
|
84
|
+
**Profile:** [quality/balanced/budget]
|
|
85
|
+
|
|
86
|
+
## Recent Work
|
|
87
|
+
- [Phase X, Plan Y]: [what was accomplished - 1 line]
|
|
88
|
+
- [Phase X, Plan Z]: [what was accomplished - 1 line]
|
|
89
|
+
|
|
90
|
+
## Current Position
|
|
91
|
+
Phase [N] of [total]: [phase-name]
|
|
92
|
+
Plan [M] of [phase-total]: [status]
|
|
93
|
+
CONTEXT: [✓ if CONTEXT.md exists | - if not]
|
|
94
|
+
|
|
95
|
+
## Key Decisions Made
|
|
96
|
+
- [decision 1 from STATE.md]
|
|
97
|
+
- [decision 2]
|
|
98
|
+
|
|
99
|
+
## Blockers/Concerns
|
|
100
|
+
- [any blockers or concerns from STATE.md]
|
|
101
|
+
|
|
102
|
+
## Pending Todos
|
|
103
|
+
- [count] pending — /grd:check-todos to review
|
|
104
|
+
|
|
105
|
+
## Active Debug Sessions
|
|
106
|
+
- [count] active — /grd:debug to continue
|
|
107
|
+
(Only show this section if count > 0)
|
|
108
|
+
|
|
109
|
+
## What's Next
|
|
110
|
+
[Next phase/plan objective from ROADMAP]
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
</step>
|
|
114
|
+
|
|
115
|
+
<step name="route">
|
|
116
|
+
**Determine next action based on verified counts.**
|
|
117
|
+
|
|
118
|
+
**Step 1: Count plans, summaries, and issues in current phase**
|
|
119
|
+
|
|
120
|
+
List files in the current phase directory:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
ls -1 .planning/phases/[current-phase-dir]/*-PLAN.md 2>/dev/null | wc -l
|
|
124
|
+
ls -1 .planning/phases/[current-phase-dir]/*-SUMMARY.md 2>/dev/null | wc -l
|
|
125
|
+
ls -1 .planning/phases/[current-phase-dir]/*-UAT.md 2>/dev/null | wc -l
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
State: "This phase has {X} plans, {Y} summaries."
|
|
129
|
+
|
|
130
|
+
**Step 1.5: Check for unaddressed UAT gaps**
|
|
131
|
+
|
|
132
|
+
Check for UAT.md files with status "diagnosed" (has gaps needing fixes).
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
# Check for diagnosed UAT with gaps
|
|
136
|
+
grep -l "status: diagnosed" .planning/phases/[current-phase-dir]/*-UAT.md 2>/dev/null
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Track:
|
|
140
|
+
- `uat_with_gaps`: UAT.md files with status "diagnosed" (gaps need fixing)
|
|
141
|
+
|
|
142
|
+
**Step 2: Route based on counts**
|
|
143
|
+
|
|
144
|
+
| Condition | Meaning | Action |
|
|
145
|
+
|-----------|---------|--------|
|
|
146
|
+
| uat_with_gaps > 0 | UAT gaps need fix plans | Go to **Route E** |
|
|
147
|
+
| summaries < plans | Unexecuted plans exist | Go to **Route A** |
|
|
148
|
+
| summaries = plans AND plans > 0 | Phase complete | Go to Step 3 |
|
|
149
|
+
| plans = 0 | Phase not yet planned | Go to **Route B** |
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
**Route A: Unexecuted plan exists**
|
|
154
|
+
|
|
155
|
+
Find the first PLAN.md without matching SUMMARY.md.
|
|
156
|
+
Read its `<objective>` section.
|
|
157
|
+
|
|
158
|
+
```
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## ▶ Next Up
|
|
162
|
+
|
|
163
|
+
**{phase}-{plan}: [Plan Name]** — [objective summary from PLAN.md]
|
|
164
|
+
|
|
165
|
+
`/grd:execute-phase {phase}`
|
|
166
|
+
|
|
167
|
+
<sub>`/clear` first → fresh context window</sub>
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
**Route B: Phase needs planning**
|
|
175
|
+
|
|
176
|
+
Check if `{phase}-CONTEXT.md` exists in phase directory.
|
|
177
|
+
|
|
178
|
+
**If CONTEXT.md exists:**
|
|
179
|
+
|
|
180
|
+
```
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## ▶ Next Up
|
|
184
|
+
|
|
185
|
+
**Phase {N}: {Name}** — {Goal from ROADMAP.md}
|
|
186
|
+
<sub>✓ Context gathered, ready to plan</sub>
|
|
187
|
+
|
|
188
|
+
`/grd:plan-phase {phase-number}`
|
|
189
|
+
|
|
190
|
+
<sub>`/clear` first → fresh context window</sub>
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
**If CONTEXT.md does NOT exist:**
|
|
196
|
+
|
|
197
|
+
```
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## ▶ Next Up
|
|
201
|
+
|
|
202
|
+
**Phase {N}: {Name}** — {Goal from ROADMAP.md}
|
|
203
|
+
|
|
204
|
+
`/grd:discuss-phase {phase}` — gather context and clarify approach
|
|
205
|
+
|
|
206
|
+
<sub>`/clear` first → fresh context window</sub>
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
**Also available:**
|
|
211
|
+
- `/grd:plan-phase {phase}` — skip discussion, plan directly
|
|
212
|
+
- `/grd:list-phase-assumptions {phase}` — see Claude's assumptions
|
|
213
|
+
|
|
214
|
+
---
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
**Route E: UAT gaps need fix plans**
|
|
220
|
+
|
|
221
|
+
UAT.md exists with gaps (diagnosed issues). User needs to plan fixes.
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## ⚠ UAT Gaps Found
|
|
227
|
+
|
|
228
|
+
**{phase}-UAT.md** has {N} gaps requiring fixes.
|
|
229
|
+
|
|
230
|
+
`/grd:plan-phase {phase} --gaps`
|
|
231
|
+
|
|
232
|
+
<sub>`/clear` first → fresh context window</sub>
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
**Also available:**
|
|
237
|
+
- `/grd:execute-phase {phase}` — execute phase plans
|
|
238
|
+
- `/grd:verify-work {phase}` — run more UAT testing
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
**Step 3: Check milestone status (only when phase complete)**
|
|
246
|
+
|
|
247
|
+
Read ROADMAP.md and identify:
|
|
248
|
+
1. Current phase number
|
|
249
|
+
2. All phase numbers in the current milestone section
|
|
250
|
+
|
|
251
|
+
Count total phases and identify the highest phase number.
|
|
252
|
+
|
|
253
|
+
State: "Current phase is {X}. Milestone has {N} phases (highest: {Y})."
|
|
254
|
+
|
|
255
|
+
**Route based on milestone status:**
|
|
256
|
+
|
|
257
|
+
| Condition | Meaning | Action |
|
|
258
|
+
|-----------|---------|--------|
|
|
259
|
+
| current phase < highest phase | More phases remain | Go to **Route C** |
|
|
260
|
+
| current phase = highest phase | Milestone complete | Go to **Route D** |
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
**Route C: Phase complete, more phases remain**
|
|
265
|
+
|
|
266
|
+
Read ROADMAP.md to get the next phase's name and goal.
|
|
267
|
+
|
|
268
|
+
```
|
|
269
|
+
---
|
|
270
|
+
|
|
271
|
+
## ✓ Phase {Z} Complete
|
|
272
|
+
|
|
273
|
+
## ▶ Next Up
|
|
274
|
+
|
|
275
|
+
**Phase {Z+1}: {Name}** — {Goal from ROADMAP.md}
|
|
276
|
+
|
|
277
|
+
`/grd:discuss-phase {Z+1}` — gather context and clarify approach
|
|
278
|
+
|
|
279
|
+
<sub>`/clear` first → fresh context window</sub>
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
**Also available:**
|
|
284
|
+
- `/grd:plan-phase {Z+1}` — skip discussion, plan directly
|
|
285
|
+
- `/grd:verify-work {Z}` — user acceptance test before continuing
|
|
286
|
+
|
|
287
|
+
---
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
---
|
|
291
|
+
|
|
292
|
+
**Route D: Milestone complete**
|
|
293
|
+
|
|
294
|
+
```
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
## 🎉 Milestone Complete
|
|
298
|
+
|
|
299
|
+
All {N} phases finished!
|
|
300
|
+
|
|
301
|
+
## ▶ Next Up
|
|
302
|
+
|
|
303
|
+
**Complete Milestone** — archive and prepare for next
|
|
304
|
+
|
|
305
|
+
`/grd:complete-milestone`
|
|
306
|
+
|
|
307
|
+
<sub>`/clear` first → fresh context window</sub>
|
|
308
|
+
|
|
309
|
+
---
|
|
310
|
+
|
|
311
|
+
**Also available:**
|
|
312
|
+
- `/grd:verify-work` — user acceptance test before completing milestone
|
|
313
|
+
|
|
314
|
+
---
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
---
|
|
318
|
+
|
|
319
|
+
**Route F: Between milestones (ROADMAP.md missing, PROJECT.md exists)**
|
|
320
|
+
|
|
321
|
+
A milestone was completed and archived. Ready to start the next milestone cycle.
|
|
322
|
+
|
|
323
|
+
Read MILESTONES.md to find the last completed milestone version.
|
|
324
|
+
|
|
325
|
+
```
|
|
326
|
+
---
|
|
327
|
+
|
|
328
|
+
## ✓ Milestone v{X.Y} Complete
|
|
329
|
+
|
|
330
|
+
Ready to plan the next milestone.
|
|
331
|
+
|
|
332
|
+
## ▶ Next Up
|
|
333
|
+
|
|
334
|
+
**Start Next Milestone** — questioning → research → requirements → roadmap
|
|
335
|
+
|
|
336
|
+
`/grd:new-milestone`
|
|
337
|
+
|
|
338
|
+
<sub>`/clear` first → fresh context window</sub>
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
</step>
|
|
344
|
+
|
|
345
|
+
<step name="edge_cases">
|
|
346
|
+
**Handle edge cases:**
|
|
347
|
+
|
|
348
|
+
- Phase complete but next phase not planned → offer `/grd:plan-phase [next]`
|
|
349
|
+
- All work complete → offer milestone completion
|
|
350
|
+
- Blockers present → highlight before offering to continue
|
|
351
|
+
- Handoff file exists → mention it, offer `/grd:resume-work`
|
|
352
|
+
</step>
|
|
353
|
+
|
|
354
|
+
</process>
|
|
355
|
+
|
|
356
|
+
<success_criteria>
|
|
357
|
+
|
|
358
|
+
- [ ] Rich context provided (recent work, decisions, issues)
|
|
359
|
+
- [ ] Current position clear with visual progress
|
|
360
|
+
- [ ] What's next clearly explained
|
|
361
|
+
- [ ] Smart routing: /grd:execute-phase if plans exist, /grd:plan-phase if not
|
|
362
|
+
- [ ] User confirms before any action
|
|
363
|
+
- [ ] Seamless handoff to appropriate gsd command
|
|
364
|
+
</success_criteria>
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grd:quick-explore
|
|
3
|
+
description: Fast EDA producing console summary for quick data familiarization decisions
|
|
4
|
+
allowed-tools:
|
|
5
|
+
- Read
|
|
6
|
+
- Bash
|
|
7
|
+
- Write
|
|
8
|
+
- Task
|
|
9
|
+
- AskUserQuestion
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
<objective>
|
|
13
|
+
|
|
14
|
+
Fast exploratory data analysis that outputs a console-friendly summary for quick decisions and team sharing.
|
|
15
|
+
|
|
16
|
+
Unlike `/grd:explore` which produces a comprehensive DATA_REPORT.md, quick-explore prioritizes speed and readability:
|
|
17
|
+
- Completes in under 60 seconds
|
|
18
|
+
- Outputs formatted summary to console (copy-paste ready)
|
|
19
|
+
- Highlights critical issues with visual indicators
|
|
20
|
+
- Generates minimal DATA_REPORT.md marked as "Quick Explore Mode"
|
|
21
|
+
|
|
22
|
+
**Creates:**
|
|
23
|
+
- Console output with TL;DR, column summary, distribution highlights
|
|
24
|
+
- `.planning/DATA_REPORT.md` — marked as Quick Explore Mode (run full explore for rigor)
|
|
25
|
+
|
|
26
|
+
**Use cases:**
|
|
27
|
+
- First look at a new dataset
|
|
28
|
+
- Quick check before a meeting
|
|
29
|
+
- Sharing data overview with team (copy-paste console output)
|
|
30
|
+
- Deciding whether to invest time in full exploration
|
|
31
|
+
|
|
32
|
+
**After this command:**
|
|
33
|
+
- For quick decisions: Use the console summary
|
|
34
|
+
- For modeling: Run `/grd:explore` for comprehensive analysis
|
|
35
|
+
|
|
36
|
+
</objective>
|
|
37
|
+
|
|
38
|
+
<execution_context>
|
|
39
|
+
|
|
40
|
+
@~/.claude/get-research-done/templates/data-report.md
|
|
41
|
+
|
|
42
|
+
</execution_context>
|
|
43
|
+
|
|
44
|
+
<process>
|
|
45
|
+
|
|
46
|
+
## Phase 1: Setup and Data Path Resolution
|
|
47
|
+
|
|
48
|
+
**Check if project initialized:**
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
[ ! -f .planning/PROJECT.md ] && echo "ERROR: Project not initialized. Run /grd:new-project first." && exit 1
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**Determine data path:**
|
|
55
|
+
|
|
56
|
+
If [path] argument provided:
|
|
57
|
+
- Use it directly
|
|
58
|
+
- Validate path exists
|
|
59
|
+
|
|
60
|
+
If no argument:
|
|
61
|
+
- Check for common data directories (./data/, ./datasets/, ./raw/)
|
|
62
|
+
- If found, list contents and ask user to select
|
|
63
|
+
- If not found, ask user to provide path interactively
|
|
64
|
+
|
|
65
|
+
**Validate data source:**
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
# Check if path exists
|
|
69
|
+
if [ -f "$DATA_PATH" ]; then
|
|
70
|
+
echo "Single file: $DATA_PATH"
|
|
71
|
+
elif [ -d "$DATA_PATH" ]; then
|
|
72
|
+
echo "Directory: $DATA_PATH"
|
|
73
|
+
find "$DATA_PATH" -type f \( -name "*.csv" -o -name "*.parquet" -o -name "*.json" \) | head -10
|
|
74
|
+
else
|
|
75
|
+
echo "ERROR: Path not found: $DATA_PATH"
|
|
76
|
+
exit 1
|
|
77
|
+
fi
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Phase 2: Spawn Explorer Agent (Quick Mode)
|
|
81
|
+
|
|
82
|
+
Display quick explore banner:
|
|
83
|
+
```
|
|
84
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
85
|
+
GRD ► QUICK EXPLORE
|
|
86
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
87
|
+
|
|
88
|
+
Analyzing: [data_path]
|
|
89
|
+
Mode: Quick (< 60 seconds)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Spawn grd-explorer agent with quick mode context:
|
|
93
|
+
|
|
94
|
+
```
|
|
95
|
+
Task(prompt="
|
|
96
|
+
<data_source>
|
|
97
|
+
Path: [data_path]
|
|
98
|
+
Type: [file | directory]
|
|
99
|
+
</data_source>
|
|
100
|
+
|
|
101
|
+
<profiling_mode>quick</profiling_mode>
|
|
102
|
+
|
|
103
|
+
<quick_mode_instructions>
|
|
104
|
+
Quick explore mode priorities:
|
|
105
|
+
1. Speed: Complete analysis in < 60 seconds
|
|
106
|
+
2. Console output: Format results for terminal display
|
|
107
|
+
3. Visual indicators: Use emoji and formatting for quick scanning
|
|
108
|
+
4. Critical issues: Surface blocking problems prominently
|
|
109
|
+
|
|
110
|
+
Skip in quick mode:
|
|
111
|
+
- Detailed correlation analysis
|
|
112
|
+
- Comprehensive leakage detection (do basic checks only)
|
|
113
|
+
- Full distribution histograms
|
|
114
|
+
- Percentile calculations beyond quartiles
|
|
115
|
+
|
|
116
|
+
Include in quick mode:
|
|
117
|
+
- Row/column counts, memory usage
|
|
118
|
+
- Column types and missing value percentages
|
|
119
|
+
- Basic distribution indicators (skewness direction, outlier flags)
|
|
120
|
+
- Top 3 most concerning data quality issues
|
|
121
|
+
- Quick leakage red flags (obvious column name patterns)
|
|
122
|
+
|
|
123
|
+
Output format:
|
|
124
|
+
1. Print formatted TL;DR to console
|
|
125
|
+
2. Print column summary table to console
|
|
126
|
+
3. Print distribution highlights to console
|
|
127
|
+
4. Print quality warnings to console
|
|
128
|
+
5. Write DATA_REPORT.md with 'Quick Explore Mode' header
|
|
129
|
+
</quick_mode_instructions>
|
|
130
|
+
|
|
131
|
+
<project_context>
|
|
132
|
+
@.planning/PROJECT.md
|
|
133
|
+
|
|
134
|
+
Extract:
|
|
135
|
+
- What this project is about
|
|
136
|
+
- What the target variable might be (if ML project)
|
|
137
|
+
</project_context>
|
|
138
|
+
|
|
139
|
+
<console_output_format>
|
|
140
|
+
Use Rich-style formatting for console output:
|
|
141
|
+
|
|
142
|
+
## TL;DR
|
|
143
|
+
- Rows: X | Columns: Y | Memory: Z MB
|
|
144
|
+
- Missing: X% overall | Y columns have nulls
|
|
145
|
+
- Types: X numeric, Y categorical, Z datetime
|
|
146
|
+
- Issues: [emoji] [count] [severity] items need attention
|
|
147
|
+
|
|
148
|
+
## Column Summary (one line per column)
|
|
149
|
+
| Column | Type | Missing | Distribution |
|
|
150
|
+
|--------|------|---------|--------------|
|
|
151
|
+
| age | int | 0% | ▁▂▃▅▇ normal |
|
|
152
|
+
| income | float| 5% | ▁▁▁▁▇ right-skewed |
|
|
153
|
+
|
|
154
|
+
## Distribution Highlights
|
|
155
|
+
- [column]: [skewness indicator] [outlier flag]
|
|
156
|
+
|
|
157
|
+
## Quality Warnings
|
|
158
|
+
- [emoji] [severity]: [description]
|
|
159
|
+
</console_output_format>
|
|
160
|
+
|
|
161
|
+
<output>
|
|
162
|
+
1. Print formatted analysis to console
|
|
163
|
+
2. Write .planning/DATA_REPORT.md with Quick Explore header
|
|
164
|
+
3. Return summary of findings
|
|
165
|
+
</output>
|
|
166
|
+
", subagent_type="grd-explorer", model="sonnet", description="Quick explore data")
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Phase 3: Present Results
|
|
170
|
+
|
|
171
|
+
After agent completes, display footer:
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
175
|
+
GRD ► QUICK EXPLORE COMPLETE ✓
|
|
176
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
177
|
+
|
|
178
|
+
Quick report: .planning/DATA_REPORT.md (Quick Explore Mode)
|
|
179
|
+
|
|
180
|
+
───────────────────────────────────────────────────────────────
|
|
181
|
+
|
|
182
|
+
**For comprehensive analysis:** /grd:explore [path]
|
|
183
|
+
**To proceed with hypothesis:** /grd:architect
|
|
184
|
+
|
|
185
|
+
Note: Quick explore provides fast insights but skips thorough
|
|
186
|
+
leakage detection. Run full explore before modeling.
|
|
187
|
+
|
|
188
|
+
───────────────────────────────────────────────────────────────
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
</process>
|
|
192
|
+
|
|
193
|
+
<arguments>
|
|
194
|
+
|
|
195
|
+
**[path]** (required)
|
|
196
|
+
- Path to data file or directory
|
|
197
|
+
- Examples: `./data/train.csv`, `./datasets/`
|
|
198
|
+
|
|
199
|
+
</arguments>
|
|
200
|
+
|
|
201
|
+
<examples>
|
|
202
|
+
|
|
203
|
+
**Quick look at CSV:**
|
|
204
|
+
```
|
|
205
|
+
/grd:quick-explore ./data/train.csv
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
**Quick look at dataset directory:**
|
|
209
|
+
```
|
|
210
|
+
/grd:quick-explore ./datasets/
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
</examples>
|
|
214
|
+
|
|
215
|
+
<output>
|
|
216
|
+
|
|
217
|
+
**Console output:**
|
|
218
|
+
- TL;DR summary (row/column counts, types, issues)
|
|
219
|
+
- Column summary table with distribution sparklines
|
|
220
|
+
- Quality warnings with severity indicators
|
|
221
|
+
|
|
222
|
+
**File output:**
|
|
223
|
+
- `.planning/DATA_REPORT.md` — marked as Quick Explore Mode
|
|
224
|
+
|
|
225
|
+
</output>
|
|
226
|
+
|
|
227
|
+
<success_criteria>
|
|
228
|
+
|
|
229
|
+
- [ ] Data path resolved
|
|
230
|
+
- [ ] grd-explorer spawned with quick mode context
|
|
231
|
+
- [ ] Console summary printed with formatted output
|
|
232
|
+
- [ ] DATA_REPORT.md created with Quick Explore Mode header
|
|
233
|
+
- [ ] Analysis completed in < 60 seconds
|
|
234
|
+
- [ ] User informed about full explore option
|
|
235
|
+
|
|
236
|
+
</success_criteria>
|