Skip to content

CLI (engineai)#

engineai dashboard#

Dashboard commands.

Usage:

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

Options:

Name Type Description Default
-s, --slug text Dashboard slug. None
--help boolean Show this message and exit. False

Subcommands

  • activate: Activate a dashboard Version.
  • create: Create a dashboard.
  • deactivate: Deactivate a dashboard Version.
  • ls: List all dashboards.
  • versions: Dashboard versions subgroup commands.

engineai dashboard activate#

Activate a dashboard Version.

WORKSPACE_SLUG: workspace slug where dashboard will be activated. APP_SLUG: app slug where dashboard will be activated. DASHBOARD_SLUG: dashboard slug. VERSION: dashboard version.

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.

WORKSPACE_SLUG: workspace slug where dashboard will be created. APP_SLUG: app slug where dashboard will be created.

Usage:

engineai dashboard create [OPTIONS] WORKSPACE_SLUG APP_SLUG

Options:

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

engineai dashboard deactivate#

Deactivate a dashboard Version.

WORKSPACE_SLUG: workspace slug where dashboard will be deactivated. APP_SLUG: app slug where dashboard will be deactivated. DASHBOARD_SLUG: dashboard slug. VERSION: dashboard version.

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 all dashboards.

Usage:

engineai dashboard ls [OPTIONS] WORKSPACE_SLUG APP_SLUG

Options:

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

engineai dashboard versions#

Dashboard versions subgroup commands.

Usage:

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

Options:

Name Type Description Default
-v, --version text Dashboard version. None
--help boolean Show this message and exit. False

Subcommands

  • ls: List all versions for a given dashboard slug.

engineai dashboard versions ls#

List all versions for a given dashboard slug.

Usage:

engineai dashboard versions ls [OPTIONS]

Options:

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