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

openplanr sprint

Manage sprint artifacts deterministically

Usage
openplanr sprint [options] [command]

Commands

  • create

    Create a sprint from flags or a JSON object

  • list

    List sprint artifacts

  • show

    Print one sprint artifact

  • update

    Update sprint frontmatter fields

  • refinement

    Store a refinement document: validate it, write the note and JSON, fill the sprint

  • diff

    Show what moved between two refinement documents

  • close

    Close the sprint and record its leftovers for the next refinement

  • apply

    Write the approved status changes from the refinement document to the artifacts

openplanr sprint create

Create a sprint from flags or a JSON object

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

sprint title or description

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

sprint title

--data <path>

read deterministic JSON fields from a file, or - for stdin

--file <path>

deprecated alias for --data

--json

emit one machine-readable result

-d, --duration <duration>

sprint duration

Default: "2w"

openplanr sprint list

List sprint artifacts

Usage
openplanr sprint list [options]

openplanr sprint show

Print one sprint artifact

Usage
openplanr sprint show [options] <id>
Arguments for openplanr sprint show
ArgumentDescription
idRequired

No description

openplanr sprint update

Update sprint frontmatter fields

Usage
openplanr sprint update [options] <id>
Arguments for openplanr sprint update
ArgumentDescription
idRequired

No description

Options for openplanr sprint update
OptionDescription
--status <status>

No description

--owner <owner>

No description

--title <title>

No description

openplanr sprint refinement

Store a refinement document: validate it, write the note and JSON, fill the sprint

Usage
openplanr sprint refinement [options] <id>
Arguments for openplanr sprint refinement
ArgumentDescription
idRequired

sprint id, e.g. SPRINT-004

Options for openplanr sprint refinement
OptionDescription
--data <path>

refinement JSON document, or - for stdin

--json

emit one machine-readable result

openplanr sprint diff

Show what moved between two refinement documents

Usage
openplanr sprint diff [options] <from> <to>
Arguments for openplanr sprint diff
ArgumentDescription
fromRequired

earlier sprint id

toRequired

later sprint id

Options for openplanr sprint diff
OptionDescription
--json

emit one machine-readable result

openplanr sprint close

Close the sprint and record its leftovers for the next refinement

Usage
openplanr sprint close [options] <id>
Arguments for openplanr sprint close
ArgumentDescription
idRequired

sprint id

Options for openplanr sprint close
OptionDescription
--json

emit one machine-readable result

openplanr sprint apply

Write the approved status changes from the refinement document to the artifacts

Usage
openplanr sprint apply [options] <id>
Arguments for openplanr sprint apply
ArgumentDescription
idRequired

sprint id

Options for openplanr sprint apply
OptionDescription
--yes

confirm the write-back after the host skill asked its approval question

--dry-run

list the changes without writing anything

--force

skip status vocabulary validation

--commit

commit exactly the changed files as chore(planr): refine backlog for <id>

--json

emit one machine-readable result

OpenPlanr Docs
Commands for
Theme