openplanr 3.3.0 → 3.5.0

package/lib/host-packages/claude/openplanr/skills/design-review/references/generation.md

@@ -34,12 +34,12 @@ incidental array positions or rendered CSS selectors.
 
 Author real screen content with useful labels, plausible data and complete states.
 Make the primary journey navigable and meaningful controls functional. Use local
-HTML/CSS/JavaScript and assets supported by the bundled utility; do not require a
+HTML/CSS/JavaScript and assets supported by the design utilities; do not require a
 build server, package installation, remote modules or a development environment to
 open the studio. Third-party assets retain their license/attribution where needed.
 Use classic browser scripts with local event handlers. If adapting an existing
-module-based component, compile its local preview before packaging; the portable
-utility does not install dependencies or compile modules. Use local image `src`
+module-based component, compile its local preview before packaging; the design
+utilities do not install dependencies or compile modules. Use local image `src`
 with responsive CSS. Forms validate and run local handlers; omit navigation
 actions and targets. Cross-screen actions can use `data-design-navigate` with the
 stable target screen ID.

package/lib/host-packages/claude/openplanr/skills/design-review/references/review.md

@@ -9,10 +9,10 @@ a remix; keep their origin distinct and do not invent board votes.
 For "this button" or "this screen", read the live local viewer context:
 
 ```sh
-node scripts/design.mjs view-context <design-document.json> --json
+openplanr design view-context <design-document.json> --json
 ```
 
-The utility reads `.design/view-context.json` beside the document and rejects a
+The command reads `.design/view-context.json` beside the document and rejects a
 revision that differs from the current render. Ignore context whose `updatedAt`
 is older than the user's request; pass `--request-time <ISO-timestamp>` to have
 the reader enforce that check. Missing, invalid or stale context returns
@@ -85,7 +85,7 @@ decision. Read project-local shared feedback alongside the ordinary pin ledger.
 
 Creating a share or publishing an update requires an explicit user request.
 Rendering a local revision does not update the remote review. After the user asks
-to publish, use the studio's Publish update action or the bundled utility; verify
+to publish, use the studio's Publish update action or `openplanr artifact publish`; verify
 the returned published revision. The URL stays stable and recipients choose when
 to load a new revision. Earlier pins remain stale until deliberately addressed.
 
@@ -96,9 +96,9 @@ specifications, project files, URLs, logs, or ordinary command output.
 
 ## Agent-friendly review exports
 
-Use **Export reviews** in the Review sidebar, or the bundled feedback export
-utility, for Markdown or JSON grouped by original revision, screen, direction and
-responsive frame. Preserve reviewer IDs, exact quotations, replies and timestamps.
+Use **Export reviews** in the Review sidebar, or
+`openplanr artifact feedback --action export`, for Markdown or JSON grouped by
+original revision, screen, direction and responsive frame. Preserve reviewer IDs, exact quotations, replies and timestamps.
 Read the completeness flag; wait for older pages or retry when disconnected before
 treating an export as the full review history. Unsaved text in a composer is a draft,
 not submitted feedback.

package/lib/host-packages/claude/openplanr/skills/design-review/references/team-review.md

@@ -101,10 +101,9 @@ has been rendered and checked.
 
 ## Prepare and refine the handoff
 
-When requested, run `openplanr artifact handoff <design-document.json>` or the bundled
-`node scripts/design.mjs handoff <design-document.json>` utility. Both prepare a
-factual draft from the recorded review; neither calls an AI model or starts Plan.
-Read the utility's `--help` for the installed edit and approval interface.
+When requested, run `openplanr artifact handoff <design-document.json>`. It
+prepares a factual draft from the recorded review; it does not call an AI model or
+start Plan. Read its `--help` for the installed edit and approval interface.
 
 Refine the draft in this active host session. Preserve comment quotations,
 authorship, source revision and references. Separate accepted changes from

package/lib/host-packages/claude/openplanr/skills/design-review/references/utilities.md

@@ -1,24 +1,71 @@
-# Bundled design utilities
+# Design utilities
 
