powerpipe dashboard

List, view, and run Powerpipe dashboards in batch mode. To run dashboards interactively, see powerpipe server.

Usage

Sub-Commands

CommandDescription
listList dashboards from the current mod and its direct dependents.
runRun a dashboard from the current mod or its direct dependents.
showShow details of a dashboard from the current mod or its direct dependents.

powerpipe dashboard list

List dashboards from the current mod and its direct dependents.

Examples

List dashboards:

List all dashboards in JSON format:

List dashboards using settings from a workspace:


powerpipe dashboard show

Show details of a dashboard from the current mod or its direct dependents.

Examples

Show details of a single dashboard in the current mod:

Show details of a single dashboard in a direct dependency mod:

Show details of a dashboard in JSON format:

Show details of a dashboard using settings from a workspace:


powerpipe dashboard run

Run a dashboard from the current mod or its direct dependents.

Arguments

FlagDescription
--arg string=stringSpecify the value for a dashboard input. Multiple --arg arguments may be passed.
--dashboard-timeout intSet the dashboard execution timeout, in seconds. The default is 0 (no timeout).
--databaseDEPRECATED - See Setting the Database for the new syntax. Sets the database that Powerpipe will connect to. This defaults to the local Steampipe database, but can be any PostgreSQL, MySQL, DuckDB, or SQLite database.
--export stringExport dashboard output to a file. You may export multiple output formats for a single dashboard run by entering multiple --export arguments. If a file path is specified as an argument, its type will be inferred by the suffix. Supported export formats are none, pps (snapshot)
--inputEnable/Disable interactive prompts for missing variables. To disable prompts and fail on missing variables, use --input=false. This is useful when running from scripts. (default true)
--max-parallel intSet the maximum number of database connections to open. When running dashboards, Powerpipe will attempt to run up to this many dashboards in parallel. See the POWERPIPE_MAX_PARALLEL environment variable documentation for details. (default 10)
--mod-installSpecify whether to install mod dependencies before running the dashboard (default true)
--output stringSelect the console output format. Defaults to text. Possible values are none, pps (snapshot)
--pipes-hostSets the Turbot Pipes host used when connecting to Turbot Pipes workspaces. See PIPES_HOST for details.
--pipes-tokenSets the Turbot Pipes authentication token used when connecting to Turbot Pipes workspaces. See PIPES_TOKEN for details.
--progressEnable or disable progress information. By default, progress information is shown - set --progress=false to hide the progress bar.
--query-timeout intThe query timeout, in seconds. The default is 300.
--search-path stringsSet a comma-separated list of connections to use as a custom search path for the dashboard run.
--search-path-prefix stringsSet a comma-separated list of connections to use as a prefix to the current search path for the dashboard run.
--shareCreate snapshot in Turbot Pipes with anyone_with_link visibility.
--snapshotCreate snapshot in Turbot Pipes with the default (workspace) visibility.
--snapshot-location stringThe location to write snapshots - either a local file path or a Turbot Pipes workspace
--snapshot-tag string=stringSpecify tags to set on the snapshot. Multiple --snapshot-tag arguments may be passed.
--snapshot-title string=stringThe title to give a snapshot when uploading to Turbot Pipes.
--var string=stringSpecify the value of a variable. Multiple --var arguments may be passed.
--var-file stringsSpecify a .ppvar file containing variable values.

Examples

Run a dashboard and output the snapshot data:

Run a dashboard and output the snapshot data to a file:

Run a dashboard and upload a snapshot with workspace visibility in your user workspace.

Run a dashboard and upload a snapshot with anyone_with_link visibility in your user workspace.

Run a dashboard and save a snapshot, specifying inputs:

Run a dashboard and upload a snapshot with anyone_with_link visibility to a specific workspace.

Run a dashboard, upload a snapshot with workspace visibility in your user workspace, and tag the snapshot:

Run a dashboard against a pipes workspace: