CLI (engineai)#

engineai dashboard#

Dashboard commands.

Usage:

engineai dashboard [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

activate: Activate a VERSION of a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.
create: Create a dashboard with DASHBOARD_SLUG and DASHBOARD_NAME within WORKSPACE_SLUG and APP_SLUG.
deactivate: Deactivate a VERSION of a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.
ls: List dashboards within WORKSPACE_SLUG and APP_SLUG.
restore: Restore a dashboard with DASHBOARD_SLUG from trash within WORKSPACE_SLUG and APP_SLUG.
rm: Delete a dashboard with DASHBOARD_SLUG permanently from trash within WORKSPACE_SLUG and APP_SLUG.
trash: Move a dashboard with DASHBOARD_SLUG to trash within WORKSPACE_SLUG and APP_SLUG.
update: Update the slug or name of a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.
version: Dashboard version commands.

engineai dashboard activate#

Activate a VERSION of a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: The dashboard's identifier. version: The version of the dashboard to activate.

Usage:

engineai dashboard activate [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG
                            VERSION

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard create#

Create a dashboard with DASHBOARD_SLUG and DASHBOARD_NAME within WORKSPACE_SLUG and APP_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: Identifier for the new dashboard (used in URLs). dashboard_name: The display name of the dashboard.

Usage:

engineai dashboard create [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG
                          DASHBOARD_NAME

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard deactivate#

Deactivate a VERSION of a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: The dashboard's identifier. version: The version of the dashboard to deactivate.

Usage:

engineai dashboard deactivate [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG
                              VERSION

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard ls#

List dashboards within WORKSPACE_SLUG and APP_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The app's identifier.

Usage:

engineai dashboard ls [OPTIONS] WORKSPACE_SLUG APP_SLUG

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard restore#

Restore a dashboard with DASHBOARD_SLUG from trash within WORKSPACE_SLUG and APP_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: The dashboard's identifier.

Usage:

engineai dashboard restore [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard rm#

Delete a dashboard with DASHBOARD_SLUG permanently from trash within WORKSPACE_SLUG and APP_SLUG.

NOTE: - The dashboard must be in the trash or have its parent app in the trash before it can be deleted permanently. - This action cannot be undone.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: The dashboard's identifier.

Usage:

engineai dashboard rm [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard trash#

Move a dashboard with DASHBOARD_SLUG to trash within WORKSPACE_SLUG and APP_SLUG.

NOTE: Once in the trash, you have 30 days to restore it otherwise it will be permanently deleted.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: The dashboard's identifier.

Usage:

engineai dashboard trash [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard update#

Update the slug or name of a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: The dashboard's identifier. slug: New slug for the dashboard. name: New name for the dashboard.

Usage:

engineai dashboard update [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG

Options:

Name	Type	Description	Default
`-s`, `--slug`	text	new slug.	None
`-n`, `--name`	text	new name.	None
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard version#

Dashboard version commands.

Usage:

engineai dashboard version [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

ls: List all versions of a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.
rm: Delete a VERSION from a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.

engineai dashboard version ls#

List all versions of a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: The dashboard's identifier.

Usage:

engineai dashboard version ls [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

engineai dashboard version rm#

Delete a VERSION from a dashboard identified by DASHBOARD_SLUG within WORKSPACE_SLUG and APP_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The parent app's identifier. dashboard_slug: The dashboard's identifier. version: The version of the dashboard to delete.

Usage:

engineai dashboard version rm [OPTIONS] WORKSPACE_SLUG APP_SLUG DASHBOARD_SLUG
                              VERSION

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`