-Run the linked design helper from the skill entrypoint relative to the skill's
-directory. It contains deterministic operations and all required assets. It needs
-Node.js 22.13 or later, with no global CLI or provider credentials. Only `fonts fetch`
-downloads anything, and only when run; nothing is fetched when a design opens.
-Use `--help` to inspect the installed command interface before writing documents
-or invoking operations; the installed contract is authoritative.
+Design operations run in the `openplanr` CLI. They are deterministic, need Node.js
+22.13 or later and no provider credentials. Only `fonts fetch` downloads anything,
+and only when run; nothing is fetched when a design opens. Use `--help` on a
+command to inspect the installed interface before writing documents or invoking
+operations; the installed contract is authoritative.
+
+## Check the design runtime
+
+Run this once, before consultation, and check whether the host's artifact tool
+offers a design quickstart or a Design artifact type:
 
 ```sh
-node scripts/design.mjs inspect <design-document.json> --json
-node scripts/design.mjs validate <design-document.json> --json
-node scripts/design.mjs render <design-document.json> --json
-node scripts/design.mjs open <design-document.json> --view canvas --no-open --json
-node scripts/design.mjs feedback <design-document.json> --action inspect --json
-node scripts/design.mjs view-context <design-document.json> --json
-node scripts/design.mjs studio <design-document.json> --action status --json
-node scripts/design.mjs studio <design-document.json> --action stop --json
-node scripts/design.mjs fonts fetch --family "<Name>:<weights>" [--family ...] --dest <design>/source/assets/fonts --json
+openplanr design capabilities --json
 ```
 
+These skills need design contract 1. Treat a successful
+`openplanr design capabilities --json` as proof the runtime is ready. Never locate
+or import the OpenPlanr workflow package, inspect `node_modules`, or call internal
+runtime modules. Use the `openplanr` on `PATH`; never search for another one or
+for bundled design scripts. A failed probe means the matching stop below.
+
+| Probe result | Runtime | Next action |
+|---|---|---|
+| `ok: true` and `supported.min` ≤ 1 ≤ `supported.max` | Ready | Use the commands below. |
+| `openplanr` not found | Stop 1: no CLI | `npm install -g openplanr` |
+| `unknown command 'design'`, `E_DESIGN_RUNTIME_UNSUPPORTED`, or a `supported` range without 1 | Stop 2: CLI too old | `npm install -g openplanr@latest` |
+| `ok: false` with `E_DESIGN_RUNTIME_MISSING` and `pipeline: null` | Stop 3: CLI without its workflow package | `npm install -g openplanr`, run without `--omit=optional` |
+
+A design on the hosted canvas needs no CLI. At a stop, consultation and
+authoring still happen: author `design-document.json`, its sources and
+`design-spec.md`, mark them **unverified**, and say that no studio was rendered or
+checked. End with every next action that applies, each one the user can run: the
+stop's command, and the host action below. On Claude Code without a Design
+artifact type, that is the command and the canvas actions. Then ask the user to
+run the skill again.
+
+| Host | Notes |
+|---|---|
+| Claude Code | Design builds on the hosted canvas when the artifact tool offers a Design type. When it does not, also name the canvas actions: sign in with `/login` on a claude.ai Pro, Max, Ultra, Team or Enterprise plan; or, when artifacts are turned off, re-enable them in `/config`. An API key or gateway token means no claude.ai login: name `/login` with a claude.ai plan, or the CLI. On Bedrock, Google Cloud or Foundry, or in an organisation with CMEK, HIPAA or Zero Data Retention, the canvas is unavailable and the CLI is the path. |
+| Codex | The stop's command. `openplanr setup` installs the workflow package beside the skills, but `PATH` can resolve a different `openplanr`; `which openplanr` shows the one that runs. Codex's default `workspace-write` sandbox stops the studio: `design open` fails with `listen EPERM`. Tell the user to run `openplanr design open <design-document.json>` in their own terminal, or to restart Codex with `-c sandbox_workspace_write.network_access=true -c 'sandbox_workspace_write.writable_roots=["<absolute path of ~/.planr>"]'` (use `PLANR_HOME` instead when it is set). That setting also lets commands reach the network. |
+| Cursor | The stop's command. `openplanr setup` installs the workflow package beside the skills, but `PATH` can resolve a different `openplanr`; `which openplanr` shows the one that runs. |
+| ChatGPT | Without a local shell, take stop 1: deliver the unverified sources and specification, and name `npm install -g openplanr` for a coding agent with a shell. |
+
+## Commands
+
+Run these from the project directory. Paths resolve against it.
+
+```sh
+openplanr design inspect <design-document.json> --json
+openplanr design validate <design-document.json> --json
+openplanr design render <design-document.json> --json
+openplanr design open <design-document.json> --view canvas --no-open --json
+openplanr design view-context <design-document.json> --json
+openplanr design verify <design-document.json> --report <browser-report.json> --json
+openplanr design export <design-document.json> --view canvas --format html --output <path> --json
+openplanr design studio status <design-document.json> --json
+openplanr design studio stop <design-document.json> --json
+openplanr design fonts fetch --family "<Name>:<weights>" [--family ...] --dest <design>/source/assets/fonts --json
+openplanr artifact feedback <design-document.json> --action inspect --json
+```
+
+`render` reads the specification at the path in [handoff.md](handoff.md), so write
+`design-spec.md` before the first render. The CLI prints `<path>` in place of
+absolute paths, so an `ENOENT` names no file: check that `design-spec.md` and
+every source the document names exist before suspecting the CLI.
+
 `fonts fetch` snapshots at most two OFL or Apache families, three weights each, as
 Latin `woff2` files with their license files and a local `fonts.css`. It needs network
 access; ask the user to approve that one command. A host that allowlists domains needs
