@sienklogic/plan-build-run 2.12.0 → 2.12.1

package/plan-build-run/workflows/help.md

@@ -0,0 +1,470 @@
+<purpose>
+Display the complete PBR command reference. Output ONLY the reference content. Do NOT add project-specific analysis, git status, next-step suggestions, or any commentary beyond the reference.
+</purpose>
+
+<reference>
+# PBR Command Reference
+
+**PBR** (Plan-Build-Run) creates hierarchical project plans optimized for solo agentic development with Claude Code.
+
+## Quick Start
+
+1. `/pbr:new-project` - Initialize project (includes research, requirements, roadmap)
+2. `/pbr:plan-phase 1` - Create detailed plan for first phase
+3. `/pbr:execute-phase 1` - Execute the phase
+
+## Staying Updated
+
+PBR evolves fast. Update periodically:
+
+```bash
+npx plan-build-run-cc@latest
+```
+
+## Core Workflow
+
+```
+/pbr:new-project → /pbr:plan-phase → /pbr:execute-phase → repeat
+```
+
+### Project Initialization
+
+**`/pbr:new-project`**
+Initialize new project through unified flow.
+
+One command takes you from idea to ready-for-planning:
+- Deep questioning to understand what you're building
+- Optional domain research (spawns 4 parallel researcher agents)
+- Requirements definition with v1/v2/out-of-scope scoping
+- Roadmap creation with phase breakdown and success criteria
+
+Creates all `.planning/` artifacts:
+- `PROJECT.md` — vision and requirements
+- `config.json` — workflow mode (interactive/yolo)
+- `research/` — domain research (if selected)
+- `REQUIREMENTS.md` — scoped requirements with REQ-IDs
+- `ROADMAP.md` — phases mapped to requirements
+- `STATE.md` — project memory
+
+Usage: `/pbr:new-project`
+
+**`/pbr:map-codebase`**
+Map an existing codebase for brownfield projects.
+
+- Analyzes codebase with parallel Explore agents
+- Creates `.planning/codebase/` with 7 focused documents
+- Covers stack, architecture, structure, conventions, testing, integrations, concerns
+- Use before `/pbr:new-project` on existing codebases
+
+Usage: `/pbr:map-codebase`
+
+### Phase Planning
+
+**`/pbr:discuss-phase <number>`**
+Help articulate your vision for a phase before planning.
+
+- Captures how you imagine this phase working
+- Creates CONTEXT.md with your vision, essentials, and boundaries
+- Use when you have ideas about how something should look/feel
+
+Usage: `/pbr:discuss-phase 2`
+
+**`/pbr:research-phase <number>`**
+Comprehensive ecosystem research for niche/complex domains.
+
+- Discovers standard stack, architecture patterns, pitfalls
+- Creates RESEARCH.md with "how experts build this" knowledge
+- Use for 3D, games, audio, shaders, ML, and other specialized domains
+- Goes beyond "which library" to ecosystem knowledge
+
+Usage: `/pbr:research-phase 3`
+
+**`/pbr:list-phase-assumptions <number>`**
+See what Claude is planning to do before it starts.
+
+- Shows Claude's intended approach for a phase
+- Lets you course-correct if Claude misunderstood your vision
+- No files created - conversational output only
+
+Usage: `/pbr:list-phase-assumptions 3`
+
+**`/pbr:plan-phase <number>`**
+Create detailed execution plan for a specific phase.
+
+- Generates `.planning/phases/XX-phase-name/XX-YY-PLAN.md`
+- Breaks phase into concrete, actionable tasks
+- Includes verification criteria and success measures
+- Multiple plans per phase supported (XX-01, XX-02, etc.)
+
+Usage: `/pbr:plan-phase 1`
+Result: Creates `.planning/phases/01-foundation/01-01-PLAN.md`
+
+### Execution
+
+**`/pbr:execute-phase <phase-number>`**
+Execute all plans in a phase.
+
+- Groups plans by wave (from frontmatter), executes waves sequentially
+- Plans within each wave run in parallel via Task tool
+- Verifies phase goal after all plans complete
+- Updates REQUIREMENTS.md, ROADMAP.md, STATE.md
+
+Usage: `/pbr:execute-phase 5`
+
+### Quick Mode
+
+**`/pbr:quick`**
+Execute small, ad-hoc tasks with PBR guarantees but skip optional agents.
+
+Quick mode uses the same system with a shorter path:
+- Spawns planner + executor (skips researcher, checker, verifier)
+- Quick tasks live in `.planning/quick/` separate from planned phases
+- Updates STATE.md tracking (not ROADMAP.md)
+
+Use when you know exactly what to do and the task is small enough to not need research or verification.
+
+Usage: `/pbr:quick`
+Result: Creates `.planning/quick/NNN-slug/PLAN.md`, `.planning/quick/NNN-slug/SUMMARY.md`
+
+### Roadmap Management
+
+**`/pbr:add-phase <description>`**
+Add new phase to end of current milestone.
+
+- Appends to ROADMAP.md
+- Uses next sequential number
+- Updates phase directory structure
+
+Usage: `/pbr:add-phase "Add admin dashboard"`
+
+**`/pbr:insert-phase <after> <description>`**
+Insert urgent work as decimal phase between existing phases.
+
+- Creates intermediate phase (e.g., 7.1 between 7 and 8)
+- Useful for discovered work that must happen mid-milestone
+- Maintains phase ordering
+
+Usage: `/pbr:insert-phase 7 "Fix critical auth bug"`
+Result: Creates Phase 7.1
+
+**`/pbr:remove-phase <number>`**
+Remove a future phase and renumber subsequent phases.
+
+- Deletes phase directory and all references
+- Renumbers all subsequent phases to close the gap
+- Only works on future (unstarted) phases
+- Git commit preserves historical record
+
+Usage: `/pbr:remove-phase 17`
+Result: Phase 17 deleted, phases 18-20 become 17-19
+
+### Milestone Management
+
+**`/pbr:new-milestone <name>`**
+Start a new milestone through unified flow.
+
+- Deep questioning to understand what you're building next
+- Optional domain research (spawns 4 parallel researcher agents)
+- Requirements definition with scoping
+- Roadmap creation with phase breakdown
+
+Mirrors `/pbr:new-project` flow for brownfield projects (existing PROJECT.md).
+
+Usage: `/pbr:new-milestone "v2.0 Features"`
+
+**`/pbr:complete-milestone <version>`**
+Archive completed milestone and prepare for next version.
+
+- Creates MILESTONES.md entry with stats
+- Archives full details to milestones/ directory
+- Creates git tag for the release
+- Prepares workspace for next version
+
+Usage: `/pbr:complete-milestone 1.0.0`
+
+### Progress Tracking
+
+**`/pbr:progress`**
+Check project status and intelligently route to next action.
+
+- Shows visual progress bar and completion percentage
+- Summarizes recent work from SUMMARY files
+- Displays current position and what's next
+- Lists key decisions and open issues
+- Offers to execute next plan or create it if missing
+- Detects 100% milestone completion
+
+Usage: `/pbr:progress`
+
+### Session Management
+
+**`/pbr:resume-work`**
+Resume work from previous session with full context restoration.
+
+- Reads STATE.md for project context
+- Shows current position and recent progress
+- Offers next actions based on project state
+
+Usage: `/pbr:resume-work`
+
+**`/pbr:pause-work`**
+Create context handoff when pausing work mid-phase.
+
+- Creates .continue-here file with current state
+- Updates STATE.md session continuity section
+- Captures in-progress work context
+
+Usage: `/pbr:pause-work`
+
+### Debugging
+
+**`/pbr:debug [issue description]`**
+Systematic debugging with persistent state across context resets.
+
+- Gathers symptoms through adaptive questioning
+- Creates `.planning/debug/[slug].md` to track investigation
+- Investigates using scientific method (evidence → hypothesis → test)
+- Survives `/clear` — run `/pbr:debug` with no args to resume
+- Archives resolved issues to `.planning/debug/resolved/`
+
+Usage: `/pbr:debug "login button doesn't work"`
+Usage: `/pbr:debug` (resume active session)
+
+### Todo Management
+
+**`/pbr:add-todo [description]`**
+Capture idea or task as todo from current conversation.
+
+- Extracts context from conversation (or uses provided description)
+- Creates structured todo file in `.planning/todos/pending/`
+- Infers area from file paths for grouping
+- Checks for duplicates before creating
+- Updates STATE.md todo count
+
+Usage: `/pbr:add-todo` (infers from conversation)
+Usage: `/pbr:add-todo Add auth token refresh`
+
+**`/pbr:check-todos [area]`**
+List pending todos and select one to work on.
+
+- Lists all pending todos with title, area, age
+- Optional area filter (e.g., `/pbr:check-todos api`)
+- Loads full context for selected todo
+- Routes to appropriate action (work now, add to phase, brainstorm)
+- Moves todo to done/ when work begins
+
+Usage: `/pbr:check-todos`
+Usage: `/pbr:check-todos api`
+
+### User Acceptance Testing
+
+**`/pbr:verify-work [phase]`**
+Validate built features through conversational UAT.
+
+- Extracts testable deliverables from SUMMARY.md files
+- Presents tests one at a time (yes/no responses)
+- Automatically diagnoses failures and creates fix plans
+- Ready for re-execution if issues found
+
+Usage: `/pbr:verify-work 3`
+
+### Milestone Auditing
+
+**`/pbr:audit-milestone [version]`**
+Audit milestone completion against original intent.
+
+- Reads all phase VERIFICATION.md files
+- Checks requirements coverage
+- Spawns integration checker for cross-phase wiring
+- Creates MILESTONE-AUDIT.md with gaps and tech debt
+
+Usage: `/pbr:audit-milestone`
+
+**`/pbr:plan-milestone-gaps`**
+Create phases to close gaps identified by audit.
+
+- Reads MILESTONE-AUDIT.md and groups gaps into phases
+- Prioritizes by requirement priority (must/should/nice)
+- Adds gap closure phases to ROADMAP.md
+- Ready for `/pbr:plan-phase` on new phases
+
+Usage: `/pbr:plan-milestone-gaps`
+
+### Configuration
+
+**`/pbr:settings`**
+Configure workflow toggles and model profile interactively.
+
+- Toggle researcher, plan checker, verifier agents
+- Select model profile (quality/balanced/budget)
+- Updates `.planning/config.json`
+
+Usage: `/pbr:settings`
+
+**`/pbr:set-profile <profile>`**
+Quick switch model profile for PBR agents.
+
+- `quality` — Opus everywhere except verification
+- `balanced` — Opus for planning, Sonnet for execution (default)
+- `budget` — Sonnet for writing, Haiku for research/verification
+
+Usage: `/pbr:set-profile budget`
+
+### Utility Commands
+
+**`/pbr:help`**
+Show this command reference.
+
+**`/pbr:update`**
+Update PBR to latest version with changelog preview.
+
+- Shows installed vs latest version comparison
+- Displays changelog entries for versions you've missed
+- Highlights breaking changes
+- Confirms before running install
+- Better than raw `npx plan-build-run-cc`
+
+Usage: `/pbr:update`
+
+**`/pbr:join-discord`**
+Join the PBR Discord community.
+
+- Get help, share what you're building, stay updated
+- Connect with other PBR users
+
+Usage: `/pbr:join-discord`
+
+## Files & Structure
+
+```
+.planning/
+├── PROJECT.md            # Project vision
+├── ROADMAP.md            # Current phase breakdown
+├── STATE.md              # Project memory & context
+├── config.json           # Workflow mode & gates
+├── todos/                # Captured ideas and tasks
+│   ├── pending/          # Todos waiting to be worked on
+│   └── done/             # Completed todos
+├── debug/                # Active debug sessions
+│   └── resolved/         # Archived resolved issues
+├── codebase/             # Codebase map (brownfield projects)
+│   ├── STACK.md          # Languages, frameworks, dependencies
+│   ├── ARCHITECTURE.md   # Patterns, layers, data flow
+│   ├── STRUCTURE.md      # Directory layout, key files
+│   ├── CONVENTIONS.md    # Coding standards, naming
+│   ├── TESTING.md        # Test setup, patterns
+│   ├── INTEGRATIONS.md   # External services, APIs
+│   └── CONCERNS.md       # Tech debt, known issues
+└── phases/
+    ├── 01-foundation/
+    │   ├── 01-01-PLAN.md
+    │   └── 01-01-SUMMARY.md
+    └── 02-core-features/
+        ├── 02-01-PLAN.md
+        └── 02-01-SUMMARY.md
+```
+
+## Workflow Modes
+
+Set during `/pbr:new-project`:
+
+**Interactive Mode**
+
+- Confirms each major decision
+- Pauses at checkpoints for approval
+- More guidance throughout
+
+**YOLO Mode**
+
+- Auto-approves most decisions
+- Executes plans without confirmation
+- Only stops for critical checkpoints
+
+Change anytime by editing `.planning/config.json`
+
+## Planning Configuration
+
+Configure how planning artifacts are managed in `.planning/config.json`:
+
+**`planning.commit_docs`** (default: `true`)
+- `true`: Planning artifacts committed to git (standard workflow)
+- `false`: Planning artifacts kept local-only, not committed
+
+When `commit_docs: false`:
+- Add `.planning/` to your `.gitignore`
+- Useful for OSS contributions, client projects, or keeping planning private
+- All planning files still work normally, just not tracked in git
+
+**`planning.search_gitignored`** (default: `false`)
+- `true`: Add `--no-ignore` to broad ripgrep searches
+- Only needed when `.planning/` is gitignored and you want project-wide searches to include it
+
+Example config:
+```json
+{
+  "planning": {
+    "commit_docs": false,
+    "search_gitignored": true
+  }
+}
+```
+
+## Common Workflows
+
+**Starting a new project:**
+
+```
+/pbr:new-project        # Unified flow: questioning → research → requirements → roadmap
+/clear
+/pbr:plan-phase 1       # Create plans for first phase
+/clear
+/pbr:execute-phase 1    # Execute all plans in phase
+```
+
+**Resuming work after a break:**
+
+```
+/pbr:progress  # See where you left off and continue
+```
+
+**Adding urgent mid-milestone work:**
+
+```
+/pbr:insert-phase 5 "Critical security fix"
+/pbr:plan-phase 5.1
+/pbr:execute-phase 5.1
+```
+
+**Completing a milestone:**
+
+```
+/pbr:complete-milestone 1.0.0
+/clear
+/pbr:new-milestone  # Start next milestone (questioning → research → requirements → roadmap)
+```
+
+**Capturing ideas during work:**
+
+```
+/pbr:add-todo                    # Capture from conversation context
+/pbr:add-todo Fix modal z-index  # Capture with explicit description
+/pbr:check-todos                 # Review and work on todos
+/pbr:check-todos api             # Filter by area
+```
+
+**Debugging an issue:**
+
+```
+/pbr:debug "form submission fails silently"  # Start debug session
+# ... investigation happens, context fills up ...
+/clear
+/pbr:debug                                    # Resume from where you left off
+```
+
+## Getting Help
+
+- Read `.planning/PROJECT.md` for project vision
+- Read `.planning/STATE.md` for current context
+- Check `.planning/ROADMAP.md` for phase status
+- Run `/pbr:progress` to check where you're up to
+</reference>

