@sienklogic/plan-build-run 2.0.0

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.
Files changed (221) hide show
  1. package/CHANGELOG.md +56 -0
  2. package/CLAUDE.md +149 -0
  3. package/LICENSE +21 -0
  4. package/README.md +247 -0
  5. package/dashboard/bin/cli.js +25 -0
  6. package/dashboard/package.json +34 -0
  7. package/dashboard/public/.gitkeep +0 -0
  8. package/dashboard/public/css/layout.css +406 -0
  9. package/dashboard/public/css/status-colors.css +98 -0
  10. package/dashboard/public/js/htmx-title.js +5 -0
  11. package/dashboard/public/js/sidebar-toggle.js +20 -0
  12. package/dashboard/src/app.js +78 -0
  13. package/dashboard/src/middleware/errorHandler.js +52 -0
  14. package/dashboard/src/middleware/notFoundHandler.js +9 -0
  15. package/dashboard/src/repositories/planning.repository.js +128 -0
  16. package/dashboard/src/routes/events.routes.js +40 -0
  17. package/dashboard/src/routes/index.routes.js +31 -0
  18. package/dashboard/src/routes/pages.routes.js +195 -0
  19. package/dashboard/src/server.js +42 -0
  20. package/dashboard/src/services/dashboard.service.js +222 -0
  21. package/dashboard/src/services/phase.service.js +167 -0
  22. package/dashboard/src/services/project.service.js +57 -0
  23. package/dashboard/src/services/roadmap.service.js +171 -0
  24. package/dashboard/src/services/sse.service.js +58 -0
  25. package/dashboard/src/services/todo.service.js +254 -0
  26. package/dashboard/src/services/watcher.service.js +48 -0
  27. package/dashboard/src/views/coming-soon.ejs +11 -0
  28. package/dashboard/src/views/error.ejs +13 -0
  29. package/dashboard/src/views/index.ejs +5 -0
  30. package/dashboard/src/views/layout.ejs +1 -0
  31. package/dashboard/src/views/partials/dashboard-content.ejs +77 -0
  32. package/dashboard/src/views/partials/footer.ejs +3 -0
  33. package/dashboard/src/views/partials/head.ejs +21 -0
  34. package/dashboard/src/views/partials/header.ejs +12 -0
  35. package/dashboard/src/views/partials/layout-bottom.ejs +15 -0
  36. package/dashboard/src/views/partials/layout-top.ejs +8 -0
  37. package/dashboard/src/views/partials/phase-content.ejs +181 -0
  38. package/dashboard/src/views/partials/phases-content.ejs +117 -0
  39. package/dashboard/src/views/partials/roadmap-content.ejs +142 -0
  40. package/dashboard/src/views/partials/sidebar.ejs +38 -0
  41. package/dashboard/src/views/partials/todo-create-content.ejs +53 -0
  42. package/dashboard/src/views/partials/todo-detail-content.ejs +38 -0
  43. package/dashboard/src/views/partials/todos-content.ejs +53 -0
  44. package/dashboard/src/views/phase-detail.ejs +5 -0
  45. package/dashboard/src/views/phases.ejs +5 -0
  46. package/dashboard/src/views/roadmap.ejs +5 -0
  47. package/dashboard/src/views/todo-create.ejs +5 -0
  48. package/dashboard/src/views/todo-detail.ejs +5 -0
  49. package/dashboard/src/views/todos.ejs +5 -0
  50. package/package.json +57 -0
  51. package/plugins/pbr/.claude-plugin/plugin.json +13 -0
  52. package/plugins/pbr/UI-CONSISTENCY-GAPS.md +61 -0
  53. package/plugins/pbr/agents/codebase-mapper.md +271 -0
  54. package/plugins/pbr/agents/debugger.md +281 -0
  55. package/plugins/pbr/agents/executor.md +407 -0
  56. package/plugins/pbr/agents/general.md +164 -0
  57. package/plugins/pbr/agents/integration-checker.md +141 -0
  58. package/plugins/pbr/agents/plan-checker.md +280 -0
  59. package/plugins/pbr/agents/planner.md +358 -0
  60. package/plugins/pbr/agents/researcher.md +363 -0
  61. package/plugins/pbr/agents/synthesizer.md +230 -0
  62. package/plugins/pbr/agents/verifier.md +454 -0
  63. package/plugins/pbr/commands/begin.md +5 -0
  64. package/plugins/pbr/commands/build.md +5 -0
  65. package/plugins/pbr/commands/config.md +5 -0
  66. package/plugins/pbr/commands/continue.md +5 -0
  67. package/plugins/pbr/commands/debug.md +5 -0
  68. package/plugins/pbr/commands/discuss.md +5 -0
  69. package/plugins/pbr/commands/explore.md +5 -0
  70. package/plugins/pbr/commands/health.md +5 -0
  71. package/plugins/pbr/commands/help.md +5 -0
  72. package/plugins/pbr/commands/import.md +5 -0
  73. package/plugins/pbr/commands/milestone.md +5 -0
  74. package/plugins/pbr/commands/note.md +5 -0
  75. package/plugins/pbr/commands/pause.md +5 -0
  76. package/plugins/pbr/commands/plan.md +5 -0
  77. package/plugins/pbr/commands/quick.md +5 -0
  78. package/plugins/pbr/commands/resume.md +5 -0
  79. package/plugins/pbr/commands/review.md +5 -0
  80. package/plugins/pbr/commands/scan.md +5 -0
  81. package/plugins/pbr/commands/setup.md +5 -0
  82. package/plugins/pbr/commands/status.md +5 -0
  83. package/plugins/pbr/commands/todo.md +5 -0
  84. package/plugins/pbr/contexts/dev.md +27 -0
  85. package/plugins/pbr/contexts/research.md +28 -0
  86. package/plugins/pbr/contexts/review.md +36 -0
  87. package/plugins/pbr/hooks/hooks.json +183 -0
  88. package/plugins/pbr/references/agent-anti-patterns.md +24 -0
  89. package/plugins/pbr/references/agent-interactions.md +134 -0
  90. package/plugins/pbr/references/agent-teams.md +54 -0
  91. package/plugins/pbr/references/checkpoints.md +157 -0
  92. package/plugins/pbr/references/common-bug-patterns.md +13 -0
  93. package/plugins/pbr/references/continuation-format.md +212 -0
  94. package/plugins/pbr/references/deviation-rules.md +112 -0
  95. package/plugins/pbr/references/git-integration.md +226 -0
  96. package/plugins/pbr/references/integration-patterns.md +117 -0
  97. package/plugins/pbr/references/model-profiles.md +99 -0
  98. package/plugins/pbr/references/model-selection.md +31 -0
  99. package/plugins/pbr/references/pbr-rules.md +193 -0
  100. package/plugins/pbr/references/plan-authoring.md +181 -0
  101. package/plugins/pbr/references/plan-format.md +283 -0
  102. package/plugins/pbr/references/planning-config.md +213 -0
  103. package/plugins/pbr/references/questioning.md +214 -0
  104. package/plugins/pbr/references/reading-verification.md +127 -0
  105. package/plugins/pbr/references/stub-patterns.md +160 -0
  106. package/plugins/pbr/references/subagent-coordination.md +119 -0
  107. package/plugins/pbr/references/ui-formatting.md +399 -0
  108. package/plugins/pbr/references/verification-patterns.md +198 -0
  109. package/plugins/pbr/references/wave-execution.md +95 -0
  110. package/plugins/pbr/scripts/auto-continue.js +80 -0
  111. package/plugins/pbr/scripts/check-dangerous-commands.js +136 -0
  112. package/plugins/pbr/scripts/check-doc-sprawl.js +102 -0
  113. package/plugins/pbr/scripts/check-phase-boundary.js +196 -0
  114. package/plugins/pbr/scripts/check-plan-format.js +270 -0
  115. package/plugins/pbr/scripts/check-roadmap-sync.js +252 -0
  116. package/plugins/pbr/scripts/check-skill-workflow.js +262 -0
  117. package/plugins/pbr/scripts/check-state-sync.js +476 -0
  118. package/plugins/pbr/scripts/check-subagent-output.js +144 -0
  119. package/plugins/pbr/scripts/config-schema.json +251 -0
  120. package/plugins/pbr/scripts/context-budget-check.js +287 -0
  121. package/plugins/pbr/scripts/event-handler.js +151 -0
  122. package/plugins/pbr/scripts/event-logger.js +92 -0
  123. package/plugins/pbr/scripts/hook-logger.js +76 -0
  124. package/plugins/pbr/scripts/hooks-schema.json +79 -0
  125. package/plugins/pbr/scripts/log-subagent.js +152 -0
  126. package/plugins/pbr/scripts/log-tool-failure.js +88 -0
  127. package/plugins/pbr/scripts/pbr-tools.js +1301 -0
  128. package/plugins/pbr/scripts/post-write-dispatch.js +66 -0
  129. package/plugins/pbr/scripts/post-write-quality.js +207 -0
  130. package/plugins/pbr/scripts/pre-bash-dispatch.js +56 -0
  131. package/plugins/pbr/scripts/pre-write-dispatch.js +62 -0
  132. package/plugins/pbr/scripts/progress-tracker.js +228 -0
  133. package/plugins/pbr/scripts/session-cleanup.js +254 -0
  134. package/plugins/pbr/scripts/status-line.js +285 -0
  135. package/plugins/pbr/scripts/suggest-compact.js +119 -0
  136. package/plugins/pbr/scripts/task-completed.js +45 -0
  137. package/plugins/pbr/scripts/track-context-budget.js +119 -0
  138. package/plugins/pbr/scripts/validate-commit.js +200 -0
  139. package/plugins/pbr/scripts/validate-plugin-structure.js +172 -0
  140. package/plugins/pbr/skills/begin/SKILL.md +545 -0
  141. package/plugins/pbr/skills/begin/templates/PROJECT.md.tmpl +33 -0
  142. package/plugins/pbr/skills/begin/templates/REQUIREMENTS.md.tmpl +18 -0
  143. package/plugins/pbr/skills/begin/templates/STATE.md.tmpl +49 -0
  144. package/plugins/pbr/skills/begin/templates/config.json.tmpl +63 -0
  145. package/plugins/pbr/skills/begin/templates/researcher-prompt.md.tmpl +19 -0
  146. package/plugins/pbr/skills/begin/templates/roadmap-prompt.md.tmpl +30 -0
  147. package/plugins/pbr/skills/begin/templates/synthesis-prompt.md.tmpl +16 -0
  148. package/plugins/pbr/skills/build/SKILL.md +962 -0
  149. package/plugins/pbr/skills/config/SKILL.md +241 -0
  150. package/plugins/pbr/skills/continue/SKILL.md +127 -0
  151. package/plugins/pbr/skills/debug/SKILL.md +489 -0
  152. package/plugins/pbr/skills/debug/templates/continuation-prompt.md.tmpl +16 -0
  153. package/plugins/pbr/skills/debug/templates/initial-investigation-prompt.md.tmpl +27 -0
  154. package/plugins/pbr/skills/discuss/SKILL.md +338 -0
  155. package/plugins/pbr/skills/discuss/templates/CONTEXT.md.tmpl +61 -0
  156. package/plugins/pbr/skills/discuss/templates/decision-categories.md +9 -0
  157. package/plugins/pbr/skills/explore/SKILL.md +362 -0
  158. package/plugins/pbr/skills/health/SKILL.md +186 -0
  159. package/plugins/pbr/skills/health/templates/check-pattern.md.tmpl +30 -0
  160. package/plugins/pbr/skills/health/templates/output-format.md.tmpl +63 -0
  161. package/plugins/pbr/skills/help/SKILL.md +140 -0
  162. package/plugins/pbr/skills/import/SKILL.md +490 -0
  163. package/plugins/pbr/skills/milestone/SKILL.md +673 -0
  164. package/plugins/pbr/skills/milestone/templates/audit-report.md.tmpl +48 -0
  165. package/plugins/pbr/skills/milestone/templates/stats-file.md.tmpl +30 -0
  166. package/plugins/pbr/skills/note/SKILL.md +212 -0
  167. package/plugins/pbr/skills/pause/SKILL.md +235 -0
  168. package/plugins/pbr/skills/pause/templates/continue-here.md.tmpl +71 -0
  169. package/plugins/pbr/skills/plan/SKILL.md +628 -0
  170. package/plugins/pbr/skills/plan/decimal-phase-calc.md +98 -0
  171. package/plugins/pbr/skills/plan/templates/checker-prompt.md.tmpl +21 -0
  172. package/plugins/pbr/skills/plan/templates/gap-closure-prompt.md.tmpl +32 -0
  173. package/plugins/pbr/skills/plan/templates/planner-prompt.md.tmpl +38 -0
  174. package/plugins/pbr/skills/plan/templates/researcher-prompt.md.tmpl +19 -0
  175. package/plugins/pbr/skills/plan/templates/revision-prompt.md.tmpl +23 -0
  176. package/plugins/pbr/skills/quick/SKILL.md +335 -0
  177. package/plugins/pbr/skills/resume/SKILL.md +388 -0
  178. package/plugins/pbr/skills/review/SKILL.md +652 -0
  179. package/plugins/pbr/skills/review/templates/debugger-prompt.md.tmpl +60 -0
  180. package/plugins/pbr/skills/review/templates/gap-planner-prompt.md.tmpl +40 -0
  181. package/plugins/pbr/skills/review/templates/verifier-prompt.md.tmpl +115 -0
  182. package/plugins/pbr/skills/scan/SKILL.md +269 -0
  183. package/plugins/pbr/skills/scan/templates/mapper-prompt.md.tmpl +201 -0
  184. package/plugins/pbr/skills/setup/SKILL.md +227 -0
  185. package/plugins/pbr/skills/shared/commit-planning-docs.md +35 -0
  186. package/plugins/pbr/skills/shared/config-loading.md +102 -0
  187. package/plugins/pbr/skills/shared/context-budget.md +40 -0
  188. package/plugins/pbr/skills/shared/context-loader-task.md +86 -0
  189. package/plugins/pbr/skills/shared/digest-select.md +79 -0
  190. package/plugins/pbr/skills/shared/domain-probes.md +125 -0
  191. package/plugins/pbr/skills/shared/error-reporting.md +79 -0
  192. package/plugins/pbr/skills/shared/gate-prompts.md +388 -0
  193. package/plugins/pbr/skills/shared/phase-argument-parsing.md +45 -0
  194. package/plugins/pbr/skills/shared/progress-display.md +53 -0
  195. package/plugins/pbr/skills/shared/revision-loop.md +81 -0
  196. package/plugins/pbr/skills/shared/state-loading.md +62 -0
  197. package/plugins/pbr/skills/shared/state-update.md +161 -0
  198. package/plugins/pbr/skills/shared/universal-anti-patterns.md +33 -0
  199. package/plugins/pbr/skills/status/SKILL.md +353 -0
  200. package/plugins/pbr/skills/todo/SKILL.md +181 -0
  201. package/plugins/pbr/templates/CONTEXT.md.tmpl +52 -0
  202. package/plugins/pbr/templates/INTEGRATION-REPORT.md.tmpl +151 -0
  203. package/plugins/pbr/templates/RESEARCH-SUMMARY.md.tmpl +97 -0
  204. package/plugins/pbr/templates/ROADMAP.md.tmpl +40 -0
  205. package/plugins/pbr/templates/SUMMARY.md.tmpl +81 -0
  206. package/plugins/pbr/templates/VERIFICATION-DETAIL.md.tmpl +116 -0
  207. package/plugins/pbr/templates/codebase/ARCHITECTURE.md.tmpl +98 -0
  208. package/plugins/pbr/templates/codebase/CONCERNS.md.tmpl +93 -0
  209. package/plugins/pbr/templates/codebase/CONVENTIONS.md.tmpl +104 -0
  210. package/plugins/pbr/templates/codebase/INTEGRATIONS.md.tmpl +78 -0
  211. package/plugins/pbr/templates/codebase/STACK.md.tmpl +78 -0
  212. package/plugins/pbr/templates/codebase/STRUCTURE.md.tmpl +80 -0
  213. package/plugins/pbr/templates/codebase/TESTING.md.tmpl +107 -0
  214. package/plugins/pbr/templates/continue-here.md.tmpl +73 -0
  215. package/plugins/pbr/templates/prompt-partials/phase-project-context.md.tmpl +37 -0
  216. package/plugins/pbr/templates/research/ARCHITECTURE.md.tmpl +124 -0
  217. package/plugins/pbr/templates/research/STACK.md.tmpl +71 -0
  218. package/plugins/pbr/templates/research/SUMMARY.md.tmpl +112 -0
  219. package/plugins/pbr/templates/research-outputs/phase-research.md.tmpl +81 -0
  220. package/plugins/pbr/templates/research-outputs/project-research.md.tmpl +99 -0
  221. package/plugins/pbr/templates/research-outputs/synthesis.md.tmpl +36 -0
