orion canvas
Canvases and their layout
sh
orion canvas <command> [options]orion canvas list
List canvases and mark the active one
sh
orion canvas list [options]| Argument | Description |
|---|---|
--archived | List archived canvases instead |
--json | Print JSON |
orion canvas create
Create a canvas with its own data folder
sh
orion canvas create [name] [options]| Argument | Description |
|---|---|
[name] | Canvas name. Omit it to derive one from --label |
--label <value> | Display label |
--json | Print JSON |
orion canvas rename
Change a canvas's display label
sh
orion canvas rename [name] [label] [options]| Argument | Description |
|---|---|
[name] | Canvas name |
[label] | New display label |
--json | Print JSON |
orion canvas set
Set a canvas's cover or background
sh
orion canvas set [options]| Argument | Description |
|---|---|
--cover <value> | Image asset id for the cover, from orion media add --json (empty to clear) |
--background <value> | Color, color token such as card.background, or image asset id (empty to clear) |
--header <value> | Markdown with layout HTML shown over the top of the canvas (empty to clear) |
--json | Print JSON |
orion canvas archive
Archive a canvas. Its data stays in place, and restore brings it back. The active canvas and default can't be archived
sh
orion canvas archive [name] [options]| Argument | Description |
|---|---|
[name] | Canvas name |
--json | Print JSON |
orion canvas restore
Restore an archived canvas with its data
sh
orion canvas restore [name] [options]| Argument | Description |
|---|---|
[name] | Archived canvas name |
--json | Print JSON |
orion canvas use
Make a canvas the active one
sh
orion canvas use [name] [options]| Argument | Description |
|---|---|
[name] | Canvas name |
--json | Print JSON |
orion canvas current
Print the active canvas
sh
orion canvas current [options]| Argument | Description |
|---|---|
--json | Print JSON |
orion canvas path
Print where this canvas keeps its data
sh
orion canvas path [options]| Argument | Description |
|---|---|
--json | Print JSON |
orion canvas check
Report layout problems: overlaps, items outside their group, dangling links, and groups waiting for layout
sh
orion canvas check [options]| Argument | Description |
|---|---|
--group <value> | Only problems in this group or inside it |
--json | Print JSON |
