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

create: Create a workspace with SLUG and NAME.
ls: List all user workspaces.
member: Workspace member commands.
rm: Delete a workspace with SLUG.
update: Update the name or slug of a workspace with SLUG.

engineai workspace create#

Create a workspace with SLUG and NAME.

Args: slug: Identifier for the new workspace (used in URLs). name: The display name of the workspace.

Usage:

engineai workspace create [OPTIONS] SLUG NAME

Options:

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

engineai workspace ls#

List all user workspaces.

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

invite: Invite a user with EMAIL and ROLE to the workspace identified by SLUG.
ls: List all members in a workspace with SLUG.
rm: Remove member with EMAIL from workspace identified by SLUG.
transfer: Transfer workspace identified by SLUG to an admin with EMAIL.
update: Update member with EMAIL to new ROLE in the workspace identified by SLUG.

engineai workspace member invite#

Invite a user with EMAIL and ROLE to the workspace identified by SLUG.

Args: slug: The workspace's identifier. email: Email of the user to be added. role: Role for the user in the workspace (ADMIN or MEMBER).

Usage:

engineai workspace member invite [OPTIONS] SLUG EMAIL {admin|member}

Options:

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

engineai workspace member ls#

List all members in a workspace with SLUG.

Args: slug: The workspace's identifier

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 with EMAIL from workspace identified by SLUG.

Args: slug: The workspace's identifier. email: Email of the user to be removed.

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 identified by SLUG to an admin with EMAIL.

Args: slug: The workspace's identifier. email: Email of the user (admin) to whom the workspace will be transferred.

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 with EMAIL to new ROLE in the workspace identified by SLUG.

Args: slug: The workspace's identifier. email: Email of the user to be updated. 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#

Delete a workspace with SLUG.

NOTE: This will permanently delete the workspace and all its contents (apps, dashboards, etc.).

Args: slug: The workspace's identifier.

Usage:

engineai workspace rm [OPTIONS] SLUG

Options:

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

engineai workspace update#

Update the name or slug of a workspace with SLUG.

Args: slug: The parent workspace's identifier. new_slug: New slug for the workspace. name: New name for the workspace.

Usage:

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