@@ -28,9 +75,9 @@ access; ask the user to approve that one command. A host that allowlists domains
 [design-system.md](design-system.md) for the fallback.
 
 Use `--view prototype` or `--view walkthrough` to select the initial presentation.
-When an `openplanr` CLI is available, prefer its public `openplanr artifact` route for
-opening the document; otherwise use this bundled script. Both compose the same
-design and artifact runtime, preserving feedback and view behavior.
+`design open` keeps the studio running until it is stopped, so run it in the
+background. `openplanr artifact open <design-document.json>` opens the same studio,
+preserving feedback and view behavior.
 
 `view-context` returns validated live viewer data, or `{ viewContext: null, reason }`
 when unavailable or stale. Use `--request-time <ISO-timestamp>` to reject context
@@ -49,12 +96,12 @@ Opening a completed design reuses its healthy local service and returns a short
 Studio; a service hosting several designs offers a selection page. Keep the
 returned URL instead of constructing one from export paths.
 
-Use `studio --action status` to find the healthy service for this design. Its
+Use `design studio status` to find the healthy service for this design. Its
 `status: running` reports service availability; `browserStatus` reports observed
 preview loading separately, and `verification` reports actual saved checks.
 Startup alone does not mean a design is ready or verified.
 
-Use `studio --action stop` to authenticate the exact owned live instance and drain
+Use `design studio stop` to authenticate the exact owned live instance and drain
 pending saves; it does not signal a process by PID. `status: stopping` means
 shutdown was accepted. Run status again to confirm it stopped. Feedback, ratings
 and arrangement remain in their canonical stores and survive reopening.
@@ -63,7 +110,7 @@ A healthy service with different settings, an older runtime, or an unvalidated
 session must be stopped before reopening. When its launcher record is missing,
 stop can recover the sole authenticated owner for this design. If several owned
 services remain, inspect status and choose one explicitly with
-`studio <design-document.json> --action stop --instance-id <id>`. An instance from
+`openplanr design studio stop <design-document.json> --instance-id <id>`. An instance from
 another project or state directory is rejected. Hosted shares continue independently.
 
 ## Import downloaded feedback
@@ -71,7 +118,7 @@ another project or state directory is rejected. Hosted shares continue independe
 Explicitly reconcile downloaded feedback with the canonical local ledger:
 
 ```sh
-node scripts/design.mjs feedback <design-document.json> --action import --input <downloaded-review.json> --revision <current-render-revision> --json
+openplanr artifact feedback <design-document.json> --action import --input <downloaded-review.json> --revision <current-render-revision> --json
 ```
 
 Read `feedback --action inspect` first and pass its current `revision` internally;
@@ -108,12 +155,11 @@ The design remains accessible when the local machine is offline. Owner authority
 saves automatically in a protected user-level file outside the project; recovery
 export is optional. Only copy the reviewer token through the explicit Share controls.
 
