@sienklogic/plan-build-run 2.55.0 → 2.56.1

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 (29) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +76 -28
  3. package/package.json +1 -1
  4. package/plugins/codex-pbr/.codex/config.toml +101 -0
  5. package/plugins/codex-pbr/AGENTS.md +653 -0
  6. package/plugins/codex-pbr/README.md +116 -0
  7. package/plugins/codex-pbr/references/pbr-tools-cli.md +2 -2
  8. package/plugins/codex-pbr/skills/health/SKILL.md +1 -1
  9. package/plugins/codex-pbr/skills/shared/state-update.md +1 -1
  10. package/plugins/copilot-pbr/plugin.json +1 -1
  11. package/plugins/copilot-pbr/references/pbr-tools-cli.md +2 -2
  12. package/plugins/copilot-pbr/skills/begin/templates/STATE.md.tmpl +0 -1
  13. package/plugins/copilot-pbr/skills/health/SKILL.md +1 -1
  14. package/plugins/copilot-pbr/skills/shared/state-update.md +1 -1
  15. package/plugins/cursor-pbr/.cursor-plugin/plugin.json +1 -1
  16. package/plugins/cursor-pbr/references/pbr-tools-cli.md +2 -2
  17. package/plugins/cursor-pbr/skills/begin/templates/STATE.md.tmpl +0 -1
  18. package/plugins/cursor-pbr/skills/health/SKILL.md +1 -1
  19. package/plugins/cursor-pbr/skills/shared/state-update.md +1 -1
  20. package/plugins/pbr/.claude-plugin/plugin.json +1 -1
  21. package/plugins/pbr/references/pbr-tools-cli.md +2 -2
  22. package/plugins/pbr/scripts/check-plan-format.js +5 -6
  23. package/plugins/pbr/scripts/check-state-sync.js +0 -5
  24. package/plugins/pbr/scripts/lib/state.js +1 -3
  25. package/plugins/pbr/scripts/pbr-tools.js +1 -1
  26. package/plugins/pbr/scripts/status-line.js +3 -4
  27. package/plugins/pbr/skills/begin/templates/STATE.md.tmpl +0 -1
  28. package/plugins/pbr/skills/health/SKILL.md +1 -1
  29. package/plugins/pbr/skills/shared/state-update.md +1 -1
