Skip to main content

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​

FlagTypeRequiredDescription
--namestringRequiredDashboard name.
--space-idstringRequiredSpace ID the dashboard belongs to.
--changesetstringOptionalChangeset (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​

ArgumentRequiredDescription
idRequiredDashboard ID (DSH_*).

Flags​

FlagTypeRequiredDescription
--base-versionstringOptionalExpected current version for optimistic concurrency.
--changesetstringOptionalChangeset (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​

ArgumentRequiredDescription
idRequiredDashboard ID (DSH_*).

Flags​

FlagTypeRequiredDescription
--dirstringOptionalDirectory for a new file (default .).
--filestringOptionalExisting .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​

ArgumentRequiredDescription
idRequiredDashboard 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​

FlagTypeRequiredDescription
--spacestring, repeatableOptionalOnly these spaces: SPC_* ids, comma-separated or repeated.
--filterstringOptionalRaw OData $filter expression, passed to the server as is.
--topstringOptionalItems per page (server default 100).
--skipstringOptionalNumber of items to skip.
--allbooleanOptionalFetch 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​

ArgumentRequiredDescription
idRequiredDashboard ID.

Flags​

FlagTypeRequiredDescription
--export-formatstringOptionalOutput format: png or svg (default: png). Defaults to png.
--output, -ostringOptionalOutput directory (default: ./perpetual-<dashboardId>-<timestamp>).
--widthstringOptionalCanvas width in pixels (default: 1200). Defaults to 1200.
--scalestringOptionalDPI scale factor for PNG (default: 2). Defaults to 2.
--time-rangestringOptionalOverride panel time ranges (e.g. '-1h', '-24h', 'ts(2025-01-01)..ts(2025-01-02)').
--panelstringOptionalExport a single panel by ID.

Also accepts the global flags, including the sign-in flags.


Perpetual CLI 0.5.0