Who installs this

Most people do not install planr-pipeline directly. The openplanr CLI depends on the exact matching version and installs it with planr setup; the skills that run in Claude Code, Codex, and Cursor call into it for deterministic work. Install it yourself when you integrate with the Protocol, the Operate runtime, or the dashboard contracts from your own code:

npm install planr-pipeline

Requires Node.js 20 or later. The package never calls a model; reasoning stays in the coding agent. Its four runtime dependencies cover hashing, HTML parsing, compression, and bundling; the optional ones add PNG rasterization and the diagram font.

What it contains

| Area | Entry points | Purpose | | --- | --- | --- | | Protocol | planr-pipeline/protocol, planr-pipeline/schemas/*, planr-pipeline/registry/* | Spec, story, task, design, QA, and provenance contracts; command and role registries; JSON Schemas from 1.0.0 to 2.0.0 | | Pipeline | planr-pipeline, planr-pipeline/professional-skills | Feature-local PO planning, stack conventions, nine role definitions, verification discovery, and the shipped-marker proof | | Operate runtime | planr-pipeline/operate/*-v2 | Durable operating cycles: assignments, authorization, policy, approvals, governed execution and recovery, evidence, projections, scheduling | | Dashboard contracts | planr-pipeline/dashboard/* | Verified JSON readers and display contracts for the local planning and Operate dashboard | | Assets | stacks/, templates/, references/, procedures/, gallery/, fixtures/, conformance/ | Stack conventions, output templates, diagram grammar references, procedures, and conformance fixtures |

Every export is listed in package.json; the Protocol documentation describes the contracts and their versions.

How it relates to the skills

The skills you invoke in a coding agent (spec, plan, ship, design, diagram, operate, and the rest) are shipped by the openplanr package and reason inside the agent. This package holds the portable contracts and deterministic engine they rely on, so a specification written on one host is read identically on another. The skill catalog lists every skill.

Documentation

• Protocol: spec artifacts, agent roles, commands, runtime adapters, guided interactions, Operate runtime 2.0
• Rules and the compatibility matrix
• Spec, story, and task anatomy, and the pipeline overview
• Artifact review, design loop, design review, dashboard
• Doctor and the ecosystem guide
• Maintainer references: ownership map, release checklist, release ledger, skill evaluation

Project-level documentation, getting started, and support live in the OpenPlanr repository.

Versioning

Pre-1.0 semantic versioning: minor versions may change behavior, patch versions are fixes and documentation. Package versions are independent of the Protocol schema and document versions they ship. The openplanr CLI pins the exact planr-pipeline version it was released with.

License

MIT. Diagram renderer notices are listed in THIRD_PARTY-DIAGRAM-NOTICES.md. The OpenPlanr name and logo are covered by the trademark policy.