@lumenflow/cli 3.6.4 → 3.6.5
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/package.json +8 -8
- package/templates/core/AGENTS.md.template +21 -0
- package/templates/core/LUMENFLOW.md.template +4 -0
- package/templates/core/ai/onboarding/quick-ref-commands.md.template +12 -5
- package/templates/core/ai/onboarding/starting-prompt.md.template +20 -4
- package/templates/vendors/cursor/.cursor/rules/lumenflow.md.template +25 -0
- package/templates/vendors/windsurf/.windsurf/rules/lumenflow.md.template +25 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lumenflow/cli",
|
|
3
|
-
"version": "3.6.
|
|
3
|
+
"version": "3.6.5",
|
|
4
4
|
"description": "Command-line interface for LumenFlow workflow framework",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"lumenflow",
|
|
@@ -177,13 +177,13 @@
|
|
|
177
177
|
"xstate": "^5.28.0",
|
|
178
178
|
"yaml": "^2.8.2",
|
|
179
179
|
"zod": "^4.3.6",
|
|
180
|
-
"@lumenflow/agent": "3.6.
|
|
181
|
-
"@lumenflow/
|
|
182
|
-
"@lumenflow/
|
|
183
|
-
"@lumenflow/
|
|
184
|
-
"@lumenflow/
|
|
185
|
-
"@lumenflow/
|
|
186
|
-
"@lumenflow/
|
|
180
|
+
"@lumenflow/agent": "3.6.5",
|
|
181
|
+
"@lumenflow/memory": "3.6.5",
|
|
182
|
+
"@lumenflow/initiatives": "3.6.5",
|
|
183
|
+
"@lumenflow/kernel": "3.6.5",
|
|
184
|
+
"@lumenflow/metrics": "3.6.5",
|
|
185
|
+
"@lumenflow/control-plane-sdk": "3.6.5",
|
|
186
|
+
"@lumenflow/core": "3.6.5"
|
|
187
187
|
},
|
|
188
188
|
"devDependencies": {
|
|
189
189
|
"@vitest/coverage-v8": "^4.0.18",
|
|
@@ -33,6 +33,27 @@ This is the single most forgotten step. See [LUMENFLOW.md](LUMENFLOW.md) for det
|
|
|
33
33
|
|
|
34
34
|
---
|
|
35
35
|
|
|
36
|
+
## Essential Commands
|
|
37
|
+
|
|
38
|
+
| Command | Description |
|
|
39
|
+
| ------------------------- | ----------------------------------------------------- |
|
|
40
|
+
| `pnpm wu:create` | Create new WU spec (ID auto-generated) |
|
|
41
|
+
| `pnpm wu:claim` | Claim WU and create worktree (or `--cloud`) |
|
|
42
|
+
| `pnpm wu:prep` | Run gates in worktree, prep for wu:done |
|
|
43
|
+
| `pnpm wu:done` | Complete WU (merge or PR, stamp, cleanup) |
|
|
44
|
+
| `pnpm wu:status` | Show WU status, location, valid commands |
|
|
45
|
+
| `pnpm wu:brief` | Generate handoff prompt + record evidence |
|
|
46
|
+
| `pnpm wu:delegate` | Generate prompt + record delegation lineage |
|
|
47
|
+
| `pnpm wu:recover` | Analyze and fix WU state inconsistencies |
|
|
48
|
+
| `pnpm wu:escalate` | Show or resolve WU escalation status |
|
|
49
|
+
| `pnpm wu:delete` | Delete WU spec and cleanup |
|
|
50
|
+
| `pnpm gates` | Run all quality gates (`--docs-only` for docs) |
|
|
51
|
+
| `pnpm lumenflow:commands` | List all public commands (primary + aliases + legacy) |
|
|
52
|
+
| `pnpm mem:checkpoint` | Save progress checkpoint |
|
|
53
|
+
| `pnpm mem:recover` | Generate recovery context |
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
36
57
|
## Core Principles
|
|
37
58
|
|
|
38
59
|
1. **TDD**: Write tests first, then implementation
|
|
@@ -238,6 +238,10 @@ For the full worktree lifecycle (parallel execution, bootstrap, isolation guaran
|
|
|
238
238
|
| `pnpm wu:block` | Block WU (transitions to blocked, frees lane) |
|
|
239
239
|
| `pnpm wu:unblock` | Unblock WU (transitions to in_progress) |
|
|
240
240
|
| `pnpm wu:release` | Release orphaned WU (in_progress to ready for reclaim) |
|
|
241
|
+
| `pnpm wu:brief` | Generate handoff prompt + record evidence |
|
|
242
|
+
| `pnpm wu:delegate` | Generate prompt + record delegation lineage |
|
|
243
|
+
| `pnpm wu:escalate` | Show or resolve WU escalation status |
|
|
244
|
+
| `pnpm wu:delete` | Delete WU spec and cleanup |
|
|
241
245
|
| `pnpm gates` | Run quality gates (`--docs-only` for docs WUs) |
|
|
242
246
|
| `pnpm lumenflow:commands` | List all public commands (primary + alias + legacy) |
|
|
243
247
|
| `pnpm docs:generate` | Regenerate CLI/config reference docs from source |
|
|
@@ -4,14 +4,19 @@
|
|
|
4
4
|
|
|
5
5
|
Reference for CLI commands. Organized by category for quick discovery.
|
|
6
6
|
|
|
7
|
-
> **Rule (WU-1358, WU-1530):**
|
|
8
|
-
>
|
|
7
|
+
> **Rule (WU-1358, WU-1530, WU-2228):** This document is a quick reference, not the complete list.
|
|
8
|
+
> LumenFlow has 100+ commands. To see ALL available commands:
|
|
9
|
+
>
|
|
10
|
+
> ```bash
|
|
11
|
+
> pnpm lumenflow:commands # List ALL CLI commands — the authoritative source
|
|
12
|
+
> ```
|
|
13
|
+
>
|
|
14
|
+
> Before using any unfamiliar command, run `--help` first:
|
|
9
15
|
>
|
|
10
16
|
> ```bash
|
|
11
|
-
> # Examples
|
|
12
17
|
> pnpm wu:edit --help # See all wu:edit options
|
|
13
|
-
>
|
|
14
|
-
>
|
|
18
|
+
> pnpm wu:delete --help # See wu:delete options
|
|
19
|
+
> pnpm wu:escalate --help # See wu:escalate options
|
|
15
20
|
> ```
|
|
16
21
|
|
|
17
22
|
## Help-First Usage Examples By Category
|
|
@@ -94,6 +99,8 @@ pnpm exec lumenflow --client all # All clients
|
|
|
94
99
|
| `pnpm wu:brief --id WU-XXX --evidence-only` | Record wu:brief evidence only (self-implementation path) |
|
|
95
100
|
| `pnpm wu:brief --id WU-XXX --no-context` | Generate prompt without memory context injection |
|
|
96
101
|
| `pnpm wu:delegate --id WU-XXX --parent-wu <P>` | Generate prompt and record delegation lineage |
|
|
102
|
+
| `pnpm wu:escalate --id WU-XXX` | Show escalation status for a WU |
|
|
103
|
+
| `pnpm wu:escalate --resolve --id WU-XXX` | Resolve escalation (sets resolved_by/resolved_at) |
|
|
97
104
|
|
|
98
105
|
### WU Maintenance
|
|
99
106
|
|
|
@@ -6,7 +6,19 @@ This is the complete onboarding document for AI agents working with LumenFlow. R
|
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
## Mandatory: Help-First CLI Usage
|
|
9
|
+
## Mandatory: Command Discovery and Help-First CLI Usage
|
|
10
|
+
|
|
11
|
+
### Discover Available Commands
|
|
12
|
+
|
|
13
|
+
Before concluding a command doesn't exist, **always check what's available**:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pnpm lumenflow:commands # List ALL available CLI commands (100+)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
LumenFlow has commands for WU lifecycle, maintenance, memory, initiatives, orchestration, metrics, packs, and more. Never guess or assume — run `pnpm lumenflow:commands` first.
|
|
20
|
+
|
|
21
|
+
### Help-First Rule
|
|
10
22
|
|
|
11
23
|
Before using any LumenFlow CLI command for the first time in a session, run `--help` first.
|
|
12
24
|
|
|
@@ -18,9 +30,10 @@ pnpm initiative:status --help
|
|
|
18
30
|
|
|
19
31
|
Rules:
|
|
20
32
|
|
|
21
|
-
1. Run
|
|
22
|
-
2.
|
|
23
|
-
3.
|
|
33
|
+
1. Run `pnpm lumenflow:commands` to discover what commands exist.
|
|
34
|
+
2. Run `<command> --help` before first use of that command.
|
|
35
|
+
3. Copy exact flags from help output; do not guess option names.
|
|
36
|
+
4. If you hit an argument/flag error, rerun `--help` before retrying.
|
|
24
37
|
|
|
25
38
|
Optional Claude Code enforcement layer (recommended for teams):
|
|
26
39
|
|
|
@@ -473,6 +486,9 @@ pnpm wu:delegate --id WU-XXXX --parent-wu WU-YYYY --client <client-type>
|
|
|
473
486
|
| `pnpm gates --docs-only` | Run docs-only gates | For documentation WUs |
|
|
474
487
|
| `pnpm wu:done --id WU-XXX` | Complete WU (merge or PR, cleanup) | After gates pass |
|
|
475
488
|
| `pnpm wu:cleanup --id WU-XXX` | Post-merge cleanup (branch-pr) | After PR merge (cloud only) |
|
|
489
|
+
| `pnpm wu:escalate --id WU-XXX` | Show or resolve escalation status | Escalation-triggered WUs |
|
|
490
|
+
| `pnpm wu:escalate --resolve --id WU-XXX` | Resolve human escalation | Before wu:done (escalation) |
|
|
491
|
+
| `pnpm wu:delete --id WU-XXX` | Delete WU spec and cleanup | Cancel stale/throwaway WUs |
|
|
476
492
|
| `pnpm wu:recover --id WU-XXX` | Fix inconsistent WU state | When state is broken |
|
|
477
493
|
|
|
478
494
|
---
|
|
@@ -32,3 +32,28 @@ pnpm wu:done --id WU-XXX
|
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
> **Complete CLI reference (60+ commands):** See [quick-ref-commands.md](../../ai/onboarding/quick-ref-commands.md)
|
|
35
|
+
|
|
36
|
+
## CLI Commands
|
|
37
|
+
|
|
38
|
+
### WU Lifecycle
|
|
39
|
+
|
|
40
|
+
| Command | Description |
|
|
41
|
+
| ---------------------------------------------- | ------------------------------------------- |
|
|
42
|
+
| `pnpm wu:status --id WU-XXX` | Show WU status, location, valid commands |
|
|
43
|
+
| `pnpm wu:claim --id WU-XXX --lane <Lane>` | Claim WU and create worktree |
|
|
44
|
+
| `pnpm wu:prep --id WU-XXX` | Run gates in worktree |
|
|
45
|
+
| `pnpm wu:done --id WU-XXX` | Complete WU (from main) |
|
|
46
|
+
| `pnpm wu:brief --id WU-XXX --client <client>` | Generate handoff prompt (no execution) |
|
|
47
|
+
| `pnpm wu:delegate --id WU-XXX --parent-wu <P>` | Generate prompt + record delegation lineage |
|
|
48
|
+
| `pnpm wu:recover --id WU-XXX` | Fix WU state inconsistencies |
|
|
49
|
+
| `pnpm wu:escalate --id WU-XXX` | Show or resolve WU escalation status |
|
|
50
|
+
| `pnpm wu:delete --id WU-XXX` | Delete WU spec and cleanup |
|
|
51
|
+
|
|
52
|
+
### Gates & Orchestration
|
|
53
|
+
|
|
54
|
+
| Command | Description |
|
|
55
|
+
| ------------------------------------------ | -------------------------------------------------- |
|
|
56
|
+
| `pnpm gates` | Run all quality gates |
|
|
57
|
+
| `pnpm lumenflow:commands` | List all public commands (primary + alias + legacy) |
|
|
58
|
+
| `pnpm mem:checkpoint --wu WU-XXX` | Save progress checkpoint |
|
|
59
|
+
| `pnpm mem:recover --wu WU-XXX` | Generate recovery context |
|
|
@@ -32,3 +32,28 @@ pnpm wu:done --id WU-XXX
|
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
> **Complete CLI reference (60+ commands):** See [quick-ref-commands.md](../../ai/onboarding/quick-ref-commands.md)
|
|
35
|
+
|
|
36
|
+
## CLI Commands
|
|
37
|
+
|
|
38
|
+
### WU Lifecycle
|
|
39
|
+
|
|
40
|
+
| Command | Description |
|
|
41
|
+
| ---------------------------------------------- | ------------------------------------------- |
|
|
42
|
+
| `pnpm wu:status --id WU-XXX` | Show WU status, location, valid commands |
|
|
43
|
+
| `pnpm wu:claim --id WU-XXX --lane <Lane>` | Claim WU and create worktree |
|
|
44
|
+
| `pnpm wu:prep --id WU-XXX` | Run gates in worktree |
|
|
45
|
+
| `pnpm wu:done --id WU-XXX` | Complete WU (from main) |
|
|
46
|
+
| `pnpm wu:brief --id WU-XXX --client <client>` | Generate handoff prompt (no execution) |
|
|
47
|
+
| `pnpm wu:delegate --id WU-XXX --parent-wu <P>` | Generate prompt + record delegation lineage |
|
|
48
|
+
| `pnpm wu:recover --id WU-XXX` | Fix WU state inconsistencies |
|
|
49
|
+
| `pnpm wu:escalate --id WU-XXX` | Show or resolve WU escalation status |
|
|
50
|
+
| `pnpm wu:delete --id WU-XXX` | Delete WU spec and cleanup |
|
|
51
|
+
|
|
52
|
+
### Gates & Orchestration
|
|
53
|
+
|
|
54
|
+
| Command | Description |
|
|
55
|
+
| ------------------------------------------ | -------------------------------------------------- |
|
|
56
|
+
| `pnpm gates` | Run all quality gates |
|
|
57
|
+
| `pnpm lumenflow:commands` | List all public commands (primary + alias + legacy) |
|
|
58
|
+
| `pnpm mem:checkpoint --wu WU-XXX` | Save progress checkpoint |
|
|
59
|
+
| `pnpm mem:recover --wu WU-XXX` | Generate recovery context |
|