-The bundled utility supports `share`, `publish`, and `sync` with the same design
-document argument. `share` creates or retries a review, `publish` sends an explicitly
-requested new revision to the existing URL, and `sync` retrieves authenticated
-feedback. Run `--help` for access-management and recovery options. The public CLI
-equivalents are `openplanr artifact share`, `openplanr artifact publish`, and
-`openplanr artifact sync`. No global CLI is required for the bundled helper.
+Sharing runs in the `openplanr` CLI, which holds the owner keys:
+`openplanr artifact share`, `publish`, `sync`, `status`, `manage`, `feedback` and
+`handoff`, and the studio's Share dialog. `share` creates or retries a review,
+`publish` sends an explicitly requested new revision to the existing URL, and
+`sync` retrieves authenticated feedback.
 
 Retention is until the owner revokes or deletes the review, while the service is
 maintained. The owner can pause comments and rotate access tokens. Rotation blocks
@@ -123,9 +169,9 @@ saved operation and use its retry path. Report service unavailability explicitly
 
 ## Team review and handoff
 
-`openplanr artifact handoff <design-document.json>` and the bundled
-`node scripts/design.mjs handoff <design-document.json>` prepare or refresh a
-factual review handoff. Use `--json` for structured results and consult `--help`
+`openplanr artifact handoff <design-document.json>` prepares or refreshes a
+factual review handoff, and `openplanr design handoff <design-document.json>`
+inspects it. Use `--json` for structured results and consult `--help`
 for inspection, update and approval actions. Follow [team-review.md](team-review.md)
 for active-agent refinement and owner approval. These deterministic operations do
 not call a provider, publish a design or start Plan/Ship.

package/lib/host-packages/claude/openplanr/skills/investigate/SKILL.md

@@ -22,6 +22,7 @@ the requested outcome.
 When the user asked for a fix, implement the smallest coherent correction within the requested
 repository and run focused regression checks. Preserve unrelated work. Ask only when a missing
 product decision or an irreversible external action genuinely blocks progress.
+Prove the regression test with [fail-first](references/fail-first.md).
 
 ## Findings outside the cause
 

package/lib/host-packages/claude/openplanr/skills/investigate/references/fail-first.md

@@ -0,0 +1,40 @@
+# Fail-first
+
+A check proves an acceptance criterion only if it fails without the change.
+
+## Applies to
+
+A check mapped to an acceptance ID, or a test written for this task. For
+Investigate, the regression test for the fix.
+
+## Fail-first
+
+- Write or run the check before the implementation. It counts only when the
+  runner reports at least one failed assertion or test.
+- A load error does not count: a missing module, a syntax or compile error, "no
+  tests found", or a collection error. Report it as "fails only on load".
+- If the runner output is unclear, say so instead of guessing.
+- A test written after the code is `not-run` for fail-first. Never revert the
+  implementation to prove it.
+
+A check that already passes before the change: report "passes before the change;
+proves nothing", then narrow or strengthen the check yourself and record that in
+`checks`.
+
+## Seeded fault
+
+Off by default. Offer it only when an acceptance check is new code or fail-first
+failed only on load; the question's default is skip.
+
+1. Record `git status --porcelain` and confirm nothing staged (`git diff --cached --quiet`).
+2. Copy the target file outside the repository.
+3. Make one small edit that breaks behaviour the criterion names.
+4. Rebuild if the tests run built output.
+5. Run the check. It must fail on an assertion.
+6. Restore from the copy, and rebuild if step 4 did; never `git checkout`, which
+   also discards the uncommitted implementation.
+7. Confirm `cmp` against the copy, an identical `--porcelain` output, and nothing staged.
+
+A seed that survives goes in `checks` with a question whose default is "add a
+test for it". Report all of this in the existing `checks` result text: no new
+field, no new stop, no record file.

package/lib/host-packages/claude/openplanr/skills/plan/SKILL.md

@@ -45,10 +45,14 @@ unresolved feedback; carry relevant gaps into explicit task checks. Preserve
 existing design or re-extract an authored specification from preview images.
 
 When `review-handoff.json` is present beside `design-spec.md`, read its current
-approval and freshness with the bundled
-`node scripts/design.mjs handoff <design-document.json> --action inspect --json`. Use approved, current
+approval and freshness with
+`openplanr design handoff <design-document.json> --action inspect --json`. Use approved, current
 handoff items as additional planning context, retaining revision/comment links and
