Skip to content

CLI (engineai)#

engineai app#

App commands.

Usage:

engineai app [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • create: Create an app with APP_SLUG and APP_NAME within WORKSPACE_SLUG.
  • ls: List apps within WORKSPACE_SLUG.
  • restore: Restore an app with APP_SLUG from trash within WORKSPACE_SLUG.
  • rm: Delete an app with APP_SLUG permanently from trash within WORKSPACE_SLUG.
  • rule: App rule commands.
  • trash: Move an app with APP_SLUG to trash within WORKSPACE_SLUG.
  • update: Update the slug or name of an app with APP_SLUG within WORKSPACE_SLUG.

engineai app create#

Create an app with APP_SLUG and APP_NAME within WORKSPACE_SLUG.

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

Usage:

engineai app create [OPTIONS] WORKSPACE_SLUG APP_SLUG APP_NAME

Options:

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

engineai app ls#

List apps within WORKSPACE_SLUG.

Args: workspace_slug: The workspace's identifier.

Usage:

engineai app ls [OPTIONS] WORKSPACE_SLUG

Options:

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

engineai app restore#

Restore an app with APP_SLUG from trash within WORKSPACE_SLUG.

NOTE: Restoring an app won't restore dashboards that were already in the trash prior to the app.

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

Usage:

engineai app restore [OPTIONS] WORKSPACE_SLUG APP_SLUG

Options:

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

engineai app rm#

Delete an app with APP_SLUG permanently from trash within WORKSPACE_SLUG.

NOTE: - The app must be in the trash before it can be deleted permanently. - This action cannot be undone. - All resources associated with the app will be permanently deleted, regardless of being in the trash or not.

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

Usage:

engineai app rm [OPTIONS] WORKSPACE_SLUG APP_SLUG

Options:

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

engineai app rule#

App rule commands.

Usage:

engineai app rule [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • add: Add an authorization rule for a USER_EMAIL or GROUP_NAME with ROLE in the app identified by APP_SLUG within WORKSPACE_SLUG.
  • ls: List authorization rules for an app identified by APP_SLUG within WORKSPACE_SLUG.
  • rm: Remove authorization rule for USER_EMAIL or GROUP_NAME in the app identified by APP_SLUG within WORKSPACE_SLUG.
  • update: Update authorization rule for USER_EMAIL or GROUP_NAME to ROLE in the app identified by APP_SLUG within WORKSPACE_SLUG.

engineai app rule add#

Add an authorization rule for a USER_EMAIL or GROUP_NAME with ROLE in the app identified by APP_SLUG within WORKSPACE_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The app identifier. subject: Email of the user (if contains @) or name of the group. role: The role for the user or group in the app (MANAGER, WRITER, or READER).

Usage:

engineai app rule add [OPTIONS] WORKSPACE_SLUG APP_SLUG USER_EMAIL|GROUP_NAME
                      {manager|writer|reader}

Options:

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

engineai app rule ls#

List authorization rules for an app identified by APP_SLUG within WORKSPACE_SLUG.

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

Usage:

engineai app rule ls [OPTIONS] WORKSPACE_SLUG APP_SLUG

Options:

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

engineai app rule rm#

Remove authorization rule for USER_EMAIL or GROUP_NAME in the app identified by APP_SLUG within WORKSPACE_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The app identifier. subject: Email of the user (if contains @) or name of the group.

Usage:

engineai app rule rm [OPTIONS] WORKSPACE_SLUG APP_SLUG USER_EMAIL|GROUP_NAME

Options:

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

engineai app rule update#

Update authorization rule for USER_EMAIL or GROUP_NAME to ROLE in the app identified by APP_SLUG within WORKSPACE_SLUG.

Args: workspace_slug: The parent workspace's identifier. app_slug: The app identifier. subject: Email of the user (if contains @) or name of the group. role: The new role for the user or group in the app (MANAGER, WRITER, or READER).

Usage:

engineai app rule update [OPTIONS] WORKSPACE_SLUG APP_SLUG
                         USER_EMAIL|GROUP_NAME {manager|writer|reader}

Options:

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

engineai app trash#

Move an app with APP_SLUG to trash within WORKSPACE_SLUG.

NOTE: Once in the trash, you have 30 days to restore it otherwise the app and all its resources will be permanently deleted (including dashboards).

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

Usage:

engineai app trash [OPTIONS] WORKSPACE_SLUG APP_SLUG

Options:

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

engineai app update#

Update the slug or name of an app with APP_SLUG within WORKSPACE_SLUG.

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

Usage:

engineai app update [OPTIONS] WORKSPACE_SLUG APP_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