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

openplanr diagram

Create, verify, inspect, and rerender offline professional diagrams

Usage
openplanr diagram [options] [command]

Commands

  • new

    Create a canonical editable diagram bundle

  • edit

    Open the local owner studio for an existing diagram

  • apply

    Preview a scoped edit, then explicitly accept that preview

  • render

    Render a verified offline diagram set

  • inspect

    Inspect source or generated manifest custody

  • check

    Validate source or verify generated bytes against their manifest

  • gallery

    List the searchable diagram grammar and primitive gallery

  • rerender

    Rerender after an intentional source edit

openplanr diagram new

Create a canonical editable diagram bundle

Usage
openplanr diagram new [options] <path>
Arguments for openplanr diagram new
ArgumentDescription
pathRequired

canonical diagrams/{slug}/{slug}.planr-diagram-bundle.json path

Options for openplanr diagram new
OptionDescription
--title <title>

diagram title

--json

output one stable machine envelope

openplanr diagram edit

Open the local owner studio for an existing diagram

Usage
openplanr diagram edit [options] <path>
Arguments for openplanr diagram edit
ArgumentDescription
pathRequired

canonical diagram bundle path

Options for openplanr diagram edit
OptionDescription
--json

output one stable machine envelope

openplanr diagram apply

Preview a scoped edit, then explicitly accept that preview

Usage
openplanr diagram apply [options] <path>
Arguments for openplanr diagram apply
ArgumentDescription
pathRequired

canonical diagram bundle path

Options for openplanr diagram apply
OptionDescription
--transaction <file>

typed diagram-edit-transaction JSON

--dry-run

preview semantic and layout changes without applying

--accept <preview-token>

apply the exact previewed transaction

--json

output one stable machine envelope

openplanr diagram render

Render a verified offline diagram set

Usage
openplanr diagram render [options] <input>
Arguments for openplanr diagram render
ArgumentDescription
inputRequired

canonical .planr-diagram.json or Mermaid source

Options for openplanr diagram render
OptionDescription
--slug <slug>

override the output slug

--output <directory>

output root; defaults to the repository root

--json

output one stable machine envelope

openplanr diagram inspect

Inspect source or generated manifest custody

Usage
openplanr diagram inspect [options] <input-or-manifest>
Arguments for openplanr diagram inspect
ArgumentDescription
input-or-manifestRequired

diagram source, manifest, or generated diagram directory

Options for openplanr diagram inspect
OptionDescription
--json

output one stable machine envelope

openplanr diagram check

Validate source or verify generated bytes against their manifest

Usage
openplanr diagram check [options] <input-or-manifest>
Arguments for openplanr diagram check
ArgumentDescription
input-or-manifestRequired

diagram source, manifest, or generated diagram directory

Options for openplanr diagram check
OptionDescription
--json

output one stable machine envelope

List the searchable diagram grammar and primitive gallery

Usage
openplanr diagram gallery [options]
Options for openplanr diagram gallery
OptionDescription
--type <type>

filter by grammar, alias, or layout family

--json

output one stable machine envelope

openplanr diagram rerender

Rerender after an intentional source edit

Usage
openplanr diagram rerender [options] <manifest>
Arguments for openplanr diagram rerender
ArgumentDescription
manifestRequired

generated diagram manifest

Options for openplanr diagram rerender
OptionDescription
--accept <source>

choose ir, mermaid, or excalidraw when source branches conflict

--json

output one stable machine envelope

OpenPlanr Docs
Commands for
Theme