Skip to content

CLI (engineai)#

engineai workspace#

Workspace commands.

Usage:

engineai workspace [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • add: Add new workspace.
  • ls: List all workspace.
  • member: Workspace member commands.
  • rm: Remove workspace.
  • update: Update current workspace.

engineai workspace add#

Add new workspace.

Args: workspace_name: workspace to be added.

Usage:

engineai workspace add [OPTIONS] SLUG NAME

Options:

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

engineai workspace ls#

List all workspace.

Usage:

engineai workspace ls [OPTIONS]

Options:

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

engineai workspace member#

Workspace member commands.

Usage:

engineai workspace member [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

  • add: Add new member to workspace.
  • ls: List all member in workspace.
  • rm: Remove member from workspace.
  • transfer: Transfer workspace to another member.
  • update: Update member role in workspace.

engineai workspace member add#

Add new member to workspace.

SLUG: workspace to be updated. EMAIL: the user to be added to workspace. ROLE: role for the user in the workspace (ADMIN or MEMBER).

Usage:

engineai workspace member add [OPTIONS] SLUG EMAIL {ADMIN|MEMBER}

Options:

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

engineai workspace member ls#

List all member in workspace.

SLUG: workspace to be selected.

Usage:

engineai workspace member ls [OPTIONS] SLUG

Options:

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

engineai workspace member rm#

Remove member from workspace.

SLUG: workspace to be updated. EMAIL: the user to be removed from workspace.

Usage:

engineai workspace member rm [OPTIONS] SLUG EMAIL

Options:

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

engineai workspace member transfer#

Transfer workspace to another member.

SLUG: workspace to be updated. EMAIL: member to be new workspace owner.

Usage:

engineai workspace member transfer [OPTIONS] SLUG EMAIL

Options:

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

engineai workspace member update#

Update member role in workspace.

SLUG: workspace to be updated. EMAIL: the user to be updated in the workspace. ROLE: new role for the user in the workspace (ADMIN or MEMBER).

Usage:

engineai workspace member update [OPTIONS] SLUG EMAIL {ADMIN|MEMBER}

Options:

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

engineai workspace rm#

Remove workspace.

Args: workspace_name: workspace to be removed.

Usage:

engineai workspace rm [OPTIONS] SLUG

Options:

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

engineai workspace update#

Update current workspace.

Args: workspace_slug: workspace to be updated. slug: new workspace slug. name: new workspace name.

Usage:

engineai workspace update [OPTIONS] WORKSPACE_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