@@ -0,0 +1,227 @@
1
+ ---
2
+ name: setup
3
+ description: "Onboarding wizard. Initialize project, select models, verify setup."
4
+ allowed-tools: Read, Write, Bash, Glob, AskUserQuestion
5
+ ---
6
+
7
+ # /pbr:setup — Plan-Build-Run Setup Wizard
8
+
9
+ You are running the **setup** skill. This is an interactive onboarding wizard that guides users through Plan-Build-Run project setup. Use AskUserQuestion at each step for clear choices.
10
+
11
+ ---
12
+
13
+ ## Step 1: Detect Project State
14
+
15
+ Check if `.planning/` directory exists in the current working directory.
16
+
17
+ **If `.planning/` exists**:
18
+ - Read `.planning/config.json` to check current settings
19
+ - Tell the user: "Existing Plan-Build-Run project detected. This wizard will review your configuration."
20
+ - Skip to Step 3 (model selection)
21
+
22
+ **If `.planning/` does NOT exist**:
23
+ - Ask the user:
24
+
25
+ ```
26
+ AskUserQuestion:
27
+ question: "No Plan-Build-Run project found. Would you like to initialize one?"
28
+ header: "Initialize"
29
+ options:
30
+ - label: "Yes, initialize here"
31
+ description: "Creates .planning/ directory with default config, STATE.md, and ROADMAP.md"
32
+ - label: "No, just exploring"
33
+ description: "Exit the wizard — you can run /pbr:begin later for full project setup"
34
+ ```
35
+
36
+ If "No", display: "Run `/pbr:begin` when you're ready to start a project. It includes deep requirements gathering and roadmap creation." Then stop.
37
+
38
+ If "Yes", create the minimal `.planning/` structure:
39
+
40
+ ```bash
41
+ mkdir -p .planning/phases .planning/todos/pending .planning/todos/done .planning/logs .planning/research
42
+ ```
43
+
44
+ Create `.planning/config.json` with defaults:
45
+ ```json
46
+ {
47
+ "version": 2,
48
+ "depth": "standard",
49
+ "mode": "guided",
50
+ "features": {
51
+ "structured_planning": true,
52
+ "goal_verification": true,
53
+ "integration_verification": false,
54
+ "context_isolation": true,
55
+ "atomic_commits": true,
56
+ "session_persistence": true,
57
+ "research_phase": true,
58
+ "plan_checking": true,
59
+ "tdd_mode": false,
60
+ "status_line": true,
61
+ "auto_continue": false,
62
+ "auto_advance": false,
63
+ "team_discussions": false,
64
+ "inline_verify": false
65
+ },
66
+ "models": {
67
+ "executor": "sonnet",
68
+ "researcher": "sonnet",
69
+ "planner": "sonnet",
70
+ "verifier": "sonnet",
71
+ "synthesizer": "haiku"
72
+ },
73
+ "parallelization": {
74
+ "max_concurrent_agents": 3,
75
+ "allow_parallel_plans": true
76
+ },
77
+ "planning": {
78
+ "max_plans_per_phase": 4,
79
+ "min_must_haves": 3
80
+ },
81
+ "git": {
82
+ "auto_commit": true,
83
+ "commit_format": "conventional",
84
+ "branching_strategy": "none"
85
+ },
86
+ "gates": {
87
+ "verification": true,
88
+ "review": true,
89
+ "plan_approval": false,
90
+ "pre_build_checklist": false
91
+ },
92
+ "safety": {
93
+ "block_sensitive_files": true,
94
+ "require_tests": false
95
+ },
96
+ "hooks": {}
97
+ }
98
+ ```
99
+
100
+ Create `.planning/STATE.md`:
101
+ ```markdown
102
+ ---
103
+ version: 2
104
+ current_phase: 0
105
+ total_phases: 0
106
+ status: "initialized"
107
+ progress_percent: 0
108
+ last_activity: "{today's date}"
109
+ last_command: "/pbr:setup"
110
+ blockers: []
111
+ ---
112
+ # Project State
113
+
114
+ ## Current Position
115
+ Phase: 0 of 0
116
+ Status: initialized
117
+
118
+ Plan-Build-Run project initialized via /pbr:setup. Run /pbr:begin to start requirements gathering and roadmap creation.
119
+ ```
120
+
121
+ ---
122
+
123
+ ## Step 2: Project Type (new projects only)
124
+
125
+ ```
126
+ AskUserQuestion:
127
+ question: "What kind of project is this?"
128
+ header: "Project type"
129
+ options:
130
+ - label: "Greenfield"
131
+ description: "Starting from scratch — full planning cycle recommended"
132
+ - label: "Existing codebase"
133
+ description: "Adding Plan-Build-Run to an existing project — run /pbr:scan first"
134
+ - label: "Prototype/experiment"
135
+ description: "Quick iteration — lighter workflow with fewer gates"
136
+ ```
137
+
138
+ Based on selection:
139
+ - **Greenfield**: Keep defaults (full gates, structured planning)
140
+ - **Existing codebase**: Suggest running `/pbr:scan` after setup to map the codebase
141
+ - **Prototype**: Set `depth: "quick"`, disable `gates.verification`, disable `gates.review`, set `features.research_phase: false`
142
+
143
+ Update config.json with any changes.
144
+
145
+ ---
146
+
147
+ ## Step 3: Model Selection
148
+
149
+ ```
150
+ AskUserQuestion:
151
+ question: "Which model profile should Plan-Build-Run use for agents?"
152
+ header: "Models"
153
+ options:
154
+ - label: "Balanced (Recommended)"
155
+ description: "Sonnet for most agents, Haiku for synthesizer. Good quality/cost tradeoff."
156
+ - label: "Quality"
157
+ description: "Opus for executor and planner, Sonnet for others. Best results, highest cost."
158
+ - label: "Budget"
159
+ description: "Haiku for most agents. Fastest and cheapest, but lower quality."
160
+ ```
161
+
162
+ Apply the selected profile to `config.json`:
163
+ - **Balanced**: executor=sonnet, researcher=sonnet, planner=sonnet, verifier=sonnet, synthesizer=haiku
164
+ - **Quality**: executor=opus, researcher=sonnet, planner=opus, verifier=sonnet, synthesizer=sonnet
165
+ - **Budget**: executor=haiku, researcher=haiku, planner=sonnet, verifier=haiku, synthesizer=haiku
166
+
167
+ ---
168
+
169
+ ## Step 4: Workflow Preferences
170
+
171
+ ```
172
+ AskUserQuestion:
173
+ question: "Which workflow features do you want enabled?"
174
+ header: "Features"
175
+ multiSelect: true
176
+ options:
177
+ - label: "Auto-continue"
178
+ description: "Automatically chain commands (build → review → next phase) without prompting"
179
+ - label: "TDD mode"
180
+ description: "Write tests before implementation in executor agents"
181
+ - label: "Strict gates"
182
+ description: "Require verification AND review to pass before advancing phases"
183
+ - label: "Git branching"
184
+ description: "Create a branch per phase for cleaner PR history"
185
+ ```
186
+
187
+ Apply selections:
188
+ - **Auto-continue**: Set `features.auto_continue: true`
189
+ - **TDD mode**: Set `features.tdd_mode: true`
190
+ - **Strict gates**: Set `gates.verification: true`, `gates.review: true`, `gates.plan_approval: true`
191
+ - **Git branching**: Set `git.branching_strategy: "phase"`
192
+
193
+ ---
194
+
195
+ ## Step 5: Verification
196
+
197
+ Run a quick health check:
198
+
199
+ 1. Verify `.planning/config.json` is valid JSON
200
+ 2. Verify `.planning/STATE.md` exists and is parseable
201
+ 3. Verify hook scripts are accessible: `node ${CLAUDE_PLUGIN_ROOT}/scripts/progress-tracker.js` from the project directory
202
+ 4. Check that `npm test` works (if package.json exists)
203
+
204
+ Display results:
205
+
206
+ ```
207
+ Setup Complete!
208
+
209
+ Project: {cwd basename}
210
+ Model profile: {balanced/quality/budget}
211
+ Depth: {quick/standard/comprehensive}
212
+ Features: {list of enabled non-default features}
213
+
214
+ Next steps:
215
+ /pbr:begin — Full project setup with requirements and roadmap
216
+ /pbr:scan — Analyze existing codebase (if adding to existing project)
217
+ /pbr:help — Command reference
218
+ /pbr:config — Fine-tune individual settings
219
+ ```
220
+
221
+ ---
222
+
223
+ ## Error Handling
224
+
225
+ - If `.planning/` creation fails (permissions): Tell user to create it manually and retry
226
+ - If config.json write fails: Display the JSON content and ask user to save it manually
227
+ - If health check fails: Display specific failure and suggest `/pbr:health` for diagnostics
@@ -0,0 +1,35 @@
1
+ # Commit Planning Docs Pattern
2
+
3
+ Standard pattern for committing planning artifacts to git. Reference this fragment in skills that create or modify `.planning/` files.
4
+
5
+ ---
6
+
7
+ ## Pattern
8
+
9
+ ```
10
+ If `planning.commit_docs: true` in config.json:
11
+ 1. Stage the relevant .planning/ files for this skill's output
12
+ 2. Commit with format: `docs({scope}): {description}`
13
+ 3. Use the appropriate scope from the skill's commit conventions
14
+
15
+ If `planning.commit_docs: false` or config.json missing:
16
+ - Skip the commit step
17
+ ```
18
+
19
+ ## Commit Messages by Skill
20
+
21
+ | Skill | Commit message format |
22
+ |-------|----------------------|
23
+ | build | `docs({phase}): add build summaries and verification` |
24
+ | plan | `docs({phase}): add phase plans` |
25
+ | review | `docs({phase}): add verification report` |
26
+ | begin | `chore: initialize plan-build-run project planning` |
27
+ | import | `docs({phase}): import external plans` |
28
+ | quick | `docs(planning): quick task {NNN} - {slug}` |
29
+ | scan | `docs(planning): initial codebase analysis` |
30
+ | explore | `docs(planning): capture explore session outputs` |
31
+ | debug | `docs(planning): open/resolve debug session {NNN}` |
32
+ | discuss | `docs(planning): capture phase {N} discussion decisions` |
33
+ | pause | `docs(planning): checkpoint phase {N} progress` |
34
+ | todo | `docs(planning): add/complete todo {NNN}` |
35
+ | milestone | `docs(planning): start/complete/audit milestone` |
@@ -0,0 +1,102 @@
1
+ # Config Loading Pattern
2
+
3
+ Standard pattern for loading `.planning/config.json` fields at the start of a skill invocation.
4
+
5
+ > Referenced by: build, plan, review, import, begin, quick, milestone, scan skills
6
+
7
+ ---
8
+
9
+ ## Tooling Shortcut
10
+
11
+ Instead of reading and parsing STATE.md, ROADMAP.md, and config.json manually, run:
12
+ ```bash
13
+ node ${CLAUDE_PLUGIN_ROOT}/scripts/pbr-tools.js state load
14
+ ```
15
+ This returns a JSON object with `config`, `state`, `roadmap`, `current_phase`, and `progress`. Falls back gracefully if the script is missing -- parse files manually in that case.
16
+
17
+ Additional tooling shortcuts:
18
+ - `plan-index <phase>` -- returns plan inventory (plan_id, wave, depends_on, autonomous, must_haves_count per plan)
19
+ - `phase-info <phase>` -- returns comprehensive phase status (verification, summaries, roadmap_status, filesystem_status, plan_count, completed)
20
+
21
+ ---
22
+
23
+ ## Standard Config Fields
24
+
25
+ These are the config.json fields commonly read by workflow skills. Each skill reads a subset depending on its needs.
26
+
27
+ ### Core Settings
28
+ ```
29
+ depth -- quick | standard | comprehensive
30
+ mode -- interactive | autonomous
31
+ ```
32
+
33
+ ### Feature Flags
34
+ ```
35
+ features.research_phase -- run researcher before planning
36
+ features.plan_checking -- validate plans via plan-checker agent
37
+ features.goal_verification -- run verifier after build
38
+ features.inline_verify -- per-task verification after each executor commit (opt-in)
39
+ features.atomic_commits -- require atomic commits per task
40
+ features.auto_continue -- write .auto-next signal on phase completion
41
+ features.auto_advance -- chain build->review->plan in autonomous mode
42
+ features.integration_verification -- check cross-phase integration
43
+ ```
44
+
45
+ ### Gate Flags
46
+ ```
47
+ gates.confirm_plan -- require user approval before building
48
+ gates.confirm_execute -- require user confirmation before executing build
49
+ gates.confirm_transition -- require confirmation before advancing to next phase
50
+ ```
51
+
52
+ ### Parallelization
53
+ ```
54
+ parallelization.enabled -- whether to run plans in parallel
55
+ parallelization.plan_level -- parallel at plan level (within a wave)
56
+ parallelization.max_concurrent_agents -- max simultaneous executors
57
+ ```
58
+
59
+ ### Planning
60
+ ```
61
+ planning.commit_docs -- commit planning docs after operations
62
+ planning.max_tasks_per_plan -- maximum tasks in a single plan
63
+ ```
64
+
65
+ ### Git
66
+ ```
67
+ git.commit_format -- commit message format
68
+ git.branching_strategy -- none | phase | milestone
69
+ ```
70
+
71
+ ### Models
72
+ ```
73
+ models.researcher -- model for researcher agent
74
+ models.planner -- model for planner agent
75
+ models.executor -- model for executor agent
76
+ models.verifier -- model for verifier agent
77
+ ```
78
+
79
+ ---
80
+
81
+ ## Config Field Matrix by Skill
82
+
83
+ | Field | build | plan | review | import | begin | quick | milestone |
84
+ |-------|-------|------|--------|--------|-------|-------|-----------|
85
+ | depth | | X | | | X | | |
86
+ | mode | X | X | X | | X | | |
87
+ | features.research_phase | | X | | | | | |
88
+ | features.plan_checking | | X | | X | | | |
89
+ | features.goal_verification | X | | X | | | | |
90
+ | features.inline_verify | X | | | | | | |
91
+ | features.atomic_commits | X | | | | | | |
92
+ | features.auto_continue | X | | | | | | |
93
+ | features.auto_advance | X | X | X | | | | |
94
+ | features.integration_verification | | | X | | | | X |
95
+ | gates.confirm_plan | | X | | | | | |
96
+ | gates.confirm_execute | X | | | | | | |
97
+ | gates.confirm_transition | | | X | | | | |
98
+ | parallelization.* | X | | | | | | |
99
+ | planning.commit_docs | X | | | | | X | X |
100
+ | git.commit_format | X | | | | X | X | |
101
+ | git.branching_strategy | X | | | | | | |
102
+ | models.* | | X | X | | X | | X |
@@ -0,0 +1,40 @@
1
+ # Context Budget Rules
2
+
3
+ Standard rules for keeping orchestrator context lean. Reference this fragment in skills that spawn Task() subagents.
4
+
5
+ See also: `skills/shared/universal-anti-patterns.md` for the complete set of universal rules (context budget + file reading + behavioral rules).
6
+
7
+ ---
8
+
9
+ ## Universal Rules
10
+
11
+ Every skill that spawns agents or reads significant content must follow these rules:
12
+
13
+ 1. **Never** read agent definition files (`agents/*.md`) — `subagent_type` auto-loads them
14
+ 2. **Never** inline large files into Task() prompts — tell agents to read files from disk instead
15
+ 3. **Minimize** reading subagent output into main context — read only frontmatter, not full content
16
+ 4. **Delegate** heavy work to subagents — the orchestrator routes, it doesn't execute
17
+ 5. **Before spawning agents**: If you've already consumed significant context (large file reads, multiple subagent results), warn the user: "Context budget is getting heavy. Consider running `/pbr:pause` to checkpoint progress." Suggest pause proactively rather than waiting for compaction.
18
+
19
+ ## Customization
20
+
21
+ Skills should add skill-specific rules below the reference line. Common skill-specific additions:
22
+
23
+ - **build**: "Minimize reading executor output — read only SUMMARY.md frontmatter, not full content"
24
+ - **plan**: "Minimize reading subagent output — read only plan frontmatter for summaries"
25
+ - **review**: "Minimize reading subagent output — read only VERIFICATION.md frontmatter for summaries"
26
+ - **scan**: "Delegate ALL analysis to the 4 parallel codebase-mapper subagents"
27
+ - **quick**: "Never implement the task yourself — ALL code changes go through a spawned executor"
28
+ - **debug**: "Never perform investigation work yourself — delegate ALL analysis to the debugger subagent"
29
+
30
+ Format in the SKILL.md:
31
+
32
+ ```markdown
33
+ ## Context Budget
34
+
35
+ Reference: `skills/shared/context-budget.md` for the universal orchestrator rules.
36
+
37
+ Additionally for this skill:
38
+ - {Skill-specific rule 1}
39
+ - {Skill-specific rule 2}
40
+ ```
@@ -0,0 +1,86 @@
1
+ # Context Loader Task Pattern
2
+
3
+ Standard pattern for spawning a lightweight Task() to build a project briefing before the main skill logic runs. Used by skills that need project context but want to keep the orchestrator lean.
4
+
5
+ > Referenced by: explore, scan, discuss skills (and any skill that needs a project briefing before interactive work)
6
+
7
+ ---
8
+
9
+ ## When to Use
10
+
11
+ Use this pattern when:
12
+ - The skill runs mostly inline (conversation, presentation) rather than delegating to agents
13
+ - The skill needs awareness of project state, decisions, and progress
14
+ - Reading all context files directly would consume too much orchestrator context
15
+
16
+ Do NOT use this pattern when:
17
+ - The skill already uses `pbr-tools.js state load` (build, plan, review, import)
18
+ - The skill reads only STATE.md lines 1-20 (continue, status, resume)
19
+ - The skill has no project dependency (note with `--global`)
20
+
21
+ ---
22
+
23
+ ## Pattern: Briefing Task
24
+
25
+ ```
26
+ Task({
27
+ prompt: "Read the following files and return a ~500 token briefing summarizing the project state, key decisions, and any context relevant to {skill_purpose}:
28
+ - .planning/STATE.md
29
+ - .planning/ROADMAP.md
30
+ - .planning/REQUIREMENTS.md
31
+ - .planning/CONTEXT.md
32
+ - Any .planning/phases/*/CONTEXT.md files
33
+ - .planning/research/SUMMARY.md (if exists)
34
+ - .planning/NOTES.md (if exists)
35
+ - .planning/HISTORY.md (if exists — scan for decisions relevant to current work only, do NOT summarize all history)
36
+
37
+ Return ONLY the briefing text. No preamble, no suggestions."
38
+ })
39
+ ```
40
+
41
+ ### Key Rules
42
+
43
+ 1. **Only runs if `.planning/` directory exists.** Skills invoked on fresh projects with no planning directory skip this entirely.
44
+ 2. **Budget: ~500 tokens.** The briefing must be concise. The subagent reads full files in its own context; the orchestrator receives only the summary.
45
+ 3. **No suggestions.** The briefing reports state, it does not recommend actions. The skill logic decides what to do.
46
+ 4. **Read-only.** The briefing task must not write any files.
47
+
48
+ ### Using the Briefing
49
+
50
+ After the task completes:
51
+ - Use the briefing to inform conversation -- reference existing decisions, avoid re-litigating settled questions
52
+ - Connect new ideas or findings to existing project structure
53
+ - Identify relevant phases, requirements, or decisions without reading the source files yourself
54
+
55
+ ---
56
+
57
+ ## Variation: Topic-Scoped Briefing
58
+
59
+ When the skill has a specific topic (e.g., `/pbr:explore auth`), scope the briefing:
60
+
61
+ ```
62
+ Task({
63
+ prompt: "Read the following files and return a ~500 token briefing focused on {topic}:
64
+ - .planning/STATE.md
65
+ - .planning/ROADMAP.md
66
+ - .planning/REQUIREMENTS.md
67
+ - .planning/CONTEXT.md
68
+ - Any .planning/phases/*/CONTEXT.md files
69
+ - .planning/HISTORY.md (if exists — scan for decisions relevant to '{topic}' only, do NOT summarize all history)
70
+
71
+ Focus on: decisions, requirements, and phase goals related to '{topic}'.
72
+ Return ONLY the briefing text. No preamble, no suggestions."
73
+ })
74
+ ```
75
+
76
+ ---
77
+
78
+ ## Variation: Scan Reconnaissance
79
+
80
+ For `/pbr:scan`, the pattern adapts to codebase analysis rather than project state:
81
+
82
+ 1. The orchestrator performs a quick inline scan (detect project type, scale, key directories)
83
+ 2. Writes the results to `.planning/codebase/RECON.md`
84
+ 3. Passes RECON.md content to the spawned analysis agents as baseline context
85
+
86
+ This is the same principle (build context before main work) but the source is the codebase rather than planning files.
@@ -0,0 +1,79 @@
1
+ # Digest-Select Pattern
2
+
3
+ Selective reading depth for prior phase SUMMARY.md files. Saves tokens by reading only what is needed based on the relationship to the current phase.
4
+
5
+ > Referenced by: plan, build, import skills
6
+
7
+ ---
8
+
9
+ ## Depth Rules
10
+
11
+ Not all prior phase SUMMARYs need the same level of detail. Use selective depth based on dependency distance:
12
+
13
+ | Relationship to current phase | Read depth |
14
+ |-------------------------------|------------|
15
+ | Direct dependency (listed in `depends_on` in ROADMAP.md) | Frontmatter + "Key Decisions" section. The subagent reads full bodies from disk in its own context. |
16
+ | 1 phase back from a dependency (transitive) | Frontmatter only (`provides`, `key_files`, `key_decisions`, `patterns`) |
17
+ | 2+ phases back | Skip entirely |
18
+
19
+ ---
20
+
21
+ ## Example
22
+
23
+ If planning Phase 5 which depends on Phase 4, and Phase 4 depends on Phase 3:
24
+ - Phase 4 SUMMARYs: frontmatter + "Key Decisions" section
25
+ - Phase 3 SUMMARYs: frontmatter only
26
+ - Phases 1-2 SUMMARYs: skip
27
+
28
+ This saves ~500 tokens per skipped SUMMARY for large projects.
29
+
30
+ ---
31
+
32
+ ## How to Determine Dependency Distance
33
+
34
+ 1. Read ROADMAP.md and find the current phase's `depends_on` list
35
+ 2. Those are the **direct dependencies** (distance 1) -- read frontmatter + key decisions
36
+ 3. For each direct dependency, find ITS `depends_on` list -- those are **transitive** (distance 2) -- read frontmatter only
37
+ 4. Everything else (distance 3+) -- skip
38
+
39
+ ---
40
+
41
+ ## Frontmatter Fields to Extract
42
+
43
+ When reading frontmatter only (transitive dependencies), extract these fields:
44
+
45
+ ```yaml
46
+ status: complete
47
+ provides:
48
+ - "user authentication API"
49
+ - "session management middleware"
50
+ key_files:
51
+ - src/auth/controller.ts
52
+ - src/auth/middleware.ts
53
+ key_decisions:
54
+ - "JWT with refresh tokens"
55
+ - "bcrypt for password hashing"
56
+ patterns:
57
+ - "repository pattern for data access"
58
+ - "middleware chain for auth checks"
59
+ ```
60
+
61
+ These fields give downstream skills enough context to build on prior work without reading the full SUMMARY body.
62
+
63
+ ---
64
+
65
+ ## Skill-Specific Notes
66
+
67
+ ### /pbr:plan
68
+ - Direct dependencies: frontmatter + "Key Decisions" section (planner reads full bodies from disk)
69
+ - Used in Step 2: Load Context
70
+
71
+ ### /pbr:build
72
+ - Direct dependencies (completed earlier waves): frontmatter only for prior work table
73
+ - Used in Step 6a: Spawn Executors (prior_work section of executor prompt)
74
+
75
+ ### /pbr:import
76
+ - Direct dependencies: full SUMMARY body (needed for conflict detection)
77
+ - Transitive: frontmatter only
78
+ - 2+ back: skip
79
+ - Used in Step 2: Load Full Project Context