Skip to content
OpenPlanr Docs
GitHub (opens in a new tab)

openplanr spec

Spec-driven storage and validation for artifacts authored by the active host agent.

Usage
openplanr spec [options] [command]

Commands

  • init

    Activate spec-driven mode in this project (creates .planr/specs/ root)

  • create

    Create a new spec: a self-contained directory with stories/, tasks/, design/

  • shape

    Author a decision-complete professional specification

  • list

    List all specs in the project

  • show

    Print a spec + its decomposition tree (stories, tasks)

  • status

    Decomposition state across all specs (or one spec if --spec specified)

  • destroy

    Remove a spec entirely (rm -rf of its self-contained directory)

  • attach-design

    Copy PNG mockups into a spec's design/ directory and update ui_files frontmatter

  • promote

    Validate that a spec is ready and print the pipeline handoff command

  • sync

    Validate spec integrity (orphaned tasks, stories without tasks, missing specId frontmatter, schema drift)

openplanr spec init

Activate spec-driven mode in this project (creates .planr/specs/ root)

Usage
openplanr spec init [options]

openplanr spec create

Create a new spec: a self-contained directory with stories/, tasks/, design/

Usage
openplanr spec create [options] [title...]
Arguments for openplanr spec create
ArgumentDescription
title...Optional

spec title (alternative to --title)

Options for openplanr spec create
OptionDescription
--title <title>

spec title (required if not given as positional argument)

--slug <slug>

explicit kebab-case slug; otherwise derived from title

--priority <priority>

P0 / P1 / P2 (default: P1)

Default: "P1"

--milestone <milestone>

milestone label (e.g., v1.0)

--po <handle>

Product Owner handle (e.g., @AsemDevs)

openplanr spec shape

Author a decision-complete professional specification

Usage
openplanr spec shape [options] <specId>
Arguments for openplanr spec shape
ArgumentDescription
specIdRequired

spec ID (e.g., SPEC-001)

Options for openplanr spec shape
OptionDescription
--file <path|->

read one bounded professional specification JSON object

--json

emit one machine-readable result

Default: false

openplanr spec list

List all specs in the project

Usage
openplanr spec list [options]

openplanr spec show

Print a spec + its decomposition tree (stories, tasks)

Usage
openplanr spec show [options] <specId>
Arguments for openplanr spec show
ArgumentDescription
specIdRequired

spec ID (e.g., SPEC-001)

openplanr spec status

Decomposition state across all specs (or one spec if --spec specified)

Usage
openplanr spec status [options] [specId]
Arguments for openplanr spec status
ArgumentDescription
specIdOptional

optional spec ID to scope output

openplanr spec destroy

Remove a spec entirely (rm -rf of its self-contained directory)

Usage
openplanr spec destroy [options] <specId>
Arguments for openplanr spec destroy
ArgumentDescription
specIdRequired

spec ID (e.g., SPEC-001)

openplanr spec attach-design

Copy PNG mockups into a spec's design/ directory and update ui_files frontmatter

Usage
openplanr spec attach-design [options] <specId>
Arguments for openplanr spec attach-design
ArgumentDescription
specIdRequired

spec ID (e.g., SPEC-001)

Options for openplanr spec attach-design
OptionDescription
--files <paths...>

one or more PNG files to attach

openplanr spec promote

Validate that a spec is ready and print the pipeline handoff command

Usage
openplanr spec promote [options] <specId>
Arguments for openplanr spec promote
ArgumentDescription
specIdRequired

spec ID (e.g., SPEC-001)

openplanr spec sync

Validate spec integrity (orphaned tasks, stories without tasks, missing specId frontmatter, schema drift)

Usage
openplanr spec sync [options] [specId]
Arguments for openplanr spec sync
ArgumentDescription
specIdOptional

optional spec ID to scope; otherwise scans all specs

Options for openplanr spec sync
OptionDescription
--dry-run

report findings without writing any fixes

Default: false