perpetual dashboard
Manage dashboards.
perpetual dashboard create
Create a new dashboard.
perpetual dashboard create [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | Required | Dashboard name. |
--space-id | string | Required | Space ID the dashboard belongs to. |
--changeset | string | Optional | Changeset (CHG_*) to stage this create into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual dashboard delete
Delete a dashboard.
perpetual dashboard delete <id> [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Dashboard ID (DSH_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--base-version | string | Optional | Expected current version for optimistic concurrency. |
--changeset | string | Optional | Changeset (CHG_*) to stage into; REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual dashboard export
Write a dashboard as a GitOps file.
perpetual dashboard export <id> [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Dashboard ID (DSH_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--dir | string | Optional | Directory for a new file (default .). |
--file | string | Optional | Existing .dashboard.yaml/.json file to edit in place. |
Also accepts the global flags, including the sign-in flags.
perpetual dashboard get
Get a dashboard.
perpetual dashboard get <id>
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Dashboard ID (DSH_*). |
Also accepts the global flags, including the sign-in flags.
perpetual dashboard list
List dashboards.
perpetual dashboard list [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--space | string, repeatable | Optional | Only these spaces: SPC_* ids, comma-separated or repeated. |
--filter | string | Optional | Raw OData $filter expression, passed to the server as is. |
--top | string | Optional | Items per page (server default 100). |
--skip | string | Optional | Number of items to skip. |
--all | boolean | Optional | Fetch every page (1000 items per request). |
Also accepts the global flags, including the sign-in flags.
perpetual dashboard render-panels
Render dashboard vega-lite panels as images.
perpetual dashboard render-panels <id> [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Dashboard ID. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--export-format | string | Optional | Output format: png or svg (default: png). Defaults to png. |
--output, -o | string | Optional | Output directory (default: ./perpetual-<dashboardId>-<timestamp>). |
--width | string | Optional | Canvas width in pixels (default: 1200). Defaults to 1200. |
--scale | string | Optional | DPI scale factor for PNG (default: 2). Defaults to 2. |
--time-range | string | Optional | Override panel time ranges (e.g. '-1h', '-24h', 'ts(2025-01-01)..ts(2025-01-02)'). |
--panel | string | Optional | Export a single panel by ID. |
Also accepts the global flags, including the sign-in flags.
Perpetual CLI 0.5.0