flow-cc 0.5.0 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -43
- package/package.json +1 -1
- package/skills/flow-spec.md +1 -1
- package/skills/flow-status.md +4 -2
package/README.md
CHANGED
|
@@ -19,17 +19,22 @@ npx flow-cc
|
|
|
19
19
|
|
|
20
20
|
One command. Installs skills, hooks, templates, and configures your statusLine. Works on Mac, Linux, and Windows.
|
|
21
21
|
|
|
22
|
+
---
|
|
23
|
+
|
|
22
24
|
## Why Flow?
|
|
23
25
|
|
|
24
26
|
Claude Code is powerful but unstructured. Without a system, you lose context between sessions, repeat mistakes, and waste tokens re-explaining what you've already decided.
|
|
25
27
|
|
|
26
|
-
Flow
|
|
28
|
+
Flow gives Claude Code a **memory system and execution framework**:
|
|
27
29
|
|
|
28
30
|
- **Spec interviews** extract decisions upfront so agents execute instead of guessing
|
|
29
|
-
- **
|
|
30
|
-
- **
|
|
31
|
+
- **Per-milestone PRDs** in `.planning/prds/` become execution contracts — spec future milestones in parallel
|
|
32
|
+
- **Wave-based agent teams** execute phases autonomously with built-in verification
|
|
33
|
+
- **Session handoffs** preserve full context across fresh sessions — no more "where was I?"
|
|
31
34
|
- **Lessons compound** — mistakes get captured, refined, and promoted into permanent rules
|
|
32
35
|
|
|
36
|
+
---
|
|
37
|
+
|
|
33
38
|
## How It Works
|
|
34
39
|
|
|
35
40
|
**One-time setup**, then a repeating build cycle:
|
|
@@ -42,44 +47,107 @@ Flow fixes this by giving Claude Code a **memory system and execution framework*
|
|
|
42
47
|
```
|
|
43
48
|
|
|
44
49
|
1. **`/flow:setup`** — Scaffolds your project with planning docs and execution rules
|
|
45
|
-
2. **`/flow:spec`** — Interviews you, then writes an executable PRD
|
|
50
|
+
2. **`/flow:spec`** — Interviews you, then writes an executable PRD with phases, acceptance criteria, and agent-team structure
|
|
46
51
|
3. **`/flow:go`** — Spawns parallel agent teams to build the next phase, verifies, commits
|
|
47
52
|
4. **`/flow:done`** — Updates docs, captures lessons, generates a handoff prompt so the next session starts instantly
|
|
48
53
|
|
|
49
54
|
Run `/flow:go` repeatedly until all phases are done, then `/flow:done` to wrap up. Next session, paste the handoff prompt and keep going.
|
|
50
55
|
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Multi-PRD: Parallel Milestone Planning
|
|
59
|
+
|
|
60
|
+
<table>
|
|
61
|
+
<tr>
|
|
62
|
+
<td width="50%">
|
|
63
|
+
|
|
64
|
+
**Before (single PRD)**
|
|
65
|
+
```
|
|
66
|
+
project/
|
|
67
|
+
└── PRD.md ← one at a time
|
|
68
|
+
```
|
|
69
|
+
Finish or archive the current milestone before speccing the next. Serial bottleneck on large roadmaps.
|
|
70
|
+
|
|
71
|
+
</td>
|
|
72
|
+
<td width="50%">
|
|
73
|
+
|
|
74
|
+
**Now (per-milestone PRDs)**
|
|
75
|
+
```
|
|
76
|
+
.planning/prds/
|
|
77
|
+
├── v1-user-auth.md ← active
|
|
78
|
+
├── v2-dashboard.md ← pre-specced
|
|
79
|
+
└── v3-payments.md ← pre-specced
|
|
80
|
+
```
|
|
81
|
+
Spec any milestone at any time. Execute the current one while planning ahead.
|
|
82
|
+
|
|
83
|
+
</td>
|
|
84
|
+
</tr>
|
|
85
|
+
</table>
|
|
86
|
+
|
|
87
|
+
**How it works:**
|
|
88
|
+
|
|
89
|
+
- `/flow:spec` writes PRDs to `.planning/prds/{version-slug}.md` — one file per milestone
|
|
90
|
+
- `/flow:spec v3: Payments` targets a specific future milestone without changing your current position
|
|
91
|
+
- STATE.md tracks the **Active PRD** field so `/flow:go` always knows which spec to execute
|
|
92
|
+
- Smart resolution: user argument > STATE.md > slug derivation > legacy fallback
|
|
93
|
+
- Existing `PRD.md` at root? Still works — legacy files are consumed transparently and migrated on archive
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
51
97
|
## Commands
|
|
52
98
|
|
|
53
|
-
|
|
99
|
+
### The Build Cycle
|
|
100
|
+
|
|
101
|
+
| Command | When | What it does |
|
|
102
|
+
|---|---|---|
|
|
103
|
+
| `/flow:setup` | Once per project | Creates `.planning/`, CLAUDE.md, templates, full roadmap |
|
|
104
|
+
| `/flow:spec` | Once per milestone | Interview that produces an executable PRD in `.planning/prds/` |
|
|
105
|
+
| `/flow:go` | Once per phase | Executes the next phase with wave-based agent teams |
|
|
106
|
+
| `/flow:done` | End of session | Updates docs, captures lessons, generates handoff prompt |
|
|
107
|
+
|
|
108
|
+
### Standalone
|
|
109
|
+
|
|
110
|
+
| Command | When | What it does |
|
|
111
|
+
|---|---|---|
|
|
112
|
+
| `/flow:task` | Anytime | Bug fixes, cleanup, small features — no PRD needed |
|
|
113
|
+
| `/flow:milestone` | Anytime | Add new milestones to the roadmap |
|
|
114
|
+
|
|
115
|
+
### Utility
|
|
54
116
|
|
|
55
|
-
| Command | When
|
|
56
|
-
|
|
57
|
-
| `/flow:
|
|
58
|
-
| `/flow:
|
|
59
|
-
| `/flow:
|
|
60
|
-
| `/flow:done` | End of session — updates docs, generates handoff prompt |
|
|
117
|
+
| Command | When | What it does |
|
|
118
|
+
|---|---|---|
|
|
119
|
+
| `/flow:intro` | First time | Walkthrough of the entire system |
|
|
120
|
+
| `/flow:status` | Anytime | Where am I? What's next? Shows PRD inventory |
|
|
121
|
+
| `/flow:update` | Anytime | Update Flow to the latest version |
|
|
61
122
|
|
|
62
|
-
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Project Structure
|
|
63
126
|
|
|
64
|
-
|
|
65
|
-
|---|---|
|
|
66
|
-
| `/flow:task` | Anytime — bug fixes, cleanup, small features (no PRD needed) |
|
|
67
|
-
| `/flow:milestone` | Anytime — add new milestones to the roadmap |
|
|
127
|
+
Every Flow project gets this structure via `/flow:setup`:
|
|
68
128
|
|
|
69
|
-
|
|
129
|
+
```
|
|
130
|
+
your-project/
|
|
131
|
+
├── CLAUDE.md # Execution rules + learned rules
|
|
132
|
+
├── .planning/
|
|
133
|
+
│ ├── STATE.md # Session GPS — current status, active PRD, next actions
|
|
134
|
+
│ ├── ROADMAP.md # Milestone phases and progress tracking
|
|
135
|
+
│ ├── prds/ # Per-milestone PRD specs
|
|
136
|
+
│ │ ├── v1-user-auth.md # One file per milestone
|
|
137
|
+
│ │ └── v2-dashboard.md # Pre-spec future milestones anytime
|
|
138
|
+
│ └── archive/ # Completed milestones and archived PRDs
|
|
139
|
+
└── tasks/
|
|
140
|
+
└── lessons.md # Active lessons (max 10) → promoted to CLAUDE.md
|
|
141
|
+
```
|
|
70
142
|
|
|
71
|
-
|
|
72
|
-
|---|---|
|
|
73
|
-
| `/flow:intro` | First time — walkthrough of the system |
|
|
74
|
-
| `/flow:status` | Anytime — where am I? What's next? |
|
|
75
|
-
| `/flow:update` | Anytime — update Flow to the latest version |
|
|
143
|
+
---
|
|
76
144
|
|
|
77
145
|
## What Gets Installed
|
|
78
146
|
|
|
79
147
|
```
|
|
80
148
|
~/.claude/
|
|
81
149
|
├── commands/flow/
|
|
82
|
-
│ ├── flow-setup.md
|
|
150
|
+
│ ├── flow-setup.md # 9 skill files
|
|
83
151
|
│ ├── flow-milestone.md
|
|
84
152
|
│ ├── flow-spec.md
|
|
85
153
|
│ ├── flow-go.md
|
|
@@ -89,32 +157,18 @@ Run `/flow:go` repeatedly until all phases are done, then `/flow:done` to wrap u
|
|
|
89
157
|
│ ├── flow-intro.md
|
|
90
158
|
│ ├── flow-update.md
|
|
91
159
|
│ ├── VERSION
|
|
92
|
-
│ └── templates/
|
|
160
|
+
│ └── templates/ # Project scaffolding templates
|
|
93
161
|
│ ├── CLAUDE.md.template
|
|
94
162
|
│ ├── STATE.md.template
|
|
95
163
|
│ ├── ROADMAP.md.template
|
|
96
164
|
│ └── lessons.md.template
|
|
97
165
|
├── hooks/
|
|
98
|
-
│ ├── flow-check-update.js
|
|
99
|
-
│ └── flow-statusline.js
|
|
100
|
-
└── settings.json
|
|
166
|
+
│ ├── flow-check-update.js # Notifies when updates are available
|
|
167
|
+
│ └── flow-statusline.js # Shows project context in statusLine
|
|
168
|
+
└── settings.json # statusLine configured automatically
|
|
101
169
|
```
|
|
102
170
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
Every Flow project gets this structure via `/flow:setup`:
|
|
106
|
-
|
|
107
|
-
```
|
|
108
|
-
your-project/
|
|
109
|
-
├── CLAUDE.md # Project-specific execution rules
|
|
110
|
-
├── .planning/
|
|
111
|
-
│ ├── STATE.md # Session GPS — current status, next actions
|
|
112
|
-
│ ├── ROADMAP.md # Milestone phases and progress
|
|
113
|
-
│ ├── prds/ # Per-milestone PRD specs (one file per milestone)
|
|
114
|
-
│ └── archive/ # Completed milestones and old PRDs
|
|
115
|
-
└── tasks/
|
|
116
|
-
└── lessons.md # Active lessons (max 10 one-liners) → promoted to CLAUDE.md
|
|
117
|
-
```
|
|
171
|
+
---
|
|
118
172
|
|
|
119
173
|
## The Lessons System
|
|
120
174
|
|
|
@@ -125,9 +179,13 @@ Flow's knowledge compounding is what makes it get better over time:
|
|
|
125
179
|
|
|
126
180
|
Hard caps prevent context bloat. Total worst-case: ~30 lines of lessons context per session.
|
|
127
181
|
|
|
182
|
+
---
|
|
183
|
+
|
|
128
184
|
## Compatible With GSD
|
|
129
185
|
|
|
130
|
-
Flow uses the same `.planning/` directory structure as [GSD](https://github.com/gsd-framework/gsd). You can use `/gsd:debug`, `/gsd:map-codebase`, and other GSD commands alongside Flow.
|
|
186
|
+
Flow uses the same `.planning/` directory structure as [GSD](https://github.com/gsd-framework/gsd). You can use `/gsd:debug`, `/gsd:map-codebase`, and other GSD commands alongside Flow without conflict.
|
|
187
|
+
|
|
188
|
+
---
|
|
131
189
|
|
|
132
190
|
## Requirements
|
|
133
191
|
|
package/package.json
CHANGED
package/skills/flow-spec.md
CHANGED
|
@@ -43,7 +43,7 @@ Before starting the interview, determine which milestone this PRD targets:
|
|
|
43
43
|
|
|
44
44
|
1. **If the user passed an argument** (e.g., `/flow:spec v3: Payments`) — match against ROADMAP.md milestones. If no match, print available milestones and ask which one.
|
|
45
45
|
|
|
46
|
-
2. **If no argument** —
|
|
46
|
+
2. **If no argument** — read ROADMAP.md and list all incomplete milestones. Use AskUserQuestion to let the user pick which milestone to spec. Pre-select the next unspecced milestone as the first option. Always show the picker, even if only one milestone is listed — the user may want to confirm or choose "Other" to define a new milestone first.
|
|
47
47
|
|
|
48
48
|
3. **Derive the PRD slug:** Take the milestone's version prefix and name (e.g., "v3: Dashboard Analytics"), lowercase it, replace spaces and special characters with hyphens, collapse consecutive hyphens. Result: `v3-dashboard-analytics`. The PRD path is `.planning/prds/{slug}.md`.
|
|
49
49
|
|
package/skills/flow-status.md
CHANGED
|
@@ -44,7 +44,7 @@ Use this explicit decision tree:
|
|
|
44
44
|
→ Alt: `/flow:task` for quick fixes or cleanup (no PRD needed)
|
|
45
45
|
|
|
46
46
|
**IF pending phases exist in ROADMAP BUT no PRD exists for the current milestone:**
|
|
47
|
-
→ Primary: `/flow:spec` to create the execution plan
|
|
47
|
+
→ Primary: `/flow:spec [next milestone name]` to create the execution plan
|
|
48
48
|
→ Alt: `/flow:task` for quick fixes or cleanup (no PRD needed)
|
|
49
49
|
|
|
50
50
|
**IF all phases are complete AND a next milestone with status "Planned" exists in ROADMAP.md:**
|
|
@@ -57,9 +57,11 @@ Use this explicit decision tree:
|
|
|
57
57
|
→ Alt: `/flow:task` for quick fixes or cleanup (no PRD needed)
|
|
58
58
|
|
|
59
59
|
**IF no phases exist in ROADMAP (milestone defined but not planned):**
|
|
60
|
-
→ Primary: `/flow:spec` to plan this milestone
|
|
60
|
+
→ Primary: `/flow:spec [milestone name]` to plan this milestone
|
|
61
61
|
→ Alt: `/flow:task` for quick fixes or cleanup (no PRD needed)
|
|
62
62
|
|
|
63
|
+
**When suggesting `/flow:spec`:** Always include the target milestone name in the suggestion (e.g., `→ /flow:spec v16.0: Conventional Leasing & Email Export`). This lets the user see which milestone will be specced before running the command, and passes the name as an argument so flow:spec can match it directly.
|
|
64
|
+
|
|
63
65
|
## Step 4 — Print Status Block
|
|
64
66
|
|
|
65
67
|
```
|