flow-cc 0.1.0 → 0.1.1
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 +101 -41
- package/VERSION +1 -1
- package/bin/install.js +1 -1
- package/package.json +22 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Troy Hoffman
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,66 +1,126 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<h1 align="center">Flow</h1>
|
|
3
|
+
<p align="center">A structured workflow system for Claude Code.<br/>Spec interviews. Agent-team execution. Session handoffs. Compounding knowledge.</p>
|
|
4
|
+
</p>
|
|
2
5
|
|
|
3
|
-
|
|
6
|
+
<p align="center">
|
|
7
|
+
<a href="https://www.npmjs.com/package/flow-cc"><img src="https://img.shields.io/npm/v/flow-cc.svg" alt="npm version"></a>
|
|
8
|
+
<a href="https://github.com/troyhoffman-oss/flow-plugin/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/flow-cc.svg" alt="license"></a>
|
|
9
|
+
<a href="https://www.npmjs.com/package/flow-cc"><img src="https://img.shields.io/npm/dm/flow-cc.svg" alt="downloads"></a>
|
|
10
|
+
</p>
|
|
4
11
|
|
|
5
|
-
|
|
12
|
+
---
|
|
6
13
|
|
|
7
|
-
|
|
8
|
-
- `/flow:init` -- Initialize a new project or milestone with planning scaffolding
|
|
9
|
-
- `/flow:spec` -- Run a spec interview that produces an executable PRD with wave-based phases
|
|
10
|
-
- `/flow:task` -- Lightweight task execution — bug fixes, cleanup, small features without a PRD
|
|
11
|
-
- `/flow:go` -- Execute the next phase from the PRD using agent teams
|
|
12
|
-
- `/flow:done` -- Session-end docs, lessons refinement, and handoff prompt generation
|
|
13
|
-
- `/flow:status` -- Quick "where am I?" orientation
|
|
14
|
-
- `/flow:update` -- Pull latest and re-install skills from any session
|
|
15
|
-
|
|
16
|
-
## Installation
|
|
14
|
+
## Install
|
|
17
15
|
|
|
18
16
|
```bash
|
|
19
|
-
|
|
20
|
-
git clone https://github.com/troyhoffman/flow-plugin.git && cd flow-plugin && bash setup.sh
|
|
21
|
-
|
|
22
|
-
# Windows (PowerShell)
|
|
23
|
-
git clone https://github.com/troyhoffman/flow-plugin.git; cd flow-plugin; .\setup.ps1
|
|
17
|
+
npx flow-cc
|
|
24
18
|
```
|
|
25
19
|
|
|
26
|
-
|
|
20
|
+
One command. Installs skills, hooks, templates, and configures your statusLine. Works on Mac, Linux, and Windows.
|
|
21
|
+
|
|
22
|
+
## Why Flow?
|
|
23
|
+
|
|
24
|
+
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
|
+
|
|
26
|
+
Flow fixes this by giving Claude Code a **memory system and execution framework**:
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
- **Spec interviews** extract decisions upfront so agents execute instead of guessing
|
|
29
|
+
- **PRDs become execution contracts** that agent teams follow phase-by-phase
|
|
30
|
+
- **Session handoffs** preserve context across fresh sessions — no more "where was I?"
|
|
31
|
+
- **Lessons compound** — mistakes get captured, refined, and promoted into permanent rules
|
|
29
32
|
|
|
30
|
-
|
|
33
|
+
## Commands
|
|
34
|
+
|
|
35
|
+
| Command | What it does |
|
|
36
|
+
|---|---|
|
|
37
|
+
| `/flow:intro` | Walkthrough of the system — **start here** |
|
|
38
|
+
| `/flow:init` | Initialize a project with `.planning/` scaffolding, CLAUDE.md, templates |
|
|
39
|
+
| `/flow:spec` | Spec interview that produces an executable PRD with phased execution plan |
|
|
40
|
+
| `/flow:go` | Execute the next phase from the PRD using wave-based agent teams |
|
|
41
|
+
| `/flow:task` | Bug fixes, cleanup, small features — no PRD needed |
|
|
42
|
+
| `/flow:done` | Session-end documentation, lessons refinement, handoff prompt |
|
|
43
|
+
| `/flow:status` | Quick orientation — current milestone, phase progress, next actions |
|
|
44
|
+
| `/flow:update` | Update Flow to the latest version |
|
|
31
45
|
|
|
32
46
|
## How It Works
|
|
33
47
|
|
|
34
|
-
|
|
48
|
+
```
|
|
49
|
+
/flow:init → /flow:spec → /flow:go (repeat per phase) → /flow:done
|
|
50
|
+
↓
|
|
51
|
+
handoff prompt for next session
|
|
52
|
+
|
|
53
|
+
/flow:task ← standalone path for bug fixes and small features
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**The lifecycle in practice:**
|
|
35
57
|
|
|
36
|
-
1.
|
|
37
|
-
2.
|
|
38
|
-
3.
|
|
39
|
-
4.
|
|
40
|
-
5.
|
|
41
|
-
6. `/flow:status` -- Read-only orientation check
|
|
58
|
+
1. **`/flow:init`** — Creates `.planning/` directory, CLAUDE.md, STATE.md, ROADMAP.md, lessons.md
|
|
59
|
+
2. **`/flow:spec`** — Interviews you about the milestone. Produces a PRD with wave-based phases, acceptance criteria, and agent-team structure
|
|
60
|
+
3. **`/flow:go`** — Reads the PRD, spawns parallel agent teams per wave, builds, verifies, commits
|
|
61
|
+
4. **`/flow:done`** — Updates all planning docs, captures lessons, generates a one-line handoff prompt so the next session starts instantly
|
|
62
|
+
5. **Repeat** — Next session picks up from the handoff. Context lives in the repo, not the conversation.
|
|
42
63
|
|
|
43
|
-
##
|
|
64
|
+
## What Gets Installed
|
|
44
65
|
|
|
45
66
|
```
|
|
46
|
-
/
|
|
47
|
-
|
|
48
|
-
|
|
67
|
+
~/.claude/
|
|
68
|
+
├── commands/flow/
|
|
69
|
+
│ ├── flow-init.md # 8 skill files
|
|
70
|
+
│ ├── flow-spec.md
|
|
71
|
+
│ ├── flow-go.md
|
|
72
|
+
│ ├── flow-task.md
|
|
73
|
+
│ ├── flow-done.md
|
|
74
|
+
│ ├── flow-status.md
|
|
75
|
+
│ ├── flow-intro.md
|
|
76
|
+
│ ├── flow-update.md
|
|
77
|
+
│ ├── VERSION
|
|
78
|
+
│ └── templates/ # Project scaffolding templates
|
|
79
|
+
│ ├── CLAUDE.md.template
|
|
80
|
+
│ ├── STATE.md.template
|
|
81
|
+
│ ├── ROADMAP.md.template
|
|
82
|
+
│ └── lessons.md.template
|
|
83
|
+
├── hooks/
|
|
84
|
+
│ ├── flow-check-update.js # Notifies when updates are available
|
|
85
|
+
│ └── flow-statusline.js # Shows project context in statusLine
|
|
86
|
+
└── settings.json # statusLine configured automatically
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Project Structure
|
|
49
90
|
|
|
50
|
-
|
|
91
|
+
Every Flow project gets this structure via `/flow:init`:
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
your-project/
|
|
95
|
+
├── CLAUDE.md # Project-specific execution rules
|
|
96
|
+
├── PRD.md # Current milestone spec (created by /flow:spec)
|
|
97
|
+
├── .planning/
|
|
98
|
+
│ ├── STATE.md # Session GPS — current status, next actions
|
|
99
|
+
│ ├── ROADMAP.md # Milestone phases and progress
|
|
100
|
+
│ └── archive/ # Completed milestones and old PRDs
|
|
101
|
+
└── tasks/
|
|
102
|
+
└── lessons.md # Mistake catalog → refined into permanent rules
|
|
51
103
|
```
|
|
52
104
|
|
|
53
|
-
##
|
|
105
|
+
## The Lessons System
|
|
54
106
|
|
|
55
|
-
|
|
107
|
+
Flow's knowledge compounding is what makes it get better over time:
|
|
56
108
|
|
|
57
|
-
|
|
109
|
+
1. **Capture** — Mistake happens, lesson written to `tasks/lessons.md`
|
|
110
|
+
2. **Refine** — Each `/flow:done` merges duplicates, sharpens rules, removes obvious ones
|
|
111
|
+
3. **Promote** — Universal lessons move to `~/.claude/lessons.md` (all projects)
|
|
112
|
+
4. **Permanence** — Recurring patterns become rules in `CLAUDE.md`
|
|
58
113
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
114
|
+
The goal: fewer, sharper lessons over time — not an ever-growing list.
|
|
115
|
+
|
|
116
|
+
## Compatible With GSD
|
|
117
|
+
|
|
118
|
+
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.
|
|
63
119
|
|
|
64
120
|
## Requirements
|
|
65
121
|
|
|
66
|
-
Claude Code CLI with skills support.
|
|
122
|
+
[Claude Code](https://docs.anthropic.com/en/docs/claude-code) CLI with skills support.
|
|
123
|
+
|
|
124
|
+
## License
|
|
125
|
+
|
|
126
|
+
MIT
|
package/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.1.
|
|
1
|
+
0.1.1
|
package/bin/install.js
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,27 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "flow-cc",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "Structured workflow system for Claude Code — spec interviews, agent-team execution, session handoffs, compounding knowledge",
|
|
5
|
+
"author": "Troy Hoffman",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/troyhoffman-oss/flow-plugin.git"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://github.com/troyhoffman-oss/flow-plugin",
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/troyhoffman-oss/flow-plugin/issues"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"claude-code",
|
|
17
|
+
"claude",
|
|
18
|
+
"workflow",
|
|
19
|
+
"ai-agents",
|
|
20
|
+
"developer-tools",
|
|
21
|
+
"cli",
|
|
22
|
+
"skills",
|
|
23
|
+
"anthropic"
|
|
24
|
+
],
|
|
5
25
|
"bin": {
|
|
6
26
|
"flow-cc": "bin/install.js"
|
|
7
27
|
},
|