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

openplanr design

Validate, render, review, export, and inspect local designs

Usage
openplanr design [options] [command]

Commands

  • capabilities

    Report the design command contract this CLI and its workflow package serve

  • inspect

    Report the design document and its current render

  • validate

    Validate the design document without rendering

  • render

    Render the design document into a new review revision

  • open

    Open the local design studio; it runs until stopped

  • view-context

    Report what the local studio is showing

  • export

    Export the design as standalone HTML

  • verify

    Record a browser verification report for the current render

  • handoff

    Inspect the design review handoff without changing any file

  • studio

    Report or stop the local design studio

  • fonts

    Download open-license fonts into a design

openplanr design capabilities

Report the design command contract this CLI and its workflow package serve

Usage
openplanr design capabilities [options]
Options for openplanr design capabilities
OptionDescription
--json

emit machine-readable output

Default: false

openplanr design inspect

Report the design document and its current render

Usage
openplanr design inspect [options] <file>
Arguments for openplanr design inspect
ArgumentDescription
fileRequired

No description

Options for openplanr design inspect
OptionDescription
--json

emit machine-readable output

Default: false

openplanr design validate

Validate the design document without rendering

Usage
openplanr design validate [options] <file>
Arguments for openplanr design validate
ArgumentDescription
fileRequired

No description

Options for openplanr design validate
OptionDescription
--json

emit machine-readable output

Default: false

openplanr design render

Render the design document into a new review revision

Usage
openplanr design render [options] <file>
Arguments for openplanr design render
ArgumentDescription
fileRequired

No description

Options for openplanr design render
OptionDescription
--json

emit machine-readable output

Default: false

openplanr design open

Open the local design studio; it runs until stopped

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

No description

Options for openplanr design open
OptionDescription
--view <view>

canvas, prototype, or walkthrough

One of: canvas, prototype, walkthrough

--port <port>

loopback studio port

--no-open

do not open a browser

--json

emit machine-readable output

Default: false

openplanr design view-context

Report what the local studio is showing

Usage
openplanr design view-context [options] <file>
Arguments for openplanr design view-context
ArgumentDescription
fileRequired

No description

Options for openplanr design view-context
OptionDescription
--request-time <timestamp>

ISO time of the request being answered

--json

emit machine-readable output

Default: false

openplanr design export

Export the design as standalone HTML

Usage
openplanr design export [options] <file>
Arguments for openplanr design export
ArgumentDescription
fileRequired

No description

Options for openplanr design export
OptionDescription
--view <view>

canvas, prototype, or walkthrough

One of: canvas, prototype, walkthrough

--format <format>

html

--output <path>

write to this new path

--json

emit machine-readable output

Default: false

openplanr design verify

Record a browser verification report for the current render

Usage
openplanr design verify [options] <file>
Arguments for openplanr design verify
ArgumentDescription
fileRequired

No description

Options for openplanr design verify
OptionDescription
--report <path>

the browser report JSON

--json

emit machine-readable output

Default: false

openplanr design handoff

Inspect the design review handoff without changing any file

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

No description

Options for openplanr design handoff
OptionDescription
--action <action>

inspect

Default: "inspect"

One of: inspect

--json

emit machine-readable output

Default: false

openplanr design studio

Report or stop the local design studio

Usage
openplanr design studio [options] [command]

Commands

  • status

    Report whether the design’s local studio is running

  • stop

    Stop the design’s local studio; feedback and arrangement are kept

openplanr design studio status

Report whether the design’s local studio is running

Usage
openplanr design studio status [options] <file>
Arguments for openplanr design studio status
ArgumentDescription
fileRequired

No description

Options for openplanr design studio status
OptionDescription
--instance-id <id>

an exact studio service, from studio status

--json

emit machine-readable output

Default: false

openplanr design studio stop

Stop the design’s local studio; feedback and arrangement are kept

Usage
openplanr design studio stop [options] <file>
Arguments for openplanr design studio stop
ArgumentDescription
fileRequired

No description

Options for openplanr design studio stop
OptionDescription
--instance-id <id>

an exact studio service, from studio status

--json

emit machine-readable output

Default: false

openplanr design fonts

Download open-license fonts into a design

Usage
openplanr design fonts [options] [command]

Commands

  • fetch

    Download up to two open-license font families into the design sources

openplanr design fonts fetch

Download up to two open-license font families into the design sources

Usage
openplanr design fonts fetch [options]
Options for openplanr design fonts fetch
OptionDescription
--family <name:weights>

a family and its weights, such as "Inter:400,700"; repeat for a second family

Default: []

--dest <dir>

the design’s font directory, such as source/assets/fonts

--json

emit machine-readable output

Default: false