learnship 1.9.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/.claude-plugin/plugin.json +26 -0
- package/.cursor-plugin/plugin.json +26 -0
- package/LICENSE +21 -0
- package/README.md +791 -0
- package/SKILL.md +86 -0
- package/agents/debugger.md +102 -0
- package/agents/executor.md +115 -0
- package/agents/learnship-debugger.md +146 -0
- package/agents/learnship-executor.md +155 -0
- package/agents/learnship-phase-researcher.md +128 -0
- package/agents/learnship-plan-checker.md +119 -0
- package/agents/learnship-planner.md +146 -0
- package/agents/learnship-verifier.md +157 -0
- package/agents/planner.md +109 -0
- package/agents/researcher.md +80 -0
- package/agents/verifier.md +114 -0
- package/bin/install.js +1242 -0
- package/bin/learnship.js +56 -0
- package/commands/learnship/add-phase.md +22 -0
- package/commands/learnship/add-tests.md +24 -0
- package/commands/learnship/add-todo.md +21 -0
- package/commands/learnship/audit-milestone.md +21 -0
- package/commands/learnship/check-todos.md +22 -0
- package/commands/learnship/cleanup.md +22 -0
- package/commands/learnship/complete-milestone.md +22 -0
- package/commands/learnship/debug.md +27 -0
- package/commands/learnship/decision-log.md +22 -0
- package/commands/learnship/diagnose-issues.md +23 -0
- package/commands/learnship/discovery-phase.md +24 -0
- package/commands/learnship/discuss-milestone.md +23 -0
- package/commands/learnship/discuss-phase.md +23 -0
- package/commands/learnship/execute-phase.md +27 -0
- package/commands/learnship/execute-plan.md +26 -0
- package/commands/learnship/health.md +20 -0
- package/commands/learnship/help.md +19 -0
- package/commands/learnship/insert-phase.md +22 -0
- package/commands/learnship/knowledge-base.md +21 -0
- package/commands/learnship/list-phase-assumptions.md +21 -0
- package/commands/learnship/ls.md +20 -0
- package/commands/learnship/map-codebase.md +23 -0
- package/commands/learnship/milestone-retrospective.md +21 -0
- package/commands/learnship/new-milestone.md +23 -0
- package/commands/learnship/new-project.md +24 -0
- package/commands/learnship/next.md +22 -0
- package/commands/learnship/pause-work.md +21 -0
- package/commands/learnship/plan-milestone-gaps.md +22 -0
- package/commands/learnship/plan-phase.md +24 -0
- package/commands/learnship/progress.md +20 -0
- package/commands/learnship/quick.md +27 -0
- package/commands/learnship/reapply-patches.md +21 -0
- package/commands/learnship/release.md +21 -0
- package/commands/learnship/remove-phase.md +23 -0
- package/commands/learnship/research-phase.md +23 -0
- package/commands/learnship/resume-work.md +21 -0
- package/commands/learnship/set-profile.md +21 -0
- package/commands/learnship/settings.md +21 -0
- package/commands/learnship/transition.md +21 -0
- package/commands/learnship/update.md +21 -0
- package/commands/learnship/validate-phase.md +22 -0
- package/commands/learnship/verify-work.md +23 -0
- package/cursor-rules/learnship.mdc +60 -0
- package/gemini-extension.json +10 -0
- package/hooks/hooks-claude.json +15 -0
- package/hooks/hooks-cursor.json +10 -0
- package/hooks/session-start +43 -0
- package/install.sh +254 -0
- package/learnship/references/design-commands.md +119 -0
- package/learnship/references/git-integration.md +249 -0
- package/learnship/references/learning-design.md +142 -0
- package/learnship/references/model-profiles.md +90 -0
- package/learnship/references/planning-config.md +184 -0
- package/learnship/references/questioning.md +162 -0
- package/learnship/references/ui-brand.md +160 -0
- package/learnship/references/verification-patterns.md +608 -0
- package/learnship/templates/agents.md +166 -0
- package/learnship/templates/context.md +72 -0
- package/learnship/templates/plan.md +202 -0
- package/learnship/templates/project.md +184 -0
- package/learnship/templates/requirements.md +231 -0
- package/learnship/templates/state.md +176 -0
- package/learnship/templates/uat.md +80 -0
- package/learnship/workflows/add-phase.md +84 -0
- package/learnship/workflows/add-tests.md +191 -0
- package/learnship/workflows/add-todo.md +108 -0
- package/learnship/workflows/audit-milestone.md +178 -0
- package/learnship/workflows/check-todos.md +138 -0
- package/learnship/workflows/cleanup.md +107 -0
- package/learnship/workflows/complete-milestone.md +191 -0
- package/learnship/workflows/debug.md +245 -0
- package/learnship/workflows/decision-log.md +131 -0
- package/learnship/workflows/diagnose-issues.md +145 -0
- package/learnship/workflows/discovery-phase.md +183 -0
- package/learnship/workflows/discuss-milestone.md +136 -0
- package/learnship/workflows/discuss-phase.md +244 -0
- package/learnship/workflows/execute-phase.md +345 -0
- package/learnship/workflows/execute-plan.md +149 -0
- package/learnship/workflows/health.md +171 -0
- package/learnship/workflows/help.md +153 -0
- package/learnship/workflows/insert-phase.md +106 -0
- package/learnship/workflows/knowledge-base.md +168 -0
- package/learnship/workflows/list-phase-assumptions.md +129 -0
- package/learnship/workflows/ls.md +145 -0
- package/learnship/workflows/map-codebase.md +142 -0
- package/learnship/workflows/milestone-retrospective.md +178 -0
- package/learnship/workflows/new-milestone.md +200 -0
- package/learnship/workflows/new-project.md +340 -0
- package/learnship/workflows/next.md +100 -0
- package/learnship/workflows/pause-work.md +122 -0
- package/learnship/workflows/plan-milestone-gaps.md +160 -0
- package/learnship/workflows/plan-phase.md +288 -0
- package/learnship/workflows/progress.md +118 -0
- package/learnship/workflows/quick.md +256 -0
- package/learnship/workflows/reapply-patches.md +130 -0
- package/learnship/workflows/release.md +217 -0
- package/learnship/workflows/remove-phase.md +128 -0
- package/learnship/workflows/research-phase.md +137 -0
- package/learnship/workflows/resume-work.md +162 -0
- package/learnship/workflows/set-profile.md +78 -0
- package/learnship/workflows/settings.md +204 -0
- package/learnship/workflows/sync-upstream-skills.md +269 -0
- package/learnship/workflows/transition.md +165 -0
- package/learnship/workflows/update.md +166 -0
- package/learnship/workflows/validate-phase.md +174 -0
- package/learnship/workflows/verify-work.md +264 -0
- package/package.json +62 -0
- package/references/design-commands.md +119 -0
- package/references/git-integration.md +249 -0
- package/references/learning-design.md +142 -0
- package/references/model-profiles.md +90 -0
- package/references/planning-config.md +184 -0
- package/references/questioning.md +162 -0
- package/references/ui-brand.md +160 -0
- package/references/verification-patterns.md +608 -0
- package/skills/agentic-learning/SKILL.md +373 -0
- package/skills/agentic-learning/references/either-or-format.md +161 -0
- package/skills/agentic-learning/references/learning-science.md +190 -0
- package/skills/agentic-learning/references/struggle-ladder.md +140 -0
- package/skills/impeccable/SKILL.md +125 -0
- package/skills/impeccable/adapt/SKILL.md +199 -0
- package/skills/impeccable/animate/SKILL.md +190 -0
- package/skills/impeccable/audit/SKILL.md +129 -0
- package/skills/impeccable/bolder/SKILL.md +132 -0
- package/skills/impeccable/clarify/SKILL.md +180 -0
- package/skills/impeccable/colorize/SKILL.md +158 -0
- package/skills/impeccable/critique/SKILL.md +118 -0
- package/skills/impeccable/delight/SKILL.md +317 -0
- package/skills/impeccable/distill/SKILL.md +137 -0
- package/skills/impeccable/extract/SKILL.md +95 -0
- package/skills/impeccable/frontend-design/SKILL.md +127 -0
- package/skills/impeccable/frontend-design/reference/color-and-contrast.md +132 -0
- package/skills/impeccable/frontend-design/reference/interaction-design.md +123 -0
- package/skills/impeccable/frontend-design/reference/motion-design.md +99 -0
- package/skills/impeccable/frontend-design/reference/responsive-design.md +114 -0
- package/skills/impeccable/frontend-design/reference/spatial-design.md +100 -0
- package/skills/impeccable/frontend-design/reference/typography.md +131 -0
- package/skills/impeccable/frontend-design/reference/ux-writing.md +107 -0
- package/skills/impeccable/harden/SKILL.md +358 -0
- package/skills/impeccable/normalize/SKILL.md +67 -0
- package/skills/impeccable/onboard/SKILL.md +243 -0
- package/skills/impeccable/optimize/SKILL.md +269 -0
- package/skills/impeccable/polish/SKILL.md +202 -0
- package/skills/impeccable/quieter/SKILL.md +118 -0
- package/skills/impeccable/teach-impeccable/SKILL.md +69 -0
- package/templates/agents.md +166 -0
- package/templates/config.json +22 -0
- package/templates/context.md +72 -0
- package/templates/plan.md +202 -0
- package/templates/project.md +184 -0
- package/templates/requirements.md +231 -0
- package/templates/state.md +176 -0
- package/templates/uat.md +80 -0
|
@@ -0,0 +1,340 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Initialize a new project — questioning → research → requirements → roadmap
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# New Project
|
|
6
|
+
|
|
7
|
+
Initialize a new project with full context gathering, optional research, requirements scoping, and roadmap creation. This is the most leveraged moment in any project — deep questioning now means better plans, better execution, better outcomes.
|
|
8
|
+
|
|
9
|
+
## Step 1: Setup
|
|
10
|
+
|
|
11
|
+
Check if `.planning/PROJECT.md` already exists:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
test -f .planning/PROJECT.md && echo "EXISTS" || echo "NEW"
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**If EXISTS:** Stop. Project already initialized. Use the `progress` workflow to see where you are.
|
|
18
|
+
|
|
19
|
+
Check if `.windsurf/` is already in `.gitignore`:
|
|
20
|
+
```bash
|
|
21
|
+
grep -q '.windsurf' .gitignore 2>/dev/null && echo "IGNORED" || echo "NOT_IGNORED"
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**If NOT_IGNORED:** Add it now (regardless of whether the project is new or existing):
|
|
25
|
+
```bash
|
|
26
|
+
echo '.windsurf/' >> .gitignore
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Check if git is initialized:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
test -d .git && echo "HAS_GIT" || echo "NO_GIT"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**If NO_GIT:**
|
|
36
|
+
```bash
|
|
37
|
+
git init
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Immediately add `.windsurf/` to `.gitignore` so the AI platform files are not tracked in the project repo:
|
|
41
|
+
```bash
|
|
42
|
+
echo '.windsurf/' >> .gitignore
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Create the planning directory:
|
|
46
|
+
```bash
|
|
47
|
+
mkdir -p .planning/research
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Step 2: Configuration
|
|
51
|
+
|
|
52
|
+
Ask the user the following questions to configure the project. Ask them in a conversational way — not all at once, but grouped naturally.
|
|
53
|
+
|
|
54
|
+
**Group A — Working style:**
|
|
55
|
+
|
|
56
|
+
Ask: "How do you want to work?"
|
|
57
|
+
- **YOLO** (recommended) — Auto-approve steps, just execute
|
|
58
|
+
- **Interactive** — Confirm at each step
|
|
59
|
+
|
|
60
|
+
Ask: "How finely should scope be sliced into phases?"
|
|
61
|
+
- **Coarse** (recommended) — Fewer, broader phases (3-5 phases, 1-3 plans each)
|
|
62
|
+
- **Standard** — Balanced phase size (5-8 phases, 3-5 plans each)
|
|
63
|
+
- **Fine** — Many focused phases (8-12 phases, 5-10 plans each)
|
|
64
|
+
|
|
65
|
+
**Group B — Learning mode:**
|
|
66
|
+
|
|
67
|
+
Ask: "How should the learning partner (agentic-learning) work during this project?"
|
|
68
|
+
- **Auto** (recommended) — I'll offer relevant learning actions at natural checkpoints (after planning, after execution, etc.)
|
|
69
|
+
- **Manual** — I'll only activate when you explicitly invoke `@agentic-learning`
|
|
70
|
+
|
|
71
|
+
**Group C — Workflow agents (these add quality but cost tokens/time):**
|
|
72
|
+
|
|
73
|
+
Ask: "Which workflow agents should be enabled?"
|
|
74
|
+
- **Research** (recommended) — Investigate domain before planning each phase
|
|
75
|
+
- **Plan Check** (recommended) — Verify plans achieve their goals before execution
|
|
76
|
+
- **Verifier** (recommended) — Confirm deliverables match phase goals after execution
|
|
77
|
+
|
|
78
|
+
**Group D — Parallel execution (Claude Code, OpenCode, Gemini CLI, Codex CLI only — skip for Windsurf):**
|
|
79
|
+
|
|
80
|
+
Ask: "Do you want to enable parallel subagent execution?"
|
|
81
|
+
- **No** (recommended default) — Plans execute sequentially, one at a time. Always safe, works on all platforms.
|
|
82
|
+
- **Yes** — Each independent plan in a wave gets its own dedicated subagent with a fresh context budget. Faster but requires a platform that supports real subagents (Claude Code, OpenCode, Gemini CLI, Codex CLI). **Not available on Windsurf.**
|
|
83
|
+
|
|
84
|
+
> Only ask this question if the platform is not Windsurf. If on Windsurf, always set `parallelization: false`.
|
|
85
|
+
|
|
86
|
+
Ask: "Commit planning docs to git?"
|
|
87
|
+
- **Yes** (recommended) — Planning docs tracked in version control
|
|
88
|
+
- **No** — Keep `.planning/` local-only
|
|
89
|
+
|
|
90
|
+
Ask: "When should learnship commit files to git?"
|
|
91
|
+
- **Automatically** (recommended) — Commit after each workflow step completes (config, requirements, roadmap, AGENTS.md)
|
|
92
|
+
- **Manually** — I'll commit when I say so; skip all git commit steps
|
|
93
|
+
|
|
94
|
+
Create `.planning/config.json` with all settings:
|
|
95
|
+
|
|
96
|
+
```json
|
|
97
|
+
{
|
|
98
|
+
"mode": "yolo|interactive",
|
|
99
|
+
"granularity": "coarse|standard|fine",
|
|
100
|
+
"commit_docs": true|false,
|
|
101
|
+
"commit_mode": "auto|manual",
|
|
102
|
+
"learning_mode": "auto|manual",
|
|
103
|
+
"parallelization": false|true,
|
|
104
|
+
"workflow": {
|
|
105
|
+
"research": true|false,
|
|
106
|
+
"plan_check": true|false,
|
|
107
|
+
"verifier": true|false
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
If `commit_docs` is false, add `.planning/` to `.gitignore`:
|
|
113
|
+
```bash
|
|
114
|
+
echo ".planning/" >> .gitignore
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
**If `commit_mode` is `auto`:** Stage and commit the initial setup now:
|
|
118
|
+
```bash
|
|
119
|
+
git add .gitignore .planning/config.json
|
|
120
|
+
git commit -m "chore: initialize learnship project setup"
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
**If `commit_mode` is `manual`:** Show this message and skip all future commit steps:
|
|
124
|
+
```
|
|
125
|
+
→ Manual commit mode — I will not run any git commits.
|
|
126
|
+
Stage and commit whenever you are ready.
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Step 3: Deep Questioning
|
|
130
|
+
|
|
131
|
+
Display:
|
|
132
|
+
```
|
|
133
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
134
|
+
learnship ► QUESTIONING
|
|
135
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
Ask openly: **"What do you want to build?"**
|
|
139
|
+
|
|
140
|
+
Wait for their response. Then follow the thread — each answer opens new questions. Dig into:
|
|
141
|
+
- What excited them / what problem sparked this
|
|
142
|
+
- What they mean by vague terms ("simple", "fast", "clean")
|
|
143
|
+
- What it would actually look like in use
|
|
144
|
+
- What's already decided vs. open
|
|
145
|
+
- Who the users are and what they need
|
|
146
|
+
|
|
147
|
+
Use the questioning techniques from `@./references/questioning.md`.
|
|
148
|
+
|
|
149
|
+
When you have enough to write a clear PROJECT.md, ask:
|
|
150
|
+
|
|
151
|
+
"I think I understand what you're after. Ready to create PROJECT.md, or do you want to explore more?"
|
|
152
|
+
|
|
153
|
+
- **Create PROJECT.md** → proceed
|
|
154
|
+
- **Keep exploring** → continue questions
|
|
155
|
+
|
|
156
|
+
Loop until ready.
|
|
157
|
+
|
|
158
|
+
## Step 4: Write PROJECT.md
|
|
159
|
+
|
|
160
|
+
Synthesize all gathered context into `.planning/PROJECT.md` using `@./templates/project.md` as the template.
|
|
161
|
+
|
|
162
|
+
**If `commit_mode` is `auto`:**
|
|
163
|
+
```bash
|
|
164
|
+
git add .planning/PROJECT.md && git commit -m "docs: initialize project"
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
## Step 5: Research Decision
|
|
168
|
+
|
|
169
|
+
Ask: "Research the domain ecosystem before defining requirements?"
|
|
170
|
+
- **Research first** (recommended) — Discover standard stacks, expected features, architecture patterns
|
|
171
|
+
- **Skip research** — I know this domain well, go straight to requirements
|
|
172
|
+
|
|
173
|
+
**If Research first:**
|
|
174
|
+
|
|
175
|
+
```
|
|
176
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
177
|
+
learnship ► RESEARCHING
|
|
178
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
Run 4 research passes sequentially. Each writes a file to `.planning/research/`:
|
|
182
|
+
|
|
183
|
+
1. **STACK.md** — Standard tech stack for this domain (specific libraries, versions, what NOT to use and why)
|
|
184
|
+
2. **FEATURES.md** — What features exist in this domain: table stakes vs. differentiators vs. anti-features
|
|
185
|
+
3. **ARCHITECTURE.md** — How systems in this domain are typically structured, component boundaries, data flow, suggested build order
|
|
186
|
+
4. **PITFALLS.md** — Common mistakes, warning signs, prevention strategies
|
|
187
|
+
|
|
188
|
+
After all four complete, synthesize into `.planning/research/SUMMARY.md` covering: recommended stack, table stakes features, key architecture decisions, top pitfalls to avoid.
|
|
189
|
+
|
|
190
|
+
Display key findings:
|
|
191
|
+
```
|
|
192
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
193
|
+
learnship ► RESEARCH COMPLETE ✓
|
|
194
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
195
|
+
|
|
196
|
+
**Stack:** [key recommendation]
|
|
197
|
+
**Table Stakes:** [top 3 must-have features]
|
|
198
|
+
**Watch Out For:** [top 2 pitfalls]
|
|
199
|
+
|
|
200
|
+
Files: .planning/research/
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Step 6: Define Requirements
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
207
|
+
learnship ► DEFINING REQUIREMENTS
|
|
208
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
Read `.planning/PROJECT.md` and research files if they exist. Present features by category with clear v1 vs. v2 distinctions.
|
|
212
|
+
|
|
213
|
+
For each feature category, ask the user which features are in v1 (multi-select). Track:
|
|
214
|
+
- Selected → v1 requirements
|
|
215
|
+
- Unselected table stakes → v2 (note: users will expect these)
|
|
216
|
+
- Unselected differentiators → out of scope
|
|
217
|
+
|
|
218
|
+
Each requirement should be:
|
|
219
|
+
- **Specific and testable:** "User can reset password via email link"
|
|
220
|
+
- **User-centric:** "User can X" (not "System does Y")
|
|
221
|
+
- **Atomic:** One capability per requirement
|
|
222
|
+
|
|
223
|
+
Create `.planning/REQUIREMENTS.md` with v1 requirements (with REQ-IDs like `AUTH-01`), v2 requirements, and out-of-scope items with reasoning.
|
|
224
|
+
|
|
225
|
+
Present the full list for confirmation. If user wants adjustments, iterate.
|
|
226
|
+
|
|
227
|
+
**If `commit_mode` is `auto`:**
|
|
228
|
+
```bash
|
|
229
|
+
git add .planning/REQUIREMENTS.md && git commit -m "docs: define v1 requirements"
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
## Step 7: Create Roadmap
|
|
233
|
+
|
|
234
|
+
```
|
|
235
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
236
|
+
learnship ► CREATING ROADMAP
|
|
237
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
Read `.planning/PROJECT.md`, `.planning/REQUIREMENTS.md`, and research summary (if exists).
|
|
241
|
+
|
|
242
|
+
Using `@./agents/planner.md` as your planning persona:
|
|
243
|
+
|
|
244
|
+
1. Derive phases from requirements (don't impose structure — let requirements drive phases)
|
|
245
|
+
2. Map every v1 requirement to exactly one phase
|
|
246
|
+
3. Create 2-5 observable success criteria per phase ("After this phase, user can ___")
|
|
247
|
+
4. Validate 100% requirement coverage
|
|
248
|
+
|
|
249
|
+
Write `.planning/ROADMAP.md` and `.planning/STATE.md` using `@./templates/requirements.md` and `@./templates/state.md`.
|
|
250
|
+
|
|
251
|
+
Present the roadmap clearly:
|
|
252
|
+
|
|
253
|
+
```
|
|
254
|
+
## Proposed Roadmap
|
|
255
|
+
|
|
256
|
+
**[N] phases** | **[X] requirements mapped** | All v1 requirements covered ✓
|
|
257
|
+
|
|
258
|
+
| # | Phase | Goal | Requirements |
|
|
259
|
+
|---|-------|------|--------------|
|
|
260
|
+
| 1 | [Name] | [Goal] | [REQ-IDs] |
|
|
261
|
+
...
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
Ask for approval:
|
|
265
|
+
- **Approve** → commit and continue
|
|
266
|
+
- **Adjust phases** → get feedback, revise, re-present
|
|
267
|
+
- **Review full file** → show raw ROADMAP.md, then re-ask
|
|
268
|
+
|
|
269
|
+
**If `commit_mode` is `auto`:**
|
|
270
|
+
```bash
|
|
271
|
+
git add .planning/ROADMAP.md .planning/STATE.md .planning/REQUIREMENTS.md && git commit -m "docs: create roadmap ([N] phases)"
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
## Step 8: Generate AGENTS.md
|
|
275
|
+
|
|
276
|
+
Copy `@./templates/agents.md` to the project root as `AGENTS.md`.
|
|
277
|
+
|
|
278
|
+
Fill in the placeholder sections using information gathered in this session:
|
|
279
|
+
|
|
280
|
+
**Project Structure** — derive from the project description and any existing directories:
|
|
281
|
+
```bash
|
|
282
|
+
find . -maxdepth 2 -not -path './.git/*' -not -path './node_modules/*' -not -path './.planning/*' -type d | sort | head -20
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
Populate the `## Project Structure` tree with real directories and one-line descriptions.
|
|
286
|
+
|
|
287
|
+
**Tech Stack** — use the research output (if research was run) or the user's stated stack:
|
|
288
|
+
- Language + version
|
|
289
|
+
- Framework
|
|
290
|
+
- Key libraries (the 3-5 most important)
|
|
291
|
+
- How to run the dev server
|
|
292
|
+
- How to run tests
|
|
293
|
+
|
|
294
|
+
**Current Phase** block:
|
|
295
|
+
```
|
|
296
|
+
Milestone: v1.0 — [Milestone Name from PROJECT.md]
|
|
297
|
+
Phase: 1 — [Phase 1 name from ROADMAP.md]
|
|
298
|
+
Status: planning
|
|
299
|
+
Last updated: [today's date]
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
**If `commit_mode` is `auto`:**
|
|
303
|
+
```bash
|
|
304
|
+
git add AGENTS.md && git commit -m "docs: add AGENTS.md with project context"
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
## Step 9: Done
|
|
308
|
+
|
|
309
|
+
```
|
|
310
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
311
|
+
learnship ► PROJECT INITIALIZED ✓
|
|
312
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
313
|
+
|
|
314
|
+
**[Project Name]** — [N] phases, [X] requirements
|
|
315
|
+
|
|
316
|
+
Files created:
|
|
317
|
+
- AGENTS.md ← your AI agent reads this every conversation
|
|
318
|
+
- .planning/PROJECT.md
|
|
319
|
+
- .planning/REQUIREMENTS.md
|
|
320
|
+
- .planning/ROADMAP.md
|
|
321
|
+
- .planning/STATE.md
|
|
322
|
+
- .planning/config.json
|
|
323
|
+
[- .planning/research/ (if research was run)]
|
|
324
|
+
|
|
325
|
+
▶ Next: discuss-phase 1 → plan-phase 1 → execute-phase 1
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
---
|
|
329
|
+
|
|
330
|
+
## Learning Checkpoint
|
|
331
|
+
|
|
332
|
+
Read `learning_mode` from `.planning/config.json`.
|
|
333
|
+
|
|
334
|
+
**If `auto`:** Offer this now:
|
|
335
|
+
|
|
336
|
+
> 💡 **Learning moment:** You've just defined what you're building. Want to validate your mental model before coding starts?
|
|
337
|
+
>
|
|
338
|
+
> `@agentic-learning brainstorm [your project topic]` — Talk through the design and surface any blind spots before the first line of code.
|
|
339
|
+
|
|
340
|
+
**If `manual`:** Add a quiet note: *"Tip: `@agentic-learning brainstorm [topic]` is available whenever you want to think through the design."*
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Automatically determine and run the correct next workflow — true auto-pilot for the phase loop
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Next — Auto-Pilot
|
|
6
|
+
|
|
7
|
+
Reads project state and runs the right next workflow automatically. No need to remember command names — just type `/next` and go.
|
|
8
|
+
|
|
9
|
+
**Usage:** `/next`
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Step 1: Check for Project
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
test -f .planning/PROJECT.md && echo "EXISTS" || echo "MISSING"
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
**If MISSING:**
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
No project found. Starting /new-project...
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Immediately run the `new-project` workflow. Stop here.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Step 2: Load State
|
|
30
|
+
|
|
31
|
+
Read:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
cat .planning/STATE.md
|
|
35
|
+
cat .planning/ROADMAP.md
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Check for handoff:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
find .planning/phases -name ".continue-here.md" 2>/dev/null
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
For current phase, count plans vs summaries:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
ls ".planning/phases/[current_phase_dir]/"*-PLAN.md 2>/dev/null | wc -l
|
|
48
|
+
ls ".planning/phases/[current_phase_dir]/"*-SUMMARY.md 2>/dev/null | wc -l
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Check for diagnosed UAT gaps:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
grep -l "status: diagnosed" .planning/phases/[current_phase_dir]/*-UAT.md 2>/dev/null
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Step 3: Determine Next Action
|
|
60
|
+
|
|
61
|
+
Evaluate in order:
|
|
62
|
+
|
|
63
|
+
| Condition | Next workflow |
|
|
64
|
+
|-----------|---------------|
|
|
65
|
+
| `.continue-here.md` exists | `resume-work` |
|
|
66
|
+
| UAT gaps with `status: diagnosed` | `plan-phase [X]` (gap closure) |
|
|
67
|
+
| Plans exist, summaries < plans | `execute-phase [X]` |
|
|
68
|
+
| Plans = 0, CONTEXT.md exists | `plan-phase [X]` |
|
|
69
|
+
| Plans = 0, no CONTEXT.md | `discuss-phase [X]` |
|
|
70
|
+
| All summaries complete, more phases remain | `discuss-phase [X+1]` |
|
|
71
|
+
| All phases complete | `audit-milestone` |
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Step 4: Confirm and Run
|
|
76
|
+
|
|
77
|
+
Display one line explaining what you're about to do:
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
81
|
+
learnship ► NEXT
|
|
82
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
83
|
+
|
|
84
|
+
[Project Name] — Phase [N]: [phase-name]
|
|
85
|
+
▶ About to run: [workflow-name] [args]
|
|
86
|
+
Reason: [one sentence — e.g. "Plans are ready but 2 of 3 haven't been executed yet"]
|
|
87
|
+
|
|
88
|
+
Proceed? (yes / no)
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
If yes — run the workflow immediately.
|
|
92
|
+
If no — show `/ls` output so the user can choose manually.
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Notes
|
|
97
|
+
|
|
98
|
+
- `/next` always confirms before acting (never fully silent).
|
|
99
|
+
- For status-only with manual choice, use `/ls` instead.
|
|
100
|
+
- To see all available commands: `/help`
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Save a handoff file when stopping mid-phase so you can resume seamlessly later
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Pause Work
|
|
6
|
+
|
|
7
|
+
Create a `.continue-here.md` handoff file that captures complete work state. Enables seamless resumption with full context restoration.
|
|
8
|
+
|
|
9
|
+
**Use when:** stopping mid-plan, mid-phase, or any time you want to preserve exact position.
|
|
10
|
+
|
|
11
|
+
## Step 1: Detect Current Phase
|
|
12
|
+
|
|
13
|
+
Find the most recently active phase:
|
|
14
|
+
```bash
|
|
15
|
+
find .planning/phases -name "*-PLAN.md" -type f 2>/dev/null | xargs ls -t 2>/dev/null | head -1
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Extract the phase directory name from the result.
|
|
19
|
+
|
|
20
|
+
If no active phase detected, ask: "Which phase are you pausing work on?"
|
|
21
|
+
|
|
22
|
+
## Step 2: Gather State
|
|
23
|
+
|
|
24
|
+
Collect the complete handoff state by reading current files:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
cat ".planning/phases/[phase_dir]/"*-PLAN.md 2>/dev/null
|
|
28
|
+
cat .planning/STATE.md
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Also ask the user (conversationally) for anything that can't be inferred from files:
|
|
32
|
+
- Which specific task were you on?
|
|
33
|
+
- What's already completed vs. what's in progress?
|
|
34
|
+
- Any key decisions made this session that aren't yet committed?
|
|
35
|
+
- Any blockers or things to watch out for?
|
|
36
|
+
- What's the very first thing to do when resuming?
|
|
37
|
+
|
|
38
|
+
## Step 3: Write Handoff File
|
|
39
|
+
|
|
40
|
+
Write `.planning/phases/[phase_dir]/.continue-here.md`:
|
|
41
|
+
|
|
42
|
+
```markdown
|
|
43
|
+
---
|
|
44
|
+
phase: [phase_dir]
|
|
45
|
+
task: [current task number]
|
|
46
|
+
total_tasks: [total tasks in current plan]
|
|
47
|
+
status: in_progress
|
|
48
|
+
last_updated: [ISO timestamp]
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
<current_state>
|
|
52
|
+
[Where exactly are we? Phase X, Plan Y, Task Z — immediate context for a fresh session]
|
|
53
|
+
</current_state>
|
|
54
|
+
|
|
55
|
+
<completed_work>
|
|
56
|
+
- Task 1: [name] — Done
|
|
57
|
+
- Task 2: [name] — Done
|
|
58
|
+
- Task 3: [name] — In progress, [what's done so far]
|
|
59
|
+
</completed_work>
|
|
60
|
+
|
|
61
|
+
<remaining_work>
|
|
62
|
+
- Task 3: [what's left to complete]
|
|
63
|
+
- Task 4: Not started
|
|
64
|
+
- Task 5: Not started
|
|
65
|
+
</remaining_work>
|
|
66
|
+
|
|
67
|
+
<decisions_made>
|
|
68
|
+
- Decided to use [X] because [reason]
|
|
69
|
+
- Chose [approach] over [alternative] because [reason]
|
|
70
|
+
</decisions_made>
|
|
71
|
+
|
|
72
|
+
<blockers>
|
|
73
|
+
- [Any blocker]: [status or workaround]
|
|
74
|
+
</blockers>
|
|
75
|
+
|
|
76
|
+
<context>
|
|
77
|
+
[The mental model: what approach is being taken, why, what to watch out for]
|
|
78
|
+
</context>
|
|
79
|
+
|
|
80
|
+
<next_action>
|
|
81
|
+
Start with: [the specific first action to take when resuming — be precise]
|
|
82
|
+
</next_action>
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Be specific enough that a fresh Cascade session can pick up immediately without re-asking.
|
|
86
|
+
|
|
87
|
+
## Step 4: Commit
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
git add ".planning/phases/[phase_dir]/.continue-here.md"
|
|
91
|
+
git commit -m "wip: [phase-name] paused at task [X]/[Y]"
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Step 5: Confirm
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
✓ Handoff created: .planning/phases/[phase_dir]/.continue-here.md
|
|
98
|
+
|
|
99
|
+
Current state:
|
|
100
|
+
- Phase: [phase_dir]
|
|
101
|
+
- Task: [X] of [Y]
|
|
102
|
+
- Status: in_progress
|
|
103
|
+
- Committed as WIP
|
|
104
|
+
|
|
105
|
+
▶ To resume: resume-work
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Learning Checkpoint
|
|
111
|
+
|
|
112
|
+
Read `learning_mode` from `.planning/config.json`.
|
|
113
|
+
|
|
114
|
+
**If `auto`:** Offer before the session ends:
|
|
115
|
+
|
|
116
|
+
> 💡 **Before you go:** Session transitions are when learning decays fastest. Two minutes now saves re-learning later:
|
|
117
|
+
>
|
|
118
|
+
> `@agentic-learning space` — Identify what was covered this session and schedule it for spaced review. Writes to `docs/revisit.md`. When you resume, you'll start sharper.
|
|
119
|
+
>
|
|
120
|
+
> `@agentic-learning reflect` — Quick 3-part reflection: what was built this session, what was the intent, what still feels uncertain. Takes 3 minutes, pays off when you return.
|
|
121
|
+
|
|
122
|
+
**If `manual`:** Add quietly: *"Tip: `@agentic-learning space` before closing to schedule what you worked on for review."*
|