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

openplanr artifact

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

Usage
openplanr artifact [options] [command] [file]
Arguments for openplanr artifact
ArgumentDescription
fileOptional

No description

Options for openplanr artifact
OptionDescription
--title <title>

review title

--root <asset-root>

root for local artifact dependencies

--theme <theme>

auto, light, or dark

Default: "auto"

--presentation <presentation>

auto, document, or canvas

Default: "auto"

--port <port>

loopback review port

--no-open

do not open a browser

--json

emit machine-readable output

Default: false

Commands

  • open

    Open a local diagram, design, or HTML review session

  • handoff

    Prepare a factual design review handoff for refinement and owner approval

  • share

    Share a native diagram, design, or generic HTML review

  • publish

    Publish a new revision to a shared diagram or design review

  • sync

    Synchronize hosted diagram or design feedback

  • import

    Import one or more live-room or immutable review links

  • export

    Export feedback from a live local review session

openplanr artifact open

Open a local diagram, design, or HTML review session

Usage
openplanr artifact open [options] <file>
Arguments for openplanr artifact open
ArgumentDescription
fileRequired

No description

Options for openplanr artifact open
OptionDescription
--title <title>

review title

--root <asset-root>

root for local artifact dependencies

--theme <theme>

auto, light, or dark

Default: "auto"

--presentation <presentation>

auto, document, or canvas

Default: "auto"

--port <port>

loopback review port

--no-open

do not open a browser

--json

emit machine-readable output

Default: false

openplanr artifact handoff

Prepare a factual design review handoff for refinement and owner approval

Usage
openplanr artifact handoff [options] <file>
Arguments for openplanr artifact handoff
ArgumentDescription
fileRequired

No description

Options for openplanr artifact handoff
OptionDescription
--json

emit machine-readable output

Default: false

openplanr artifact share

Share a native diagram, design, or generic HTML review

Usage
openplanr artifact share [options] <file>
Arguments for openplanr artifact share
ArgumentDescription
fileRequired

No description

Options for openplanr artifact share
OptionDescription
--title <title>

review title

--root <asset-root>

root for local artifact dependencies

--presentation <presentation>

auto, document, or canvas

Default: "auto"

--short

create an encrypted expiring short link

Default: false

--snapshot

create an immutable snapshot instead of a live room

Default: false

--ttl <ttl>

generic artifact retention: 1d, 7d (default), or 30d

--no-open

do not open the review link

--json

emit machine-readable output

Default: false

--yes

confirm encrypted upload non-interactively

Default: false

--secret-output <path>

write capabilities to a new private 0600 file

--resume <private-file>

retry the exact saved generic encrypted paste operation

openplanr artifact publish

Publish a new revision to a shared diagram or design review

Usage
openplanr artifact publish [options] <file>
Arguments for openplanr artifact publish
ArgumentDescription
fileRequired

No description

Options for openplanr artifact publish
OptionDescription
--yes

confirm encrypted publication non-interactively

Default: false

--json

emit machine-readable output

Default: false

openplanr artifact sync

Synchronize hosted diagram or design feedback

Usage
openplanr artifact sync [options] <file>
Arguments for openplanr artifact sync
ArgumentDescription
fileRequired

No description

Options for openplanr artifact sync
OptionDescription
--yes

confirm encrypted publication non-interactively

Default: false

--json

emit machine-readable output

Default: false

openplanr artifact import

Import one or more live-room or immutable review links

Usage
openplanr artifact import [options] [review-url...]
Arguments for openplanr artifact import
ArgumentDescription
review-url...Optional

No description

Options for openplanr artifact import
OptionDescription
--secret-input <path|->

read a private capability bundle from a 0600 file or stdin

--output <path>

also write the merged review state to this path

--allow-stale

preview and explicitly accept stale feedback

Default: false

--json

emit machine-readable output

Default: false

--yes

confirm stale import non-interactively

Default: false

openplanr artifact export

Export feedback from a live local review session

Usage
openplanr artifact export [options] <session-id>
Arguments for openplanr artifact export
ArgumentDescription
session-idRequired

No description

Options for openplanr artifact export
OptionDescription
--format <format>

json or markdown

Default: "json"

--output <path>

write the export to a file

OpenPlanr Docs
Commands for
Theme