planflow-ai 1.1.7 → 1.1.8
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 +113 -56
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Works with **Claude Code**, **Cursor**, **OpenClaw**, and **Codex CLI**.
|
|
|
7
7
|
## Quick Start
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npx
|
|
10
|
+
npx planflow-ai init
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
This interactive command installs plan-flow into your project for your chosen platform(s).
|
|
@@ -17,7 +17,7 @@ This interactive command installs plan-flow into your project for your chosen pl
|
|
|
17
17
|
### Claude Code
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
npx
|
|
20
|
+
npx planflow-ai init --claude
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
Installs slash commands (`.claude/commands/`), core rules (`.claude/rules/`), and reference docs (`.claude/resources/`) into your project. Creates or updates your `CLAUDE.md` with plan-flow instructions.
|
|
@@ -25,15 +25,15 @@ Installs slash commands (`.claude/commands/`), core rules (`.claude/rules/`), an
|
|
|
25
25
|
### Cursor
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
npx
|
|
28
|
+
npx planflow-ai init --cursor
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Copies Cursor-compatible
|
|
31
|
+
Copies Cursor-compatible commands (`.cursor/commands/`) into your project.
|
|
32
32
|
|
|
33
33
|
### OpenClaw
|
|
34
34
|
|
|
35
35
|
```bash
|
|
36
|
-
npx
|
|
36
|
+
npx planflow-ai init --openclaw
|
|
37
37
|
```
|
|
38
38
|
|
|
39
39
|
Copies skill manifests to `skills/plan-flow/` in your project.
|
|
@@ -41,7 +41,7 @@ Copies skill manifests to `skills/plan-flow/` in your project.
|
|
|
41
41
|
### Codex CLI
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
npx
|
|
44
|
+
npx planflow-ai init --codex
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
Copies skills to `.agents/skills/plan-flow/` and creates or updates your `AGENTS.md` with plan-flow instructions.
|
|
@@ -49,7 +49,7 @@ Copies skills to `.agents/skills/plan-flow/` and creates or updates your `AGENTS
|
|
|
49
49
|
### All Platforms
|
|
50
50
|
|
|
51
51
|
```bash
|
|
52
|
-
npx
|
|
52
|
+
npx planflow-ai init --all
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
Installs for Claude Code, Cursor, OpenClaw, and Codex CLI simultaneously.
|
|
@@ -66,28 +66,6 @@ Installs for Claude Code, Cursor, OpenClaw, and Codex CLI simultaneously.
|
|
|
66
66
|
| `--force` | Overwrite existing files |
|
|
67
67
|
| `--target <dir>` | Target directory (defaults to current) |
|
|
68
68
|
|
|
69
|
-
## Manual Installation
|
|
70
|
-
|
|
71
|
-
### Claude Code (Manual)
|
|
72
|
-
|
|
73
|
-
1. Copy `.claude/commands/*.md` to your project's `.claude/commands/`
|
|
74
|
-
2. Copy `.claude/rules/` to your project's `.claude/rules/`
|
|
75
|
-
3. Copy `.claude/resources/` to your project's `.claude/resources/`
|
|
76
|
-
4. Add the plan-flow section from `templates/shared/CLAUDE.md.template` to your `CLAUDE.md`
|
|
77
|
-
|
|
78
|
-
### Cursor (Manual)
|
|
79
|
-
|
|
80
|
-
Copy `rules/` to your project's `rules/`
|
|
81
|
-
|
|
82
|
-
### OpenClaw (Manual)
|
|
83
|
-
|
|
84
|
-
Copy `skills/plan-flow/` to your project's `skills/plan-flow/`
|
|
85
|
-
|
|
86
|
-
### Codex CLI (Manual)
|
|
87
|
-
|
|
88
|
-
1. Copy `skills/plan-flow/` to your project's `.agents/skills/plan-flow/`
|
|
89
|
-
2. Add the plan-flow section from `templates/shared/AGENTS.md.template` to your `AGENTS.md`
|
|
90
|
-
|
|
91
69
|
## Commands
|
|
92
70
|
|
|
93
71
|
| Command | Description |
|
|
@@ -100,7 +78,7 @@ Copy `skills/plan-flow/` to your project's `skills/plan-flow/`
|
|
|
100
78
|
| `/review-code` | Review local uncommitted changes |
|
|
101
79
|
| `/review-pr` | Review a Pull Request |
|
|
102
80
|
| `/write-tests` | Generate tests for coverage target |
|
|
103
|
-
| `/flow` |
|
|
81
|
+
| `/flow` | Configure plan-flow settings (autopilot, git control, runtime options) |
|
|
104
82
|
| `/brain` | Capture meeting notes, ideas, brainstorms |
|
|
105
83
|
| `/learn` | Extract reusable patterns or learn a topic step-by-step |
|
|
106
84
|
| `/pattern-validate` | Scan and index global brain patterns |
|
|
@@ -120,7 +98,7 @@ Copy `skills/plan-flow/` to your project's `skills/plan-flow/`
|
|
|
120
98
|
|
|
121
99
|
### Autopilot Mode
|
|
122
100
|
|
|
123
|
-
Enable autopilot with `/flow
|
|
101
|
+
Enable autopilot with `/flow autopilot=true` and the full workflow runs automatically for feature requests:
|
|
124
102
|
|
|
125
103
|
```
|
|
126
104
|
You: "Add dark mode support"
|
|
@@ -135,17 +113,101 @@ You: "Add dark mode support"
|
|
|
135
113
|
|
|
136
114
|
Autopilot classifies every input and only triggers the full flow for feature requests (complexity 3+). Questions, trivial tasks, and slash commands are handled normally.
|
|
137
115
|
|
|
138
|
-
| Usage | Description |
|
|
139
|
-
|-------|-------------|
|
|
140
|
-
| `/flow -enable` | Enable autopilot mode |
|
|
141
|
-
| `/flow -disable` | Disable autopilot mode |
|
|
142
|
-
| `/flow -status` | Check current state |
|
|
143
|
-
|
|
144
116
|
**Mandatory checkpoints** — even in autopilot, the flow always pauses for:
|
|
145
117
|
- **Discovery Q&A**: You answer requirements questions
|
|
146
118
|
- **Plan approval**: You review and approve the plan before execution
|
|
147
119
|
|
|
148
|
-
|
|
120
|
+
## Flow Configuration (`/flow`)
|
|
121
|
+
|
|
122
|
+
The `/flow` command is the central configuration hub. All settings use `key=value` syntax and persist in `flow/.flowconfig` (YAML).
|
|
123
|
+
|
|
124
|
+
| Setting | Values | Default | Description |
|
|
125
|
+
|---------|--------|---------|-------------|
|
|
126
|
+
| `autopilot` | `true/false` | `false` | Enable/disable autopilot mode |
|
|
127
|
+
| `commit` | `true/false` | `false` | Auto-commit after each completed phase |
|
|
128
|
+
| `push` | `true/false` | `false` | Auto-push after all phases + build/test pass |
|
|
129
|
+
| `branch` | any string | current branch | Target branch for git operations |
|
|
130
|
+
|
|
131
|
+
### Examples
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
/flow autopilot=true # Enable autopilot
|
|
135
|
+
/flow commit=true push=true # Enable git control (works without autopilot)
|
|
136
|
+
/flow autopilot=true commit=true # Enable both
|
|
137
|
+
/flow branch=development # Set target branch
|
|
138
|
+
/flow -status # Show current config
|
|
139
|
+
/flow -reset # Reset everything
|
|
140
|
+
|
|
141
|
+
# Shorthand: text without key=value enables autopilot and starts flow
|
|
142
|
+
/flow add dark mode support # autopilot=true + start discovery
|
|
143
|
+
/flow commit=true add user auth # autopilot=true + git + start discovery
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Git Control
|
|
147
|
+
|
|
148
|
+
When `commit=true`, plan-flow auto-commits after each completed execution phase:
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
Phase 1: Setup types → git commit "Phase 1: Setup types — user-auth"
|
|
152
|
+
Phase 2: API endpoints → git commit "Phase 2: API endpoints — user-auth"
|
|
153
|
+
Phase 3: Tests → git commit "Phase 3: Tests — user-auth"
|
|
154
|
+
Build + Test pass → git commit "Complete: user-auth — all phases done"
|
|
155
|
+
→ git push origin development (if push=true)
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Git control works independently of autopilot — you can use `commit=true` with manual `/execute-plan` runs.
|
|
159
|
+
|
|
160
|
+
## Project Tasklist
|
|
161
|
+
|
|
162
|
+
Each project has a `flow/tasklist.md` that tracks work items across sessions. On session start, active tasks are summarized and you can pick one to work on.
|
|
163
|
+
|
|
164
|
+
Every command automatically updates the tasklist:
|
|
165
|
+
- On start: adds the task to **In Progress**
|
|
166
|
+
- On complete: moves it to **Done** with the date
|
|
167
|
+
- Next step: adds the logical follow-up to **To Do**
|
|
168
|
+
|
|
169
|
+
### Scheduled Tasks
|
|
170
|
+
|
|
171
|
+
Tasks can be scheduled for later execution by linking them to the heartbeat daemon:
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
/flow add to tasklist: implement feature X and execute in 1 hour
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
This creates a tasklist entry linked to a heartbeat one-shot task via `[[]]` references. Both files cross-reference each other for Obsidian navigation.
|
|
178
|
+
|
|
179
|
+
## Heartbeat (Scheduled Automation)
|
|
180
|
+
|
|
181
|
+
The heartbeat daemon is a background process that executes scheduled tasks defined in `flow/heartbeat.md`.
|
|
182
|
+
|
|
183
|
+
### Schedule Syntax
|
|
184
|
+
|
|
185
|
+
| Syntax | Example |
|
|
186
|
+
|--------|---------|
|
|
187
|
+
| `daily at {HH:MM AM/PM}` | `daily at 10:00 PM` |
|
|
188
|
+
| `every {N} hours` | `every 6 hours` |
|
|
189
|
+
| `every {N} minutes` | `every 30 minutes` |
|
|
190
|
+
| `weekly on {day} at {HH:MM}` | `weekly on Monday at 9:00 AM` |
|
|
191
|
+
| `in {N} hours` | `in 2 hours` (one-shot) |
|
|
192
|
+
| `in {N} minutes` | `in 30 minutes` (one-shot) |
|
|
193
|
+
|
|
194
|
+
### Daemon Management
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
npx planflow-ai heartbeat start # Start the daemon
|
|
198
|
+
npx planflow-ai heartbeat stop # Stop the daemon
|
|
199
|
+
npx planflow-ai heartbeat status # Show daemon status
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
The daemon **auto-starts** during `planflow-ai init` if `flow/heartbeat.md` exists.
|
|
203
|
+
|
|
204
|
+
### One-Shot Tasks
|
|
205
|
+
|
|
206
|
+
Tasks with `in {N} hours/minutes` schedules run once and auto-disable after execution. These are used for scheduled tasklist items.
|
|
207
|
+
|
|
208
|
+
### Retry on Active Session
|
|
209
|
+
|
|
210
|
+
If a task fails because a Claude Code session is already active, the daemon retries up to 5 times at 60-second intervals instead of failing permanently.
|
|
149
211
|
|
|
150
212
|
## Complexity Scoring
|
|
151
213
|
|
|
@@ -177,11 +239,13 @@ flow/
|
|
|
177
239
|
├── resources/ # Valuable artifacts captured during skill execution
|
|
178
240
|
├── reviewed-code/ # Code review documents
|
|
179
241
|
├── reviewed-pr/ # PR review documents
|
|
180
|
-
├── tasklist.md # Project task list (
|
|
242
|
+
├── tasklist.md # Project task list (updated in real-time during execution)
|
|
181
243
|
├── memory.md # Persistent artifact tracker (completed work)
|
|
182
244
|
├── heartbeat.md # Scheduled task definitions for the heartbeat daemon
|
|
183
245
|
├── log.md # Heartbeat event log
|
|
184
|
-
|
|
246
|
+
├── ledger.md # Persistent project learning journal
|
|
247
|
+
├── .flowconfig # Central config file (autopilot, git control, settings)
|
|
248
|
+
└── .gitcontrol # Git control settings (backward compat)
|
|
185
249
|
```
|
|
186
250
|
|
|
187
251
|
## Session Start Behaviors
|
|
@@ -192,30 +256,23 @@ When a session starts, plan-flow automatically loads context from your project:
|
|
|
192
256
|
- **Memory** (`flow/memory.md`) — Loads the last 7 days of completed work so context is never lost
|
|
193
257
|
- **Brain** (`flow/brain/index.md`) — Internalizes active features and recent error patterns
|
|
194
258
|
- **Ledger** (`flow/ledger.md`) — Internalizes project-specific lessons learned
|
|
259
|
+
- **Autopilot** (`flow/.flowconfig`) — If `autopilot: true`, activates automatic workflow orchestration
|
|
195
260
|
|
|
196
261
|
## Intelligent Learn Skill
|
|
197
262
|
|
|
198
263
|
The `/learn` skill supports step-by-step teaching. When you run `/learn about <topic>`, it creates a structured curriculum stored as a brain `.md` file. Each step requires your confirmation before progressing, and confirmed steps become learned patterns.
|
|
199
264
|
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
265
|
+
Commands also recommend `/learn` automatically when:
|
|
266
|
+
- New dependencies are added during execution
|
|
267
|
+
- Non-trivial errors are resolved (3+ attempts)
|
|
268
|
+
- The user corrects the approach
|
|
269
|
+
- A new technology or pattern is introduced
|
|
203
270
|
|
|
204
|
-
##
|
|
271
|
+
## Central Obsidian Vault
|
|
205
272
|
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
## Heartbeat (Scheduled Automation)
|
|
209
|
-
|
|
210
|
-
The `flow/heartbeat.md` file works as a cronjob system. Define scheduled tasks and the heartbeat daemon will execute them automatically:
|
|
211
|
-
|
|
212
|
-
```
|
|
213
|
-
do
|
|
214
|
-
daily at 10:00 PM - research about topic X, create md files and add to brain
|
|
215
|
-
daily at 11:00 AM - using flow --enabled, create feature Y, execute, and push to repo
|
|
216
|
-
```
|
|
273
|
+
All projects are linked into a central Obsidian vault at `~/plan-flow/brain/`. Each `planflow-ai init` creates a project directory in the vault with symlinks for brain subdirectories and the tasklist. A global tasklist at `~/plan-flow/brain/tasklist.md` aggregates task counts across all projects.
|
|
217
274
|
|
|
218
|
-
|
|
275
|
+
Open `~/plan-flow/brain/` as an Obsidian vault to browse all projects in one graph.
|
|
219
276
|
|
|
220
277
|
## Requirements
|
|
221
278
|
|
package/package.json
CHANGED