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

openplanr story

Manage story artifacts deterministically

Usage
openplanr story [options] [command]

Commands

  • create

    Create a story from flags or a JSON object

  • list

    List story artifacts

  • show

    Print one story artifact

  • update

    Update story frontmatter fields

openplanr story create

Create a story from flags or a JSON object

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

story title or description

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

story 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

--feature <id>

parent feature ID; may also come from --data

openplanr story list

List story artifacts

Usage
openplanr story list [options]

openplanr story show

Print one story artifact

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

No description

openplanr story update

Update story frontmatter fields

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

No description

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

No description

--owner <owner>

No description

--title <title>

No description