package/CHANGELOG.md CHANGED
@@ -5,6 +5,25 @@ All notable changes to Plan-Build-Run will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [2.56.1](https://github.com/SienkLogic/plan-build-run/compare/plan-build-run-v2.56.0...plan-build-run-v2.56.1) (2026-03-03)
9
+
10
+
11
+ ### Documentation
12
+
13
+ * **quick-020:** comprehensively update documentation for v2.56.0 ([82f9177](https://github.com/SienkLogic/plan-build-run/commit/82f917792dd573192c4ce69df8633f13b1050b0a))
14
+
15
+ ## [2.56.0](https://github.com/SienkLogic/plan-build-run/compare/plan-build-run-v2.55.0...plan-build-run-v2.56.0) (2026-03-02)
16
+
17
+
18
+ ### Features
19
+
20
+ * **58-02:** add Codex manual files (AGENTS.md, config.toml, README) ([c928ea6](https://github.com/SienkLogic/plan-build-run/commit/c928ea6d7170ce5c2b97bf5fe11505046f008396))
21
+
22
+
23
+ ### Bug Fixes
24
+
25
+ * **58-02:** correct repo URL in codex-pbr README ([1b13b2a](https://github.com/SienkLogic/plan-build-run/commit/1b13b2a4799fa9827abf82feda4f87c2c65e2880))
26
+
8
27
  ## [2.55.0](https://github.com/SienkLogic/plan-build-run/compare/plan-build-run-v2.54.0...plan-build-run-v2.55.0) (2026-03-02)
9
28
 
10
29
 
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  </p>
4
4
 
5
5
  <p align="center">
6
- <strong>Context-engineered development workflow for Claude Code, Cursor, and GitHub Copilot CLI.</strong>
6
+ <strong>Context-engineered development workflow for Claude Code, Cursor, GitHub Copilot CLI, OpenAI Codex, and Google Jules.</strong>
7
7
  <br />
8
8
  Build ambitious multi-phase software without quality degradation.
9
9
  <br />
@@ -27,7 +27,7 @@
27
27
  <img src="https://img.shields.io/badge/Node.js-18%2B-339933?style=for-the-badge&logo=node.js&logoColor=white" alt="Node.js 18+" />
28
28
  <a href="LICENSE"><img src="https://img.shields.io/github/license/SienkLogic/plan-build-run?style=for-the-badge" alt="License" /></a>
29
29
  <a href="https://www.npmjs.com/package/@sienklogic/plan-build-run"><img src="https://img.shields.io/npm/v/@sienklogic/plan-build-run?style=for-the-badge&logo=npm&logoColor=white" alt="npm" /></a>
30
- <img src="https://img.shields.io/badge/Tests-2153_passing-brightgreen?style=for-the-badge" alt="2153 Tests" />
30
+ <img src="https://img.shields.io/badge/Tests-9283_passing-brightgreen?style=for-the-badge" alt="9283 Tests" />
31
31
  </p>
32
32
 
33
33
  ---
@@ -132,6 +132,48 @@ All three plugins share the same `.planning/` directory — start in any tool, c
132
132
 
133
133
  </details>
134
134
 
135
+ <details>
136
+ <summary><strong>Install for OpenAI Codex CLI</strong></summary>
137
+
138
+ Plan-Build-Run also works in OpenAI Codex CLI. Skills and agents are available via the `plugins/codex-pbr/` plugin. No hooks (Codex CLI does not support lifecycle hooks).
139
+
140
+ **macOS / Linux:**
141
+ ```bash
142
+ cd /path/to/your/project
143
+ bash /path/to/plan-build-run/plugins/codex-pbr/setup.sh
144
+ ```
145
+
146
+ **Windows (PowerShell):**
147
+ ```powershell
148
+ cd C:\path\to\your\project
149
+ powershell -ExecutionPolicy Bypass -File C:\path\to\plan-build-run\plugins\codex-pbr\setup.ps1
150
+ ```
151
+
152
+ All five plugins share the same `.planning/` directory. See [`plugins/codex-pbr/README.md`](plugins/codex-pbr/README.md) for full details.
153
+
154
+ </details>
155
+
156
+ <details>
157
+ <summary><strong>Install for Google Jules</strong></summary>
158
+
159
+ Plan-Build-Run also works in Google Jules. Skills and agents are available via the `plugins/jules-pbr/` plugin. No hooks (Jules does not support lifecycle hooks).
160
+
161
+ **macOS / Linux:**
162
+ ```bash
163
+ cd /path/to/your/project
164
+ bash /path/to/plan-build-run/plugins/jules-pbr/setup.sh
165
+ ```
166
+
167
+ **Windows (PowerShell):**
168
+ ```powershell
169
+ cd C:\path\to\your\project
170
+ powershell -ExecutionPolicy Bypass -File C:\path\to\plan-build-run\plugins\jules-pbr\setup.ps1
171
+ ```
172
+
173
+ All five plugins share the same `.planning/` directory. See [`plugins/jules-pbr/README.md`](plugins/jules-pbr/README.md) for full details.
174
+
175
+ </details>
176
+
135
177
  <details>
136
178
  <summary><strong>Dashboard (Optional)</strong></summary>
137
179
 
@@ -219,7 +261,7 @@ Set `depth: quick` in `/pbr:config` to reduce agent spawns across all workflows.
219
261
  | `/pbr:build <N>` | Build a phase: parallel execution in waves, atomic commits | 2-4 (quick: 1-2) |
220
262
  | `/pbr:review <N>` | Verify a phase: automated 3-layer checks + conversational UAT | 1 |
221
263
 
222
- See **[Commands](https://github.com/SienkLogic/plan-build-run/wiki/Commands)** for all 26 commands with flags, cost-by-depth tables, and detailed descriptions.
264
+ See **[Commands](https://github.com/SienkLogic/plan-build-run/wiki/Commands)** for all 27 commands with flags, cost-by-depth tables, and detailed descriptions.
223
265
 
224
266
  ---
225
267
 
@@ -292,8 +334,8 @@ Requires a GPU with 6+ GB VRAM for best performance. CPU-only works but adds lat
292
334
  | Topic | Description |
293
335
  |-------|-------------|
294
336
  | **[Agents](https://github.com/SienkLogic/plan-build-run/wiki/Agents)** | 12 specialized agents with configurable model profiles and file-based communication |
295
- | **[Configuration](https://github.com/SienkLogic/plan-build-run/wiki/Configuration)** | 13 config keys, depth/model profiles, 16+ feature toggles, local LLM settings |
296
- | **[Hooks](https://github.com/SienkLogic/plan-build-run/wiki/Hooks)** | 38 hook scripts that enforce discipline at zero token cost |
337
+ | **[Configuration](https://github.com/SienkLogic/plan-build-run/wiki/Configuration)** | 12 config keys, depth/model profiles, 14+ feature toggles, local LLM settings |
338
+ | **[Hooks](https://github.com/SienkLogic/plan-build-run/wiki/Hooks)** | 41 hook scripts that enforce discipline at zero token cost |
297
339
  | **[Local LLM](https://github.com/SienkLogic/plan-build-run/wiki/Configuration#local_llm)** | Offload hook-level inference to Ollama for token savings with automatic fallback |
298
340
  | **[Project Structure](https://github.com/SienkLogic/plan-build-run/wiki/Project-Structure)** | The `.planning/` directory layout, key files, and file ownership |
299
341
  | **[Dashboard](https://github.com/SienkLogic/plan-build-run/wiki/Dashboard)** | Web UI with live updates for browsing project state |
@@ -306,28 +348,29 @@ Requires a GPU with 6+ GB VRAM for best performance. CPU-only works but adds lat
306
348
 
307
349
  ## Platform Compatibility
308
350
 
309
- Plan-Build-Run works across three platforms with varying levels of hook support. Hooks are the mechanism that fires validation scripts on every tool call — they power local LLM offloading, commit format enforcement, context budget tracking, and workflow gates.
310
-
311
- | Feature | Claude Code | Copilot CLI | Cursor IDE |
312
- |---------|:-----------:|:-----------:|:----------:|
313
- | Skills (slash commands) | All 26 | All 26 | All 26 |
314
- | Agents (subagent delegation) | All 12 | All 12 | All 12 |
315
- | `.planning/` state management | Full | Full | Full |
316
- | **Hook support** | **Full (14 events)** | **Partial (4 events)** | **Unverified** |
317
- | Commit format enforcement | Hook-enforced | Hook-enforced | Manual |
318
- | PLAN/SUMMARY quality classification | Hook + skill fallback | Hook + skill fallback | Skill fallback only |
319
- | Test failure triage | Automatic (hook) | Automatic (hook) | Not available |
320
- | Context budget tracking | Automatic (hook) | Not available | Not available |
321
- | Auto-continue between skills | Automatic (hook) | Not available | Not available |
322
- | Subagent lifecycle logging | Automatic (hook) | Not available | Not available |
323
- | **Local LLM offloading** | **Full (8 operations)** | **Mostly (6-7 operations)** | **CLI only** |
324
- | `pbr-tools.js llm` CLI commands | Full | Full | Full |
351
+ Plan-Build-Run works across five platforms with varying levels of hook support. Hooks are the mechanism that fires validation scripts on every tool call — they power local LLM offloading, commit format enforcement, context budget tracking, and workflow gates.
352
+
353
+ | Feature | Claude Code | Copilot CLI | Cursor IDE | Codex CLI | Jules |
354
+ |---------|:-----------:|:-----------:|:----------:|:---------:|:-----:|
355
+ | Skills (slash commands) | All 27 | All 27 | All 27 | All 27 | All 27 |
356
+ | Agents (subagent delegation) | All 12 | All 12 | All 12 | All 12 | All 12 |
357
+ | `.planning/` state management | Full | Full | Full | Full | Full |
358
+ | **Hook support** | **Full (14 events)** | **Partial (4 events)** | **Unverified** | **None** | **None** |
359
+ | Commit format enforcement | Hook-enforced | Hook-enforced | Manual | Manual | Manual |
360
+ | PLAN/SUMMARY quality classification | Hook + skill fallback | Hook + skill fallback | Skill fallback only | Skill fallback only | Skill fallback only |
361
+ | Test failure triage | Automatic (hook) | Automatic (hook) | Not available | Not available | Not available |
362
+ | Context budget tracking | Automatic (hook) | Not available | Not available | Not available | Not available |
363
+ | Auto-continue between skills | Automatic (hook) | Not available | Not available | Not available | Not available |
364
+ | Subagent lifecycle logging | Automatic (hook) | Not available | Not available | Not available | Not available |
365
+ | **Local LLM offloading** | **Full (8 operations)** | **Mostly (6-7 operations)** | **CLI only** | **CLI only** | **CLI only** |
366
+ | `pbr-tools.js llm` CLI commands | Full | Full | Full | Full | Full |
325
367
 
326
368
  **Key differences:**
327
369
 
328
370
  - **Claude Code** has full hook support — all local LLM operations fire automatically on every tool call
329
371
  - **Copilot CLI** supports `sessionStart`, `preToolUse`, `postToolUse`, and `sessionEnd` — covers most validation hooks but misses lifecycle events (`SubagentStop`, `PreCompact`, `Stop`)
330
372
  - **Cursor IDE** hook support is unverified — hooks.json is configured but whether Cursor actually fires them is unknown. Skills include `pbr-tools.js llm` fallback calls for key operations (plan quality, verification quality) so local LLM classification is available even without hooks
373
+ - **OpenAI Codex CLI** and **Google Jules** do not support hooks. All skills and agents are available via `plugins/codex-pbr/` and `plugins/jules-pbr/` respectively. Agent definitions use AGENTS.md format.
331
374
 
332
375
  All platforms share the same scripts via relative paths — no code duplication. See the [Copilot CLI](plugins/copilot-pbr/README.md) and [Cursor IDE](plugins/cursor-pbr/README.md) READMEs for platform-specific details.
333
376
 
@@ -341,7 +384,7 @@ git clone https://github.com/SienkLogic/plan-build-run.git
341
384
  cd plan-build-run
342
385
  npm install
343
386
 
344
- # Run tests (2153 tests, 73 suites)
387
+ # Run tests (9283 tests, 281 suites)
345
388
  npm test
346
389
 
347
390
  # Lint
@@ -362,14 +405,19 @@ CI runs on Node 18/20/22 across Windows, macOS, and Linux. See [CONTRIBUTING.md]
362
405
 
363
406
  | Metric | Count |
364
407
  |--------|-------|
365
- | Skills (slash commands) | 26 |
408
+ | Skills (slash commands) | 27 |
366
409
  | Specialized agents | 12 |
367
- | Hook scripts | 38 |
410
+ | Hook scripts | 41 |
368
411
  | Local LLM operations | 8 |
369
- | Supported platforms | 3 (Claude Code, Cursor, Copilot CLI) |
370
- | Tests | 2153 |
371
- | Test suites | 73 |
372
- | Config keys | 13 top-level (62+ properties) |
412
+ | Supported platforms | 5 (Claude Code, Cursor, Copilot CLI, Codex, Jules) |
413
+ | Tests | 9283 |
414
+ | Test suites | 281 |
415
+ | Config keys | 12 top-level (62+ properties) |
416
+ | Feature toggles | 14 |
417
+ | Lib modules | 19 |
418
+ | Shared fragments | 12 |
419
+ | Templates | 10 |
420
+ | References | 19 |
373
421
 
374
422
  ---
375
423
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sienklogic/plan-build-run",
3
- "version": "2.55.0",
3
+ "version": "2.56.1",
4
4
  "description": "Plan it, Build it, Run it — structured development workflow for Claude Code",
5
5
  "keywords": [
6
6
  "claude-code",
@@ -0,0 +1,101 @@
1
+ # PBR Workflow Configuration for Codex CLI
2
+ # Copy this file to your project's .codex/config.toml and customize as needed.
3
+ #
4
+ # Each [profiles.*] section defines a named agent profile that can be selected
5
+ # when Codex runs PBR skills. Uncomment and adjust the fields you want to change.
6
+ #
7
+ # Reference: https://github.com/openai/codex
8
+
9
+ # ---------------------------------------------------------------------------
10
+ # Sandbox Settings
11
+ # ---------------------------------------------------------------------------
12
+ # Controls which shell commands Codex is allowed to run during builds.
13
+ # Adjust based on your project's build toolchain.
14
+
15
+ [sandbox]
16
+ # allow = ["bash", "git", "npm", "node", "python", "pip", "cargo", "make"]
17
+ # deny = ["curl", "wget", "ssh"]
18
+
19
+ # ---------------------------------------------------------------------------
20
+ # PBR Agent Profiles
21
+ # ---------------------------------------------------------------------------
22
+ # Each profile corresponds to a PBR agent role. Codex selects the appropriate
23
+ # profile based on the active skill. You can override model and instructions
24
+ # per role to tune cost/quality tradeoffs.
25
+
26
+ # Research agent — explores domain, reads docs, summarizes findings.
27
+ # Called by: $pbr-explore, $pbr-begin, $pbr-plan (research phase)
28
+ [profiles.pbr-researcher]
29
+ # description = "Research agent: investigates domain and summarizes findings"
30
+ # model = "o4-mini"
31
+ # instructions = "Focus on gathering factual information. Cite sources."
32
+
33
+ # Planner agent — creates detailed, task-level phase plans.
34
+ # Called by: $pbr-plan, $pbr-begin
35
+ [profiles.pbr-planner]
36
+ # description = "Planner agent: produces structured PLAN.md files"
37
+ # model = "o3"
38
+ # instructions = "Output valid PLAN.md frontmatter. Define must_haves precisely."
39
+
40
+ # Executor agent — implements tasks from a PLAN.md, commits each task.
41
+ # Called by: $pbr-build
42
+ [profiles.pbr-executor]
43
+ # description = "Executor agent: implements plan tasks with atomic commits"
44
+ # model = "o4-mini"
45
+ # instructions = "One task per commit. Follow the plan exactly. No scope creep."
46
+
47
+ # Verifier agent — checks build output against plan must_haves.
48
+ # Called by: $pbr-review
49
+ [profiles.pbr-verifier]
50
+ # description = "Verifier agent: produces VERIFICATION.md with evidence"
51
+ # model = "o4-mini"
52
+ # instructions = "Check evidence in the codebase. Do not assume correctness."
53
+
54
+ # Integration checker agent — validates cross-component integration.
55
+ # Called by: $pbr-health, $pbr-scan
56
+ [profiles.pbr-integration-checker]
57
+ # description = "Integration checker: validates cross-component contracts"
58
+ # model = "o4-mini"
59
+ # instructions = "Focus on interface boundaries and data flow between modules."
60
+
61
+ # Debugger agent — hypothesis-driven bug investigation.
62
+ # Called by: $pbr-debug
63
+ [profiles.pbr-debugger]
64
+ # description = "Debugger agent: systematic hypothesis-driven investigation"
65
+ # model = "o3"
66
+ # instructions = "Form falsifiable hypotheses. Test each before moving on."
67
+
68
+ # Codebase mapper agent — creates ARCHITECTURE.md and related codebase docs.
69
+ # Called by: $pbr-explore, $pbr-begin
70
+ [profiles.pbr-mapper]
71
+ # description = "Mapper agent: documents codebase structure and architecture"
72
+ # model = "o4-mini"
73
+ # instructions = "Be concise. Focus on structure over implementation details."
74
+
75
+ # Synthesizer agent — aggregates research and produces structured summaries.
76
+ # Called by: $pbr-explore, $pbr-discuss
77
+ [profiles.pbr-synthesizer]
78
+ # description = "Synthesizer agent: aggregates findings into structured output"
79
+ # model = "o4-mini"
80
+ # instructions = "Extract key insights. Surface tensions and open questions."
81
+
82
+ # General agent — handles ad-hoc tasks and one-off instructions.
83
+ # Called by: $pbr-do, $pbr-discuss
84
+ [profiles.pbr-general]
85
+ # description = "General agent: flexible agent for miscellaneous PBR tasks"
86
+ # model = "o4-mini"
87
+ # instructions = "Follow PBR workflow rules. Commit with correct format."
88
+
89
+ # Audit agent — analyzes session logs for workflow compliance.
90
+ # Called by: $pbr-audit
91
+ [profiles.pbr-audit]
92
+ # description = "Audit agent: reviews session logs and produces compliance reports"
93
+ # model = "o4-mini"
94
+ # instructions = "Be objective. Report findings without judgment."
95
+
96
+ # Dev-sync agent — synchronizes changes across plugin derivatives.
97
+ # Called internally — not a user-facing skill.
98
+ [profiles.pbr-dev-sync]
99
+ # description = "Dev-sync agent: propagates pbr/ changes to cursor-pbr/ and codex-pbr/"
100
+ # model = "o4-mini"
101
+ # instructions = "Apply diffs exactly. Do not add scope beyond the sync target."