-unresolved questions. An outdated or unapproved draft is evidence, not agreed scope;
+unresolved questions. When `openplanr` is not found, does not know `design`, or
+reports `E_DESIGN_RUNTIME_MISSING`, treat the handoff as unverified evidence rather
+than agreed scope, continue when the specification is decision-complete, and name
+the fix: `npm install -g openplanr`, `npm install -g openplanr@latest`, or
+`npm install -g openplanr` without `--omit=optional`, respectively. An outdated or unapproved draft is evidence, not agreed scope;
 report the changed inputs and obtain the missing decision only when it affects the
 requested plan. Never silently substitute a newer draft for an approved snapshot.
 A missing review handoff does not block ordinary planning from a clear specification.

package/lib/host-packages/claude/openplanr/skills/ship/SKILL.md

@@ -19,7 +19,8 @@ For a selector, locate exactly one task and read it completely. Then follow its
 `storyId` and `specId` to the parent story, acceptance criteria, Gherkin file
 when present, and specification. Also read repository instructions, ADRs,
 planning rules, applicable stack guidance, relevant design/database context,
-implementation code, tests, and interfaces produced by declared dependencies.
+implementation code, tests, and interfaces produced by declared dependencies. Read any
+`.planr/conventions/<area>.md`, indexed from AGENTS.md, for the areas this task touches.
 
 Read [the design lineage contract](references/design-lineage.md). If the selected
 planning root contains `design-lineage.json`, load only the selected task's mapped
@@ -62,8 +63,9 @@ QA retains verification tools, subject to role policy and session permissions.
 
 Select the exact registered identity from the host's roster; Claude plugin
 agents use names such as `planr:planr-backend` and `planr:planr-qa`. Give each worker
-its outcome, authoritative paths, relevant decisions, file ownership, verification
-requirements, and concise return expectations. Parallel workers need disjoint
+its outcome, the absolute task path with `MODE` and, in spec-driven mode, `SPEC_DIR`,
+authoritative paths, relevant decisions, file ownership, verification requirements,
+and concise return expectations. Parallel workers need disjoint
 writes or an agreed interface. Explain the delegation's purpose briefly in
 commentary. Host-native workers do not invoke the separate `planr-delegate` helper.
 When the host lacks the native role, perform the work sequentially in this session
@@ -71,7 +73,8 @@ and disclose capability limitations; never claim an unavailable specialist ran.
 
 Integrate the complete change, then verify behavior. `reviewRisks` and
 `browserSurfaces` select useful checks; empty arrays are normal and neither field
-is a workflow gate.
+is a workflow gate. Re-run the cheap checks a worker reports as passed, and compare
+its `changed` list with `git diff --name-only` plus untracked files; report any difference.
 
 ## Discover and run verification
 
@@ -86,9 +89,14 @@ Run `openplanr ship checks --json --task <task-path>` (omit `--task` for a direc
 request; add `--tier story` or `--tier push` before pushing) and run its `checks`
 from each `cwd`. The command never executes checks or writes files. When
 `complete` is `false`, report its error diagnostics and treat the check set as
-incomplete: a pass is not CI-equivalent. Without the CLI, the packaged read-only
-[verification discovery helper](scripts/discover-verification.mjs) may list
-candidates. Resolve it relative to this `SKILL.md` and run
+incomplete: a pass is not CI-equivalent. Act on warning diagnostics too; each names
+the files or checks it affects. A diagnostic that a check could not run, such as
+`TYPESCRIPT_UNAVAILABLE`, is not a pass: name that check in `checks` and verify its
+concern yourself where you can (for a new test file, confirm some tsconfig includes
+it). For a `package-contents` check, account for every `expectFiles` entry in the
+tarball's `files`: packed or deliberately left out. Without
+the CLI, the packaged read-only [verification discovery helper](scripts/discover-verification.mjs)
+may list candidates. Resolve it relative to this `SKILL.md` and run
 `node <helper> --project <repository-root> --task <task-path>`; omit `--task` for a
 direct request. It never executes checks or writes files. If both are unavailable,
 inspect those four sources directly. Missing commands are diagnostics, not a
