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

CLI reference

Every command of the openplanr CLI with its usage, arguments and options, generated from the help of version 2.2641.1.

Usage

OpenPlanr deterministic utilities and integration CLI

Usage
openplanr [options] [command]

Every command also takes -h, --help, which prints its help in the terminal.

Global options

OptionDescription
-V, --version

output the version number

--project-dir <path>

project root directory

Default: "<cwd>"

--verbose

verbose output

Default: false

--no-interactive

skip interactive prompts

-y, --yes

auto-accept all prompts (alias for --no-interactive)

Commands

  • init

    Initialize deterministic OpenPlanr project storage

  • server

    Inspect and stop owned local Studio services

  • setup

    Set up OpenPlanr skills for your coding agents

  • doctor

    Diagnose OpenPlanr, pipeline, runtime adapter, and project health

  • runtime

    Manage runtime adapters

  • artifact

    Review, share, import, and export diagrams, designs, and HTML artifacts

  • dashboard

    Serve the local Planning and Operate dashboard

  • diagram

    Create, verify, inspect, and rerender offline professional diagrams

  • linear

    Linear.app integration: init, push, sync, status mapping, task checklists

  • operate

    Run and resume the durable OpenPlanr Operate lifecycle

  • land

    Inspect and owner-advance a certified landing plan

  • backlog

    Manage backlog artifacts deterministically

  • epic

    Manage epic artifacts deterministically

  • feature

    Manage feature artifacts deterministically

  • story

    Manage story artifacts deterministically

  • task

    Manage task artifacts deterministically

  • quick

    Manage quick artifacts deterministically

  • spec

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

  • checklist

    Manage the agile development checklist

  • rules

    Generate project guidance for host-native coding agents

  • status

    Whole-project delivery report: every spec/backlog/quick-task by status, optionally cross-referenced with GitHub PRs + Linear

  • config

    Manage deterministic OpenPlanr configuration

  • export

    Export planning artifacts as markdown, JSON, or HTML report

  • report

    Generate stakeholder report (sprint, weekly, executive, standup, retro, release) from OpenPlanr + GitHub

  • report-linter

    Lint a stakeholder report markdown file

  • context

    Print stakeholder report context pack as JSON

  • voice

    Voice-oriented standup helpers

  • github

    Sync planning artifacts with GitHub Issues

  • graph

    Emit the OpenPlanr artifact graph

  • search

    Search across all planning artifacts

  • sprint

    Manage sprint artifacts deterministically

  • sync

    Validate and fix cross-references across all artifacts

  • template

    Reusable task patterns for common development tasks

  • update

    Update artifact fields (status, owner, priority)

  • upgrade

    Reconcile the installed OpenPlanr tuple against the published compatible set

OpenPlanr Docs
Commands for
Theme