package/plan-build-run/workflows/insert-phase.md

@@ -0,0 +1,129 @@
+<purpose>
+Insert a decimal phase for urgent work discovered mid-milestone between existing integer phases. Uses decimal numbering (72.1, 72.2, etc.) to preserve the logical sequence of planned phases while accommodating urgent insertions without renumbering the entire roadmap.
+</purpose>
+
+<required_reading>
+Read all files referenced by the invoking prompt's execution_context before starting.
+</required_reading>
+
+<process>
+
+<step name="parse_arguments">
+Parse the command arguments:
+- First argument: integer phase number to insert after
+- Remaining arguments: phase description
+
+Example: `/pbr:insert-phase 72 Fix critical auth bug`
+-> after = 72
+-> description = "Fix critical auth bug"
+
+If arguments missing:
+
+```
+ERROR: Both phase number and description required
+Usage: /pbr:insert-phase <after> <description>
+Example: /pbr:insert-phase 72 Fix critical auth bug
+```
+
+Exit.
+
+Validate first argument is an integer.
+</step>
+
+<step name="init_context">
+Load phase operation context:
+
+```bash
+INIT=$(node ~/.claude/plan-build-run/scripts/pbr-tools.cjs init phase-op "${after_phase}")
+```
+
+Check `roadmap_exists` from init JSON. If false:
+```
+ERROR: No roadmap found (.planning/ROADMAP.md)
+```
+Exit.
+</step>
+
+<step name="insert_phase">
+**Delegate the phase insertion to pbr-tools:**
+
+```bash
+RESULT=$(node ~/.claude/plan-build-run/scripts/pbr-tools.cjs phase insert "${after_phase}" "${description}")
+```
+
+The CLI handles:
+- Verifying target phase exists in ROADMAP.md
+- Calculating next decimal phase number (checking existing decimals on disk)
+- Generating slug from description
+- Creating the phase directory (`.planning/phases/{N.M}-{slug}/`)
+- Inserting the phase entry into ROADMAP.md after the target phase with (INSERTED) marker
+
+Extract from result: `phase_number`, `after_phase`, `name`, `slug`, `directory`.
+</step>
+
+<step name="update_project_state">
+Update STATE.md to reflect the inserted phase:
+
+1. Read `.planning/STATE.md`
+2. Under "## Accumulated Context" → "### Roadmap Evolution" add entry:
+   ```
+   - Phase {decimal_phase} inserted after Phase {after_phase}: {description} (URGENT)
+   ```
+
+If "Roadmap Evolution" section doesn't exist, create it.
+</step>
+
+<step name="completion">
+Present completion summary:
+
+```
+Phase {decimal_phase} inserted after Phase {after_phase}:
+- Description: {description}
+- Directory: .planning/phases/{decimal-phase}-{slug}/
+- Status: Not planned yet
+- Marker: (INSERTED) - indicates urgent work
+
+Roadmap updated: .planning/ROADMAP.md
+Project state updated: .planning/STATE.md
+
+---
+
+## Next Up
+
+**Phase {decimal_phase}: {description}** -- urgent insertion
+
+`/pbr:plan-phase {decimal_phase}`
+
+<sub>`/clear` first -> fresh context window</sub>
+
+---
+
+**Also available:**
+- Review insertion impact: Check if Phase {next_integer} dependencies still make sense
+- Review roadmap
+
+---
+```
+</step>
+
+</process>
+
+<anti_patterns>
+
+- Don't use this for planned work at end of milestone (use /pbr:add-phase)
+- Don't insert before Phase 1 (decimal 0.1 makes no sense)
+- Don't renumber existing phases
+- Don't modify the target phase content
+- Don't create plans yet (that's /pbr:plan-phase)
+- Don't commit changes (user decides when to commit)
+</anti_patterns>
+
+<success_criteria>
+Phase insertion is complete when:
+
+- [ ] `pbr-tools phase insert` executed successfully
+- [ ] Phase directory created
+- [ ] Roadmap updated with new phase entry (includes "(INSERTED)" marker)
+- [ ] STATE.md updated with roadmap evolution note
+- [ ] User informed of next steps and dependency implications
+</success_criteria>