openplanr design
Validate, render, review, export, and inspect local designs
openplanr design [options] [command]Commands
capabilitiesReport the design command contract this CLI and its workflow package serve
inspectReport the design document and its current render
validateValidate the design document without rendering
renderRender the design document into a new review revision
openOpen the local design studio; it runs until stopped
view-contextReport what the local studio is showing
exportExport the design as standalone HTML
verifyRecord a browser verification report for the current render
handoffInspect the design review handoff without changing any file
studioReport or stop the local design studio
fontsDownload open-license fonts into a design
openplanr design capabilities
Report the design command contract this CLI and its workflow package serve
openplanr design capabilities [options]| Option | Description |
|---|---|
--json | emit machine-readable output |
openplanr design inspect
Report the design document and its current render
openplanr design inspect [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--json | emit machine-readable output |
openplanr design validate
Validate the design document without rendering
openplanr design validate [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--json | emit machine-readable output |
openplanr design render
Render the design document into a new review revision
openplanr design render [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--json | emit machine-readable output |
openplanr design open
Open the local design studio; it runs until stopped
openplanr design open [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--view <view> | canvas, prototype, or walkthrough |
--port <port> | loopback studio port |
--no-open | do not open a browser |
--json | emit machine-readable output |
openplanr design view-context
Report what the local studio is showing
openplanr design view-context [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--request-time <timestamp> | ISO time of the request being answered |
--json | emit machine-readable output |
openplanr design export
Export the design as standalone HTML
openplanr design export [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--view <view> | canvas, prototype, or walkthrough |
--format <format> | html |
--output <path> | write to this new path |
--json | emit machine-readable output |
openplanr design verify
Record a browser verification report for the current render
openplanr design verify [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--report <path> | the browser report JSON |
--json | emit machine-readable output |
openplanr design handoff
Inspect the design review handoff without changing any file
openplanr design handoff [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--action <action> | inspect |
--json | emit machine-readable output |
openplanr design studio
Report or stop the local design studio
openplanr design studio [options] [command]openplanr design studio status
Report whether the design’s local studio is running
openplanr design studio status [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--instance-id <id> | an exact studio service, from studio status |
--json | emit machine-readable output |
openplanr design studio stop
Stop the design’s local studio; feedback and arrangement are kept
openplanr design studio stop [options] <file>| Argument | Description |
|---|---|
fileRequired | No description |
| Option | Description |
|---|---|
--instance-id <id> | an exact studio service, from studio status |
--json | emit machine-readable output |
openplanr design fonts
Download open-license fonts into a design
openplanr design fonts [options] [command]Commands
fetchDownload 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
openplanr design fonts fetch [options]| Option | Description |
|---|---|
--family <name:weights> | a family and its weights, such as "Inter:400,700"; repeat for a second family |
--dest <dir> | the design’s font directory, such as source/assets/fonts |
--json | emit machine-readable output |