openplanr artifact
Review, share, import, and export diagrams, designs, and HTML artifacts
openplanr artifact [options] [command] [file]| Argument | Description |
|---|---|
fileOptional | No description |
| Option | Description |
|---|---|
--title <title> | review title |
--root <asset-root> | root for local artifact dependencies |
--theme <theme> | auto, light, or dark |
--presentation <presentation> | auto, document, or canvas |
--port <port> | loopback review port |
--no-open | do not open a browser |
--json | emit machine-readable output |
Commands
openOpen a local diagram, design, or HTML review session
share-runtimeReport the CLI, workflow package and design sharing format versions
statusShow whether a design is shared, its review link and pending work
manageRotate, pause, resume, revoke, delete, reveal access to, or recover a design review
feedbackInspect, export, import, select or resolve design feedback; syncs a shared design first
review-metadataPublish an owner category or disposition to a shared design review (used by the design helpers)
handoffPrepare, inspect or update a design review handoff for refinement and owner approval
shareShare a native diagram, design, or generic HTML review
publishPublish a new revision to a shared diagram or design review
syncSynchronize hosted diagram or design feedback
importImport one or more live-room or immutable review links
exportExport feedback from a live local review session
openplanr artifact open
Open a local diagram, design, or HTML review session
openplanr artifact open [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--title <title> | review title |
--root <asset-root> | root for local artifact dependencies |
--theme <theme> | auto, light, or dark |
--presentation <presentation> | auto, document, or canvas |
--port <port> | loopback review port |
--no-open | do not open a browser |
--json | emit machine-readable output |
openplanr artifact share-runtime
Report the CLI, workflow package and design sharing format versions
openplanr artifact share-runtime [options]| Option | Description |
|---|---|
--json | emit machine-readable output |
openplanr artifact status
Show whether a design is shared, its review link and pending work
openplanr artifact status [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--json | emit machine-readable output |
openplanr artifact manage
Rotate, pause, resume, revoke, delete, reveal access to, or recover a design review
openplanr artifact manage [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--action <action> | rotate|pause|resume|revoke|delete|access|recovery|restore |
--output <path> | recovery: write the private recovery file to this new path |
--input <path> | restore: read the private recovery file from this path |
--yes | confirm a rotate, revoke, delete or restore non-interactively |
--json | emit machine-readable output |
openplanr artifact feedback
Inspect, export, import, select or resolve design feedback; syncs a shared design first
openplanr artifact feedback [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--action <action> | inspect|export|import|select|resolve |
--format <format> | export: json or markdown |
--scope <scope> | export: current or all |
--output <path> | export: write to this new path |
--input <path> | import: read feedback from this file |
--revision <revision> | import: the current render revision |
--allow-stale | import: accept feedback for an older revision |
--variant <id> | select: the ready variant to select |
--pins <ids> | resolve: comma-separated pin ids |
--summary <text> | resolve: resolution summary |
--json | emit machine-readable output |
openplanr artifact review-metadata
Publish an owner category or disposition to a shared design review (used by the design helpers)
openplanr artifact review-metadata [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--revision <revision> | the hosted revision the decision belongs to |
--input <path|-> | the decision as a JSON object, from a file or stdin |
--json | emit machine-readable output |
openplanr artifact handoff
Prepare, inspect or update a design review handoff for refinement and owner approval
openplanr artifact handoff [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--action <action> | inspect|draft|update|approve|category|disposition |
--input <path|-> | update input as a JSON object, from a file or stdin |
--json | emit machine-readable output |
openplanr artifact share
Share a native diagram, design, or generic HTML review
openplanr artifact share [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--title <title> | review title |
--root <asset-root> | root for local artifact dependencies |
--presentation <presentation> | auto, document, or canvas |
--short | create an encrypted expiring short link |
--snapshot | create an immutable snapshot instead of a live room |
--ttl <ttl> | generic artifact retention: 1d, 7d (default), or 30d |
--no-open | do not open the review link |
--json | emit machine-readable output |
--yes | confirm encrypted upload non-interactively |
--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
openplanr artifact publish [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--yes | confirm encrypted publication non-interactively |
--json | emit machine-readable output |
openplanr artifact sync
Synchronize hosted diagram or design feedback
openplanr artifact sync [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--yes | confirm encrypted publication non-interactively |
--json | emit machine-readable output |
openplanr artifact import
Import one or more live-room or immutable review links
openplanr artifact import [options] [review-url...]| Argument | Description |
|---|---|
review-url...Optional | No description |
| Option | Description |
|---|---|
--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 |
--json | emit machine-readable output |
--yes | confirm stale import non-interactively |
openplanr artifact export
Export feedback from a live local review session
openplanr artifact export [options] <session-id>| Argument | Description |
|---|---|
session-idRequired | No description |
| Option | Description |
|---|---|
--format <format> | json or markdown |
--output <path> | write the export to a file |