---
title: openplanr design
description: "openplanr design: Validate, render, review, export, and inspect local designs. Subcommands: capabilities, inspect, validate, render, open, view-context."
url: https://openplanr.dev/docs/cli/design
updated: 2026-11-17
related:
  - https://openplanr.dev/docs/cli/artifact.md
  - https://openplanr.dev/docs/cli/dashboard.md
  - https://openplanr.dev/docs/cli/diagram.md
---

# openplanr design

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

```text
openplanr design [options] [command]
```

## openplanr design capabilities

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

```text
openplanr design capabilities [options]
```

Options:

- `--json`: emit machine-readable output; default `false`

## openplanr design inspect

Report the design document and its current render

```text
openplanr design inspect [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--json`: emit machine-readable output; default `false`

## openplanr design validate

Validate the design document without rendering

```text
openplanr design validate [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--json`: emit machine-readable output; default `false`

## openplanr design render

Render the design document into a new review revision

```text
openplanr design render [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--json`: emit machine-readable output; default `false`

## openplanr design open

Open the local design studio; it runs until stopped

```text
openplanr design open [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--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

```text
openplanr design view-context [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--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

```text
openplanr design export [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--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

```text
openplanr design verify [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--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

```text
openplanr design handoff [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--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

```text
openplanr design studio [options] [command]
```

### openplanr design studio status

Report whether the design’s local studio is running

```text
openplanr design studio status [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--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

```text
openplanr design studio stop [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--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

```text
openplanr design fonts [options] [command]
```

### openplanr design fonts fetch

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

```text
openplanr design fonts fetch [options]
```

Options:

- `--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`
