---
title: openplanr artifact
description: "openplanr artifact: Review, share, import, and export diagrams, designs, and HTML artifacts. Subcommands: open, handoff, share, publish, sync, import, export."
url: https://openplanr.dev/docs/cli/artifact
updated: 2026-10-06
related:
  - https://openplanr.dev/docs/cli/doctor.md
  - https://openplanr.dev/docs/cli/runtime.md
  - https://openplanr.dev/docs/cli/dashboard.md
---

# openplanr artifact

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

```text
openplanr artifact [options] [command] [file]
```

Arguments:

- `file` (optional)

Options:

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

Open a local diagram, design, or HTML review session

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

Arguments:

- `file` (required)

Options:

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

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

Arguments:

- `file` (required)

Options:

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

## openplanr artifact share

Share a native diagram, design, or generic HTML review

```text
openplanr artifact share [options] <file>
```

Arguments:

- `file` (required)

Options:

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

```text
openplanr artifact publish [options] <file>
```

Arguments:

- `file` (required)

Options:

- `--yes`: confirm encrypted publication non-interactively; default `false`
- `--json`: emit machine-readable output; default `false`

## openplanr artifact sync

Synchronize hosted diagram or design feedback

```text
openplanr artifact sync [options] <file>
```

Arguments:

- `file` (required)

Options:

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

```text
openplanr artifact import [options] [review-url...]
```

Arguments:

- `review-url...` (optional)

Options:

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

```text
openplanr artifact export [options] <session-id>
```

Arguments:

- `session-id` (required)

Options:

- `--format <format>`: json or markdown; default `"json"`
- `--output <path>`: write the export to a file