@@ -98,6 +106,8 @@ Run the strongest applicable focused checks while working, then the relevant
 regression checks. Run each check on its own or under `set -o pipefail`, and judge
 it by its own exit code; to shorten output, write it to a log and read the tail.
 Fix failures caused by the change and rerun affected checks.
+For an acceptance check written or changed for this task, follow
+[fail-first](references/fail-first.md) and report what it proved in that check's result.
 Read [the result contract](references/result-contract.md) before reporting.
 
 Report defects you notice outside the task as [findings](references/findings.md),
@@ -116,10 +126,12 @@ behavior, link material changes by purpose, and summarize actual verification.
 Retain complete file inventories and command diagnostics in their existing
 results instead of reproducing them in chat.
 
-- **Outcome:** `completed`, `partial`, or `blocked`, followed by what now works.
+- **Outcome:** `completed`, `partial`, `blocked`, or `awaiting-acceptance` (repository
+  work done; acceptance needs a run only the owner can do), followed by what now works.
 - **Task:** task ID and path, or `direct-request`.
-- **Changed:** material paths grouped by purpose.
-- **Checks:** command, `passed`, `failed`, or `not-run`, plus a concise result.
+- **Changed:** material paths grouped by purpose, files outside Create and Modify apart.
+- **Checks:** command, `passed`, `failed`, or `not-run`, plus a concise result and the
+  acceptance IDs it covers; list acceptance criteria no check covers.
 - **Issues:** blockers with problem, impact, and next action, or `none`; then
   findings outside the task, each with its disposition.
 

package/lib/host-packages/claude/openplanr/skills/ship/references/fail-first.md

@@ -0,0 +1,40 @@
+# Fail-first
+
+A check proves an acceptance criterion only if it fails without the change.
+
+## Applies to
+
+A check mapped to an acceptance ID, or a test written for this task. For
+Investigate, the regression test for the fix.
+
+## Fail-first
+
+- Write or run the check before the implementation. It counts only when the
+  runner reports at least one failed assertion or test.
+- A load error does not count: a missing module, a syntax or compile error, "no
+  tests found", or a collection error. Report it as "fails only on load".
+- If the runner output is unclear, say so instead of guessing.
+- A test written after the code is `not-run` for fail-first. Never revert the
+  implementation to prove it.
+
+A check that already passes before the change: report "passes before the change;
+proves nothing", then narrow or strengthen the check yourself and record that in
+`checks`.
+
+## Seeded fault
+
+Off by default. Offer it only when an acceptance check is new code or fail-first
+failed only on load; the question's default is skip.
+
+1. Record `git status --porcelain` and confirm nothing staged (`git diff --cached --quiet`).
+2. Copy the target file outside the repository.
+3. Make one small edit that breaks behaviour the criterion names.
+4. Rebuild if the tests run built output.
+5. Run the check. It must fail on an assertion.
+6. Restore from the copy, and rebuild if step 4 did; never `git checkout`, which
+   also discards the uncommitted implementation.
+7. Confirm `cmp` against the copy, an identical `--porcelain` output, and nothing staged.
+
+A seed that survives goes in `checks` with a question whose default is "add a
+test for it". Report all of this in the existing `checks` result text: no new
+field, no new stop, no record file.

package/lib/host-packages/claude/openplanr/skills/ship/references/result-contract.md

@@ -2,11 +2,15 @@
 
 Return one concise human rendering backed by these five machine fields:
 
-1. `outcome`: `completed`, `partial`, or `blocked`, plus the achieved result.
+1. `outcome`: `completed`, `partial`, `blocked`, or `awaiting-acceptance` (repository
+   work done; acceptance needs a run only the owner can do), plus the achieved result.
 2. `task`: exact task identity and path, or `direct-request`.
-3. `changed`: material files grouped by purpose.
+3. `changed`: material files grouped by purpose; files outside the task's Create
+   and Modify lists form their own group.
 4. `checks`: each executed or applicable check with `passed`, `failed`, or
-   `not-run` and a concise result.
+   `not-run`, a concise result, and the acceptance IDs it covers. The result says
+   what fail-first proved, for example `failed before the change on an assertion;
+   seed in src/x.ts caught`.
 5. `issues`: `blockers` for this task, each with problem, impact, and next
    action, and `findings` outside the task, shaped as `findings.md` describes;
    use `none` when both are empty.