@sienklogic/plan-build-run 2.22.0 → 2.22.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/CHANGELOG.md +14 -0
- package/package.json +1 -1
- package/plugins/copilot-pbr/hooks/hooks.json +0 -12
- package/plugins/copilot-pbr/plugin.json +1 -1
- package/plugins/copilot-pbr/skills/begin/SKILL.md +2 -41
- package/plugins/copilot-pbr/skills/build/SKILL.md +4 -84
- package/plugins/copilot-pbr/skills/config/SKILL.md +1 -1
- package/plugins/copilot-pbr/skills/continue/SKILL.md +1 -1
- package/plugins/copilot-pbr/skills/help/SKILL.md +30 -0
- package/plugins/copilot-pbr/skills/milestone/SKILL.md +1 -1
- package/plugins/copilot-pbr/skills/quick/SKILL.md +4 -1
- package/plugins/copilot-pbr/skills/review/SKILL.md +4 -96
- package/plugins/copilot-pbr/skills/setup/SKILL.md +17 -6
- package/plugins/cursor-pbr/.cursor-plugin/plugin.json +1 -1
- package/plugins/cursor-pbr/hooks/hooks.json +0 -10
- package/plugins/cursor-pbr/skills/begin/SKILL.md +2 -41
- package/plugins/cursor-pbr/skills/build/SKILL.md +4 -84
- package/plugins/cursor-pbr/skills/config/SKILL.md +1 -1
- package/plugins/cursor-pbr/skills/continue/SKILL.md +1 -1
- package/plugins/cursor-pbr/skills/help/SKILL.md +30 -0
- package/plugins/cursor-pbr/skills/milestone/SKILL.md +1 -1
- package/plugins/cursor-pbr/skills/quick/SKILL.md +4 -1
- package/plugins/cursor-pbr/skills/review/SKILL.md +4 -96
- package/plugins/cursor-pbr/skills/setup/SKILL.md +17 -6
- package/plugins/pbr/.claude-plugin/plugin.json +1 -1
- package/plugins/pbr/hooks/hooks.json +0 -10
- package/plugins/pbr/scripts/check-cross-plugin-sync.js +1 -1
- package/plugins/pbr/scripts/check-phase-boundary.js +2 -2
- package/plugins/pbr/scripts/check-roadmap-sync.js +1 -1
- package/plugins/pbr/scripts/check-subagent-output.js +1 -1
- package/plugins/pbr/scripts/log-tool-failure.js +1 -1
- package/plugins/pbr/scripts/post-write-dispatch.js +8 -0
- package/plugins/pbr/scripts/pre-bash-dispatch.js +2 -2
- package/plugins/pbr/scripts/validate-task.js +1 -1
- package/plugins/pbr/skills/begin/SKILL.md +2 -44
- package/plugins/pbr/skills/build/SKILL.md +4 -99
- package/plugins/pbr/skills/config/SKILL.md +1 -1
- package/plugins/pbr/skills/continue/SKILL.md +1 -1
- package/plugins/pbr/skills/help/SKILL.md +30 -0
- package/plugins/pbr/skills/milestone/SKILL.md +1 -1
- package/plugins/pbr/skills/quick/SKILL.md +4 -1
- package/plugins/pbr/skills/review/SKILL.md +4 -102
- package/plugins/pbr/skills/setup/SKILL.md +17 -6
- package/plugins/copilot-pbr/references/agent-interactions.md +0 -135
- package/plugins/copilot-pbr/references/planning-config.md +0 -214
- package/plugins/copilot-pbr/references/subagent-coordination.md +0 -120
- package/plugins/copilot-pbr/skills/shared/error-recovery-strategies.md +0 -51
- package/plugins/copilot-pbr/skills/shared/error-reporting.md +0 -81
- package/plugins/copilot-pbr/skills/shared/progress-display.md +0 -53
- package/plugins/copilot-pbr/skills/shared/state-loading.md +0 -63
- package/plugins/cursor-pbr/references/agent-interactions.md +0 -135
- package/plugins/cursor-pbr/references/planning-config.md +0 -214
- package/plugins/cursor-pbr/references/subagent-coordination.md +0 -120
- package/plugins/cursor-pbr/skills/shared/error-recovery-strategies.md +0 -51
- package/plugins/cursor-pbr/skills/shared/error-reporting.md +0 -81
- package/plugins/cursor-pbr/skills/shared/progress-display.md +0 -53
- package/plugins/cursor-pbr/skills/shared/state-loading.md +0 -63
- package/plugins/pbr/references/agent-interactions.md +0 -134
- package/plugins/pbr/references/planning-config.md +0 -213
- package/plugins/pbr/references/subagent-coordination.md +0 -119
- package/plugins/pbr/skills/shared/error-recovery-strategies.md +0 -51
- package/plugins/pbr/skills/shared/error-reporting.md +0 -81
- package/plugins/pbr/skills/shared/progress-display.md +0 -53
- package/plugins/pbr/skills/shared/state-loading.md +0 -62
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
# Error Reporting Fragment
|
|
2
|
-
|
|
3
|
-
Standard error display formats for all skills. Reference `references/ui-formatting.md` for the full brand guide.
|
|
4
|
-
|
|
5
|
-
## Recoverable Error
|
|
6
|
-
|
|
7
|
-
For errors that don't halt the workflow — skill can suggest a fix or retry:
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
⚠ Warning: {short description}
|
|
11
|
-
|
|
12
|
-
{1-2 line explanation of what went wrong}
|
|
13
|
-
|
|
14
|
-
To fix: {actionable instruction}
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
Example:
|
|
18
|
-
```
|
|
19
|
-
⚠ Warning: STATE.md is 180 lines (limit: 150)
|
|
20
|
-
|
|
21
|
-
The state file has grown beyond the recommended size, which increases context usage on load.
|
|
22
|
-
|
|
23
|
-
To fix: Run /pbr:health to compact the Accumulated Context section.
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Fatal Error
|
|
27
|
-
|
|
28
|
-
For errors that stop execution — skill cannot continue:
|
|
29
|
-
|
|
30
|
-
```
|
|
31
|
-
✗ Error: {short description}
|
|
32
|
-
|
|
33
|
-
{1-2 line explanation}
|
|
34
|
-
|
|
35
|
-
What to try:
|
|
36
|
-
1. {first suggestion}
|
|
37
|
-
2. {second suggestion}
|
|
38
|
-
3. {fallback — often /pbr:health or manual fix}
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Example:
|
|
42
|
-
```
|
|
43
|
-
✗ Error: PLAN.md not found for phase 03
|
|
44
|
-
|
|
45
|
-
No plan files exist in .planning/phases/03-auth/. The executor cannot run without a plan.
|
|
46
|
-
|
|
47
|
-
What to try:
|
|
48
|
-
1. Run /pbr:plan 3 to create a plan first
|
|
49
|
-
2. Check if the phase directory exists: ls .planning/phases/03-*
|
|
50
|
-
3. Run /pbr:health to check planning directory integrity
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
## Validation Error
|
|
54
|
-
|
|
55
|
-
For format or schema validation failures (config, plan format, commit message):
|
|
56
|
-
|
|
57
|
-
```
|
|
58
|
-
✗ Validation failed: {what was validated}
|
|
59
|
-
|
|
60
|
-
Issues:
|
|
61
|
-
- {specific issue 1}
|
|
62
|
-
- {specific issue 2}
|
|
63
|
-
|
|
64
|
-
Expected format: {brief format description or example}
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## Hook Block Message
|
|
68
|
-
|
|
69
|
-
For PreToolUse hooks that reject a tool call:
|
|
70
|
-
|
|
71
|
-
```
|
|
72
|
-
Blocked: {short reason}
|
|
73
|
-
|
|
74
|
-
{explanation}
|
|
75
|
-
|
|
76
|
-
{how to fix or alternative approach}
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
This format is used by validate-commit.js and check-dangerous-commands.js. The `decision: "block"` and `reason` fields in the JSON output follow this pattern.
|
|
80
|
-
|
|
81
|
-
Block reasons should always include a "To fix:" line with actionable guidance so the user or agent knows how to resolve the block.
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# Progress Display Fragment
|
|
2
|
-
|
|
3
|
-
Standard progress display formats for all skills. Reference `references/ui-formatting.md` for the full brand guide.
|
|
4
|
-
|
|
5
|
-
## Progress Bar
|
|
6
|
-
|
|
7
|
-
Always 20 characters wide using `█` (filled) and `░` (empty):
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
Progress: [████████████░░░░░░░░] 60%
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
Calculate: `filled = Math.round(percent / 5)`, `empty = 20 - filled`
|
|
14
|
-
|
|
15
|
-
## Phase Table
|
|
16
|
-
|
|
17
|
-
Use when displaying multiple phases (status, milestone skills):
|
|
18
|
-
|
|
19
|
-
```
|
|
20
|
-
| Phase | Name | Status | Plans | Progress |
|
|
21
|
-
|-------|------------------|-----------|-------|----------|
|
|
22
|
-
| 01 | Setup | ✓ complete | 2/2 | 100% |
|
|
23
|
-
| 02 | Authentication | ◐ building | 1/3 | 33% |
|
|
24
|
-
| 03 | Dashboard | ○ pending | 0/4 | 0% |
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Status Indicators
|
|
28
|
-
|
|
29
|
-
| Symbol | Meaning | When to use |
|
|
30
|
-
|--------|---------|-------------|
|
|
31
|
-
| `✓` | Complete | Phase/plan/task finished |
|
|
32
|
-
| `✗` | Failed | Verification failed |
|
|
33
|
-
| `○` | Pending | Not started |
|
|
34
|
-
| `◐` | In Progress | Currently executing |
|
|
35
|
-
| `?` | Needs Human | Checkpoint requiring user action |
|
|
36
|
-
| `⚠` | Warning | Non-blocking issue |
|
|
37
|
-
| `⊘` | Blocked | Waiting on dependency |
|
|
38
|
-
|
|
39
|
-
## Wave Progress (build skill)
|
|
40
|
-
|
|
41
|
-
```
|
|
42
|
-
Wave 1: ✓ Plan 01, ✓ Plan 02
|
|
43
|
-
Wave 2: ◐ Plan 03 (executing)
|
|
44
|
-
Wave 3: ○ Plan 04, ○ Plan 05
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## Compact Status Line
|
|
48
|
-
|
|
49
|
-
For inline status updates:
|
|
50
|
-
|
|
51
|
-
```
|
|
52
|
-
Phase 3 of 8 (Auth) — building — [████████░░░░░░░░░░░░] 40%
|
|
53
|
-
```
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
<!-- canonical: ../../../pbr/skills/shared/state-loading.md -->
|
|
2
|
-
# State Loading Pattern
|
|
3
|
-
|
|
4
|
-
Standard pattern for loading project state at the start of a skill invocation. Include this fragment in skills that need project context.
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Minimal State Read (for simple skills)
|
|
9
|
-
|
|
10
|
-
Use when the skill only needs to know the current position. Skills: status, help, note, todo, pause, config.
|
|
11
|
-
STATE.md is lean — it contains only current-phase context. Historical data lives in HISTORY.md.
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
1. Read .planning/STATE.md lines 1-20 only
|
|
15
|
-
2. Extract: current phase, plan, status
|
|
16
|
-
3. If STATE.md missing: inform user, suggest /pbr:begin
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
## Full State Read (for workflow skills)
|
|
20
|
-
|
|
21
|
-
Use when the skill needs complete project context. Skills: build, plan, review, begin, milestone, continue, resume, debug.
|
|
22
|
-
|
|
23
|
-
Reading order (always this sequence):
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
1. Read .planning/STATE.md
|
|
27
|
-
- Extract: Current Position section (phase, plan, status)
|
|
28
|
-
- Extract: Blockers/Concerns section (if not "None")
|
|
29
|
-
- Extract: Session Continuity section (if present)
|
|
30
|
-
|
|
31
|
-
2. Read .planning/config.json
|
|
32
|
-
- Extract: depth, mode, features flags
|
|
33
|
-
- Extract: models configuration
|
|
34
|
-
- Extract: gates configuration
|
|
35
|
-
|
|
36
|
-
3. Read .planning/ROADMAP.md (if exists)
|
|
37
|
-
- Extract: Phase Overview table (current + next 2 phases)
|
|
38
|
-
- Extract: dependency chain for current phase
|
|
39
|
-
- Do NOT read full phase details for past phases
|
|
40
|
-
|
|
41
|
-
4. Read .planning/HISTORY.md (ONLY when cross-phase context is needed)
|
|
42
|
-
- Do NOT read HISTORY.md for normal build/plan/review operations
|
|
43
|
-
- Read ONLY when: debugging a regression that may trace to a prior phase,
|
|
44
|
-
or when a milestone audit needs historical context
|
|
45
|
-
- Use: `node ${PLUGIN_ROOT}/scripts/pbr-tools.js history load`
|
|
46
|
-
- This returns structured JSON -- do not read the raw file
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## Error Handling
|
|
50
|
-
|
|
51
|
-
| File Missing | Action |
|
|
52
|
-
|-------------|--------|
|
|
53
|
-
| STATE.md | Warn user: "No STATE.md found. Run /pbr:begin to initialize." |
|
|
54
|
-
| config.json | Use defaults (depth: standard, mode: interactive) |
|
|
55
|
-
| ROADMAP.md | Continue without roadmap context (acceptable for quick tasks) |
|
|
56
|
-
| .planning/ dir | Exit: "No .planning directory. This is not a Plan-Build-Run project." |
|
|
57
|
-
|
|
58
|
-
## What NOT to Read During State Loading
|
|
59
|
-
|
|
60
|
-
- Full SUMMARY.md bodies from prior phases (read frontmatter only if needed)
|
|
61
|
-
- Agent definition files (agents/*.md) — auto-loaded by subagent_type
|
|
62
|
-
- PLAN.md files from other phases (only current phase plans)
|
|
63
|
-
- .planning/logs/ files (only health skill reads these)
|
|
@@ -1,135 +0,0 @@
|
|
|
1
|
-
<!-- canonical: ../../pbr/references/agent-interactions.md -->
|
|
2
|
-
# Agent Interaction Map
|
|
3
|
-
|
|
4
|
-
This document shows how Plan-Build-Run agents communicate through files on disk. Agents never message each other directly -- they read and write shared files in `.planning/`.
|
|
5
|
-
|
|
6
|
-
## Interaction Graph
|
|
7
|
-
|
|
8
|
-
```
|
|
9
|
-
User / Orchestrator
|
|
10
|
-
| ^
|
|
11
|
-
v |
|
|
12
|
-
+--------------+ |
|
|
13
|
-
| researcher |---+---> planner
|
|
14
|
-
+--------------+ | ^
|
|
15
|
-
| v |
|
|
16
|
-
+--------------+ +--------------+
|
|
17
|
-
| synthesizer | | plan-checker |
|
|
18
|
-
+--------------+ +--------------+
|
|
19
|
-
|
|
|
20
|
-
v
|
|
21
|
-
+-----------+
|
|
22
|
-
| executor |
|
|
23
|
-
+-----------+
|
|
24
|
-
|
|
|
25
|
-
v
|
|
26
|
-
+-----------+
|
|
27
|
-
| verifier |----> planner (gap closure)
|
|
28
|
-
+-----------+
|
|
29
|
-
|
|
|
30
|
-
v
|
|
31
|
-
+--------------------+
|
|
32
|
-
| integration-checker|
|
|
33
|
-
+--------------------+
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
## Per-Agent Interaction Details
|
|
37
|
-
|
|
38
|
-
### researcher
|
|
39
|
-
|
|
40
|
-
| Direction | Agent/Role | What |
|
|
41
|
-
|-----------|-----------|------|
|
|
42
|
-
| Receives from | User/Orchestrator | Research topics, CONTEXT.md constraints, phase goals |
|
|
43
|
-
| Produces for | planner | Research documents with technology details and recommendations |
|
|
44
|
-
| Produces for | synthesizer | Research documents to be combined |
|
|
45
|
-
| Produces for | User | Direct reading for decision-making |
|
|
46
|
-
|
|
47
|
-
### synthesizer
|
|
48
|
-
|
|
49
|
-
| Direction | Agent/Role | What |
|
|
50
|
-
|-----------|-----------|------|
|
|
51
|
-
| Receives from | researcher | Research documents to synthesize |
|
|
52
|
-
| Receives from | Orchestrator | Paths to research documents, synthesis request |
|
|
53
|
-
| Produces for | planner | SUMMARY.md as consolidated research input for planning |
|
|
54
|
-
| Produces for | User | High-level project/phase research overview |
|
|
55
|
-
|
|
56
|
-
### planner
|
|
57
|
-
|
|
58
|
-
| Direction | Agent/Role | What |
|
|
59
|
-
|-----------|-----------|------|
|
|
60
|
-
| Receives from | researcher | Research documents with technology details and recommendations |
|
|
61
|
-
| Receives from | plan-checker | Issue reports requiring plan revision |
|
|
62
|
-
| Receives from | verifier | VERIFICATION.md reports requiring gap closure plans |
|
|
63
|
-
| Receives from | User/Orchestrator | Phase goals, CONTEXT.md, planning requests |
|
|
64
|
-
| Produces for | plan-checker | Plan files for quality verification |
|
|
65
|
-
| Produces for | executor | Plan files for execution |
|
|
66
|
-
| Produces for | verifier | Must-have definitions for verification (embedded in plan frontmatter) |
|
|
67
|
-
|
|
68
|
-
### plan-checker
|
|
69
|
-
|
|
70
|
-
| Direction | Agent/Role | What |
|
|
71
|
-
|-----------|-----------|------|
|
|
72
|
-
| Receives from | Orchestrator/User | Plan files to check, phase context |
|
|
73
|
-
| Receives from | planner | Newly created or revised plan files |
|
|
74
|
-
| Produces for | planner | Issue reports for revision |
|
|
75
|
-
| Produces for | Orchestrator/User | Pass/fail decision on plan quality |
|
|
76
|
-
|
|
77
|
-
### executor
|
|
78
|
-
|
|
79
|
-
| Direction | Agent/Role | What |
|
|
80
|
-
|-----------|-----------|------|
|
|
81
|
-
| Receives from | Orchestrator | Plan files to execute, continuation instructions |
|
|
82
|
-
| Receives from | planner | The plans themselves (indirectly, via files) |
|
|
83
|
-
| Produces for | verifier | SUMMARY.md for verification, committed code for inspection |
|
|
84
|
-
| Produces for | Orchestrator | Checkpoint responses, completion status |
|
|
85
|
-
| Produces for | planner | Deferred ideas (in SUMMARY.md) for future planning |
|
|
86
|
-
|
|
87
|
-
### verifier
|
|
88
|
-
|
|
89
|
-
| Direction | Agent/Role | What |
|
|
90
|
-
|-----------|-----------|------|
|
|
91
|
-
| Receives from | Orchestrator | Phase to verify, timing trigger |
|
|
92
|
-
| Receives from | executor | Completed work (via codebase and SUMMARY.md) |
|
|
93
|
-
| Receives from | Previous VERIFICATION.md | Gaps to re-check (in re-verification mode) |
|
|
94
|
-
| Produces for | planner | Gap list for gap-closure planning (via VERIFICATION.md) |
|
|
95
|
-
| Produces for | Orchestrator | Phase status (passed/gaps_found/human_needed) |
|
|
96
|
-
| Produces for | User | Human verification items with specific test instructions |
|
|
97
|
-
|
|
98
|
-
### integration-checker
|
|
99
|
-
|
|
100
|
-
| Direction | Agent/Role | What |
|
|
101
|
-
|-----------|-----------|------|
|
|
102
|
-
| Receives from | Orchestrator | Phases to check, trigger event (milestone/review) |
|
|
103
|
-
| Receives from | verifier | Phase-level verification reports (for context on per-phase status) |
|
|
104
|
-
| Produces for | planner | Integration gap list for cross-phase fix plans |
|
|
105
|
-
| Produces for | Orchestrator | Integration status for milestone decisions |
|
|
106
|
-
| Produces for | User | Integration health overview and security issues |
|
|
107
|
-
|
|
108
|
-
### debugger
|
|
109
|
-
|
|
110
|
-
| Direction | Agent/Role | What |
|
|
111
|
-
|-----------|-----------|------|
|
|
112
|
-
| Receives from | Orchestrator/User | Bug reports, symptoms, reproduction steps |
|
|
113
|
-
| Receives from | executor | Errors encountered during execution (via checkpoint responses) |
|
|
114
|
-
| Receives from | verifier | Issues discovered during verification |
|
|
115
|
-
| Produces for | Orchestrator/User | Root cause analysis, fix commits, checkpoint requests |
|
|
116
|
-
| Produces for | planner | Findings requiring architectural changes |
|
|
117
|
-
| Produces for | executor | Simple fix instructions for executor to apply |
|
|
118
|
-
|
|
119
|
-
### codebase-mapper
|
|
120
|
-
|
|
121
|
-
| Direction | Agent/Role | What |
|
|
122
|
-
|-----------|-----------|------|
|
|
123
|
-
| Receives from | Orchestrator/User | Focus area to analyze, project path |
|
|
124
|
-
| Receives from | researcher | May be invoked alongside researcher for new projects |
|
|
125
|
-
| Produces for | planner | STACK.md, ARCHITECTURE.md, STRUCTURE.md for informed planning |
|
|
126
|
-
| Produces for | executor | CONVENTIONS.md for code style, TESTING.md for test patterns |
|
|
127
|
-
| Produces for | verifier | All documents as reference for what "correct" looks like |
|
|
128
|
-
| Produces for | User | Direct reading for project understanding |
|
|
129
|
-
|
|
130
|
-
### general
|
|
131
|
-
|
|
132
|
-
| Direction | Agent/Role | What |
|
|
133
|
-
|-----------|-----------|------|
|
|
134
|
-
| Receives from | Orchestrator/User | Ad-hoc task instructions |
|
|
135
|
-
| Produces for | Orchestrator/User | Task output (files, formatting, config changes) |
|
|
@@ -1,214 +0,0 @@
|
|
|
1
|
-
<!-- canonical: ../../pbr/references/planning-config.md -->
|
|
2
|
-
# Planning Config Reference
|
|
3
|
-
|
|
4
|
-
Schema, fields, defaults, and behavioral effects of Plan-Build-Run's `config.json`.
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Overview
|
|
9
|
-
|
|
10
|
-
Plan-Build-Run's configuration lives at `.planning/config.json` in the project root. It is created by `/pbr:begin` and can be modified via `/pbr:config` or by editing the file directly. The config controls workflow behavior, model selection, parallelization, git integration, and confirmation gates.
|
|
11
|
-
|
|
12
|
-
---
|
|
13
|
-
|
|
14
|
-
## Schema Version
|
|
15
|
-
|
|
16
|
-
```json
|
|
17
|
-
{ "version": 2 }
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
The `version` field tracks schema migrations. Current version is `2`. When loading a config with an older version, Plan-Build-Run runs automatic migration (e.g., v1 to v2 adds missing fields with defaults, renames `model_profile` to per-agent `models` object).
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Top-Level Fields
|
|
25
|
-
|
|
26
|
-
| Field | Type | Default | Description |
|
|
27
|
-
|-------|------|---------|-------------|
|
|
28
|
-
| `version` | number | `2` | Config schema version |
|
|
29
|
-
| `context_strategy` | string | `"aggressive"` | Context budget strategy: `aggressive`, `balanced`, `minimal` |
|
|
30
|
-
| `mode` | string | `"interactive"` | Workflow mode: `interactive` |
|
|
31
|
-
| `depth` | string | `"standard"` | Research/planning depth: `quick`, `standard`, `comprehensive` |
|
|
32
|
-
|
|
33
|
-
### depth
|
|
34
|
-
|
|
35
|
-
Controls how thorough research and planning phases are:
|
|
36
|
-
|
|
37
|
-
| Value | Behavior |
|
|
38
|
-
|-------|----------|
|
|
39
|
-
| `quick` | Minimal research, smaller plans, faster execution |
|
|
40
|
-
| `standard` | Balanced research depth, standard plan detail |
|
|
41
|
-
| `comprehensive` | Deep research with multiple sources, detailed plans with more tasks |
|
|
42
|
-
|
|
43
|
-
### context_strategy
|
|
44
|
-
|
|
45
|
-
Controls how aggressively Plan-Build-Run manages context budget:
|
|
46
|
-
|
|
47
|
-
| Value | Behavior |
|
|
48
|
-
|-------|----------|
|
|
49
|
-
| `aggressive` | Proactive compaction warnings, strict context isolation, minimal file reads in main context |
|
|
50
|
-
| `balanced` | Moderate context management with some inline reads |
|
|
51
|
-
| `minimal` | Relaxed context management, more inline content allowed |
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## features
|
|
56
|
-
|
|
57
|
-
Boolean toggles that enable or disable specific workflow capabilities.
|
|
58
|
-
|
|
59
|
-
| Field | Default | Description |
|
|
60
|
-
|-------|---------|-------------|
|
|
61
|
-
| `structured_planning` | `true` | Use phased planning with ROADMAP and plan files |
|
|
62
|
-
| `goal_verification` | `true` | Run verifier agent after builds to check goals are met |
|
|
63
|
-
| `integration_verification` | `true` | Run cross-phase integration checks |
|
|
64
|
-
| `context_isolation` | `true` | Isolate work into subagents to protect main context |
|
|
65
|
-
| `atomic_commits` | `true` | Require one commit per task (vs. batched commits) |
|
|
66
|
-
| `session_persistence` | `true` | Persist state across sessions via STATE.md |
|
|
67
|
-
| `research_phase` | `true` | Run research before planning |
|
|
68
|
-
| `plan_checking` | `true` | Run plan-checker agent before execution |
|
|
69
|
-
| `tdd_mode` | `false` | Enable Test-Driven Development for all tasks (Red-Green-Refactor) |
|
|
70
|
-
| `status_line` | `true` | Show status line in session UI |
|
|
71
|
-
| `auto_continue` | `false` | Write `.auto-next` signal on phase completion for automatic continuation |
|
|
72
|
-
| `auto_advance` | `false` | Chain build→review→plan automatically in autonomous mode (requires `mode: autonomous`) |
|
|
73
|
-
| `team_discussions` | `false` | Enable team-based discussion workflows (never used for execution) |
|
|
74
|
-
| `inline_verify` | `false` | Run per-task verification after each executor commit (opt-in, adds latency) |
|
|
75
|
-
|
|
76
|
-
### Notable interactions
|
|
77
|
-
|
|
78
|
-
- `goal_verification: false` skips the post-build verification step. The build skill appends a note suggesting `/pbr:review` manually.
|
|
79
|
-
- `tdd_mode: true` causes all task types to follow Red-Green-Refactor, producing 3 commits per task instead of 1.
|
|
80
|
-
- `auto_continue: true` writes a `.planning/.auto-next` file containing the next command (e.g., `/pbr:plan 4`), allowing wrapper scripts to chain phases.
|
|
81
|
-
- `auto_advance: true` + `mode: autonomous` enables full phase cycling: build completes → auto-invoke review → if verification passes → auto-invoke plan for next phase. Hard stops at: checkpoints, verification gaps, errors, milestone boundaries.
|
|
82
|
-
- `inline_verify: true` spawns a haiku-model verifier after each plan completes within a wave. Adds ~10-20s latency per plan but catches issues before dependent plans run.
|
|
83
|
-
|
|
84
|
-
---
|
|
85
|
-
|
|
86
|
-
## models
|
|
87
|
-
|
|
88
|
-
Per-agent model selection. See `references/model-profiles.md` for full details.
|
|
89
|
-
|
|
90
|
-
```json
|
|
91
|
-
{
|
|
92
|
-
"models": {
|
|
93
|
-
"researcher": "sonnet",
|
|
94
|
-
"planner": "inherit",
|
|
95
|
-
"executor": "inherit",
|
|
96
|
-
"verifier": "sonnet",
|
|
97
|
-
"integration_checker": "sonnet",
|
|
98
|
-
"debugger": "inherit",
|
|
99
|
-
"mapper": "sonnet",
|
|
100
|
-
"synthesizer": "haiku"
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
Valid values: `sonnet`, `opus`, `haiku`, `inherit`.
|
|
106
|
-
|
|
107
|
-
---
|
|
108
|
-
|
|
109
|
-
## parallelization
|
|
110
|
-
|
|
111
|
-
Controls whether and how plans execute concurrently.
|
|
112
|
-
|
|
113
|
-
| Field | Type | Default | Description |
|
|
114
|
-
|-------|------|---------|-------------|
|
|
115
|
-
| `enabled` | boolean | `true` | Enable parallel plan execution within a wave |
|
|
116
|
-
| `plan_level` | boolean | `true` | Parallelize at plan level (multiple plans in same wave) |
|
|
117
|
-
| `task_level` | boolean | `false` | Parallelize at task level within a plan (not currently used) |
|
|
118
|
-
| `max_concurrent_agents` | number | `3` | Maximum simultaneous executor subagents |
|
|
119
|
-
| `min_plans_for_parallel` | number | `2` | Minimum plans in a wave to trigger parallel execution |
|
|
120
|
-
| `use_teams` | boolean | `false` | Use Agent Teams for coordination (discussion only, never execution) |
|
|
121
|
-
|
|
122
|
-
### Behavior
|
|
123
|
-
|
|
124
|
-
When `enabled: true` and a wave has >= `min_plans_for_parallel` plans, the build orchestrator spawns up to `max_concurrent_agents` executor Task() calls in parallel using `run_in_background: true`.
|
|
125
|
-
|
|
126
|
-
When `enabled: false` or a wave has only 1 plan, executors run sequentially.
|
|
127
|
-
|
|
128
|
-
Git lock conflicts can occur with parallel execution. Executors handle this with retry logic (wait 2s, max 3 attempts). If conflicts persist, reduce `max_concurrent_agents` to 1.
|
|
129
|
-
|
|
130
|
-
---
|
|
131
|
-
|
|
132
|
-
## planning
|
|
133
|
-
|
|
134
|
-
Controls planning behavior and documentation.
|
|
135
|
-
|
|
136
|
-
| Field | Type | Default | Description |
|
|
137
|
-
|-------|------|---------|-------------|
|
|
138
|
-
| `commit_docs` | boolean | `true` | Commit planning docs (SUMMARY, VERIFICATION) after builds |
|
|
139
|
-
| `max_tasks_per_plan` | number | `3` | Maximum tasks per plan (keeps plans focused and atomic) |
|
|
140
|
-
| `search_gitignored` | boolean | `false` | Include gitignored files in codebase scanning |
|
|
141
|
-
|
|
142
|
-
### commit_docs
|
|
143
|
-
|
|
144
|
-
When `true`, after all plans in a phase complete, the build orchestrator stages and commits planning artifacts:
|
|
145
|
-
```
|
|
146
|
-
docs({phase}): add build summaries and verification
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
When `false`, planning docs remain unstaged/uncommitted.
|
|
150
|
-
|
|
151
|
-
---
|
|
152
|
-
|
|
153
|
-
## git
|
|
154
|
-
|
|
155
|
-
Controls git integration and branching.
|
|
156
|
-
|
|
157
|
-
| Field | Type | Default | Description |
|
|
158
|
-
|-------|------|---------|-------------|
|
|
159
|
-
| `branching` | string | `"none"` | Branching strategy: `none`, `phase`, `milestone`, `disabled` |
|
|
160
|
-
| `commit_format` | string | `"{type}({phase}-{plan}): {description}"` | Commit message template |
|
|
161
|
-
| `phase_branch_template` | string | `"plan-build-run/phase-{phase}-{slug}"` | Phase branch naming |
|
|
162
|
-
| `milestone_branch_template` | string | `"plan-build-run/{milestone}-{slug}"` | Milestone branch naming |
|
|
163
|
-
| `mode` | string | `"enabled"` | Git mode: `enabled` or `disabled` |
|
|
164
|
-
|
|
165
|
-
See `references/git-integration.md` for full branching strategy details.
|
|
166
|
-
|
|
167
|
-
### mode: disabled
|
|
168
|
-
|
|
169
|
-
When `git.mode` is `"disabled"`, no git commands are run at all -- no commits, no branching, no hook validation. Useful for prototyping or non-git projects.
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
## gates
|
|
174
|
-
|
|
175
|
-
Confirmation gates that pause execution to ask the user before proceeding.
|
|
176
|
-
|
|
177
|
-
| Field | Default | When Triggered |
|
|
178
|
-
|-------|---------|----------------|
|
|
179
|
-
| `confirm_project` | `true` | Before creating a new Plan-Build-Run project (`/pbr:begin`) |
|
|
180
|
-
| `confirm_roadmap` | `true` | Before finalizing a roadmap |
|
|
181
|
-
| `confirm_plan` | `true` | Before finalizing plans for a phase |
|
|
182
|
-
| `confirm_execute` | `false` | Before starting phase execution (`/pbr:build`) |
|
|
183
|
-
| `confirm_transition` | `true` | Before transitioning to the next phase |
|
|
184
|
-
| `issues_review` | `true` | Before proceeding when issues are detected |
|
|
185
|
-
|
|
186
|
-
Setting a gate to `false` makes that step automatic (no user prompt).
|
|
187
|
-
|
|
188
|
-
---
|
|
189
|
-
|
|
190
|
-
## safety
|
|
191
|
-
|
|
192
|
-
Safety controls for destructive or external operations.
|
|
193
|
-
|
|
194
|
-
| Field | Type | Default | Description |
|
|
195
|
-
|-------|------|---------|-------------|
|
|
196
|
-
| `always_confirm_destructive` | boolean | `true` | Always ask before destructive git operations |
|
|
197
|
-
| `always_confirm_external_services` | boolean | `true` | Always ask before calling external APIs or services |
|
|
198
|
-
|
|
199
|
-
These cannot be disabled via `/pbr:config` -- they require manual editing of `config.json` as a deliberate action.
|
|
200
|
-
|
|
201
|
-
---
|
|
202
|
-
|
|
203
|
-
## Validation Rules
|
|
204
|
-
|
|
205
|
-
When modifying config (via `/pbr:config` or direct edit):
|
|
206
|
-
|
|
207
|
-
| Field | Valid Values |
|
|
208
|
-
|-------|-------------|
|
|
209
|
-
| `depth` | `quick`, `standard`, `comprehensive` |
|
|
210
|
-
| `models.*` | `sonnet`, `inherit`, `haiku`, `opus` |
|
|
211
|
-
| `context_strategy` | `aggressive`, `balanced`, `minimal` |
|
|
212
|
-
| `git.branching` | `none`, `phase`, `milestone`, `disabled` |
|
|
213
|
-
| `git.mode` | `enabled`, `disabled` |
|
|
214
|
-
| All boolean fields | `true`, `false` |
|
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
<!-- canonical: ../../pbr/references/subagent-coordination.md -->
|
|
2
|
-
# Subagent Coordination Reference
|
|
3
|
-
|
|
4
|
-
Patterns for spawning, monitoring, and consuming output from Task() subagents. Used by skills that delegate work to specialized agents.
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## When to Spawn vs Inline
|
|
9
|
-
|
|
10
|
-
| Condition | Action |
|
|
11
|
-
|-----------|--------|
|
|
12
|
-
| >50 lines of analysis or code generation needed | Spawn a subagent |
|
|
13
|
-
| Simple state read or file write | Do it inline |
|
|
14
|
-
| Multiple files need reading for a decision | Spawn — protect orchestrator context |
|
|
15
|
-
| User interaction needed (questions, confirmations) | Do it inline |
|
|
16
|
-
| Work needs a fresh context window | Spawn |
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## Spawning Pattern
|
|
21
|
-
|
|
22
|
-
Always use the modern subagent_type syntax. Agent definitions are auto-loaded by Claude Code — never inline them.
|
|
23
|
-
|
|
24
|
-
```
|
|
25
|
-
Task({
|
|
26
|
-
subagent_type: "pbr:{agent-name}",
|
|
27
|
-
prompt: <structured prompt with context>
|
|
28
|
-
})
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### Structured Input Format
|
|
32
|
-
|
|
33
|
-
Provide context to subagents using tagged blocks:
|
|
34
|
-
|
|
35
|
-
```xml
|
|
36
|
-
<phase_context>
|
|
37
|
-
Phase: {NN}-{slug}
|
|
38
|
-
Goal: {goal from ROADMAP.md}
|
|
39
|
-
</phase_context>
|
|
40
|
-
|
|
41
|
-
<prior_work>
|
|
42
|
-
{Frontmatter from relevant SUMMARY.md files}
|
|
43
|
-
</prior_work>
|
|
44
|
-
|
|
45
|
-
<instructions>
|
|
46
|
-
{Specific instructions for this agent invocation}
|
|
47
|
-
</instructions>
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### What NOT to Include in Spawn Prompts
|
|
51
|
-
|
|
52
|
-
- Full agent definition text (auto-loaded via subagent_type)
|
|
53
|
-
- Full SUMMARY.md bodies (agent reads from disk)
|
|
54
|
-
- Full PLAN.md bodies unless the agent needs them (executor does, verifier doesn't)
|
|
55
|
-
- Content from unrelated phases
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
## Reading Output
|
|
60
|
-
|
|
61
|
-
After a subagent completes, read its output file — but only what you need.
|
|
62
|
-
|
|
63
|
-
| Output Type | Orchestrator Reads | Agent Reads Full |
|
|
64
|
-
|-------------|-------------------|-----------------|
|
|
65
|
-
| SUMMARY.md | Frontmatter only (status, key_files, commits) | Yes, from disk |
|
|
66
|
-
| VERIFICATION.md | Frontmatter only (status, must_haves_passed/failed) | Yes, from disk |
|
|
67
|
-
| PLAN.md | Frontmatter only (wave, depends_on, files_modified) | Yes, from disk |
|
|
68
|
-
| RESEARCH.md | Frontmatter + recommendations section | Yes, from disk |
|
|
69
|
-
| Debug files | Latest hypothesis + result only | Yes, from disk |
|
|
70
|
-
|
|
71
|
-
### Frontmatter-Only Read Pattern
|
|
72
|
-
|
|
73
|
-
```
|
|
74
|
-
Read the file, extract YAML frontmatter between --- markers.
|
|
75
|
-
Parse: status, key_files, commits, provides.
|
|
76
|
-
Do NOT read past the closing --- of frontmatter.
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## State Update After Agent Completion
|
|
82
|
-
|
|
83
|
-
After reading agent output, update STATE.md with minimal information:
|
|
84
|
-
1. Update phase/plan status
|
|
85
|
-
2. Record completion timestamp
|
|
86
|
-
3. Note any blockers or warnings from frontmatter
|
|
87
|
-
4. Do NOT copy agent output into STATE.md
|
|
88
|
-
|
|
89
|
-
---
|
|
90
|
-
|
|
91
|
-
## Error Handling
|
|
92
|
-
|
|
93
|
-
| Scenario | Action |
|
|
94
|
-
|----------|--------|
|
|
95
|
-
| Agent times out | Report to user, suggest retry |
|
|
96
|
-
| Agent produces no output file | Report failure, check for partial work |
|
|
97
|
-
| Output file has `status: failed` | Read failure details, present to user |
|
|
98
|
-
| Agent reports warnings | Continue but show warnings in completion summary |
|
|
99
|
-
|
|
100
|
-
### Retryable vs Fatal
|
|
101
|
-
|
|
102
|
-
- **Retryable**: Timeout, transient file errors, partial completion
|
|
103
|
-
- **Fatal**: Missing plan files, invalid state, circular dependencies
|
|
104
|
-
- **User decision**: Verification failures, ambiguous requirements
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## Context Budget Impact
|
|
109
|
-
|
|
110
|
-
Each subagent coordination step has a token cost in the orchestrator:
|
|
111
|
-
|
|
112
|
-
| Step | Approximate Cost |
|
|
113
|
-
|------|-----------------|
|
|
114
|
-
| Reading state before spawn | 200-500 tokens |
|
|
115
|
-
| Constructing spawn prompt | 500-1000 tokens |
|
|
116
|
-
| Reading output frontmatter | 100-300 tokens |
|
|
117
|
-
| Updating STATE.md | 200-400 tokens |
|
|
118
|
-
| **Total per agent cycle** | **1,000-2,200 tokens** |
|
|
119
|
-
|
|
120
|
-
Compare to inlining the same work: 5,000-20,000 tokens. Delegation saves 3-10x.
|