Workspace Commands

Commands for managing workspaces and profiles.

workspace

Manage Tailor Platform workspaces.

Usage

tailor-sdk workspace [command]

Commands

CommandDescription
workspace appManage workspace applications
workspace createCreate a new Tailor Platform workspace.
workspace deleteDelete a Tailor Platform workspace.
workspace getShow detailed information about a workspace
workspace listList all Tailor Platform workspaces.
workspace restoreRestore a deleted workspace
workspace userManage workspace users

workspace create

Create a new Tailor Platform workspace.

Usage

tailor-sdk workspace create [options]

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse
--name <NAME>-nWorkspace nameYes-
--region <REGION>-rWorkspace region (us-west, asia-northeast)Yes-
--delete-protection-dEnable delete protectionNofalse
--organization-id <ORGANIZATION_ID>-oOrganization ID to workspace associate withNo-
--folder-id <FOLDER_ID>-fFolder ID to workspace associate withNo-
--profile-name <PROFILE_NAME>-pProfile name to createNo-
--profile-user <PROFILE_USER>-User email for the profile (defaults to current user)No-

workspace list

List all Tailor Platform workspaces.

Usage

tailor-sdk workspace list [options]

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse
--limit <LIMIT>-lMaximum number of workspaces to listNo-

workspace delete

Delete a Tailor Platform workspace.

Usage

tailor-sdk workspace delete [options]

Options

OptionAliasDescriptionRequiredDefault
--workspace-id <WORKSPACE_ID>-wWorkspace IDYes-
--yes-ySkip confirmation promptsNofalse

profile

Manage workspace profiles (user + workspace combinations).

Usage

tailor-sdk profile [command]

Commands

CommandDescription
profile createCreate a new profile.
profile deleteDelete a profile.
profile listList all profiles.
profile updateUpdate profile properties.

profile create

Create a new profile.

Usage

tailor-sdk profile create [options] <name>

Arguments

ArgumentDescriptionRequired
nameProfile nameYes

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse
--user <USER>-uUser emailYes-
--workspace-id <WORKSPACE_ID>-wWorkspace IDYes-

profile list

List all profiles.

Usage

tailor-sdk profile list [options]

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse

profile update

Update profile properties.

Usage

tailor-sdk profile update [options] <name>

Arguments

ArgumentDescriptionRequired
nameProfile nameYes

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse
--user <USER>-uNew user emailNo-
--workspace-id <WORKSPACE_ID>-wNew workspace IDNo-

profile delete

Delete a profile.

Usage

tailor-sdk profile delete [options] <name>

Arguments

ArgumentDescriptionRequired
nameProfile nameYes

workspace app

Manage workspace applications

Usage

tailor-sdk workspace app [command]

Commands

CommandDescription
workspace app healthCheck application schema health
workspace app listList applications in a workspace

workspace app health

Check application schema health

Usage

tailor-sdk workspace app health [options]

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-
--profile <PROFILE>-pWorkspace profileNo-
--name <NAME>-nApplication nameYes-

workspace app list

List applications in a workspace

Usage

tailor-sdk workspace app list [options]

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-
--profile <PROFILE>-pWorkspace profileNo-
--limit <LIMIT>-lMaximum number of applications to listNo-

workspace get

Show detailed information about a workspace

Usage

tailor-sdk workspace get [options]

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-
--profile <PROFILE>-pWorkspace profileNo-

workspace restore

Restore a deleted workspace

Usage

tailor-sdk workspace restore [options]

Options

OptionAliasDescriptionRequiredDefault
--workspace-id <WORKSPACE_ID>-wWorkspace IDYes-
--yes-ySkip confirmation promptsNofalse

workspace user

Manage workspace users

Usage

tailor-sdk workspace user [command]

Commands

CommandDescription
workspace user inviteInvite a user to a workspace
workspace user listList users in a workspace
workspace user removeRemove a user from a workspace
workspace user updateUpdate a user's role in a workspace

workspace user invite

Invite a user to a workspace

Usage

tailor-sdk workspace user invite [options]

Options

OptionAliasDescriptionRequiredDefault
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-
--profile <PROFILE>-pWorkspace profileNo-
--email <EMAIL>-Email address of the user to inviteYes-
--role <ROLE>-rRole to assign (admin, editor, viewer)Yes-

workspace user list

List users in a workspace

Usage

tailor-sdk workspace user list [options]

Options

OptionAliasDescriptionRequiredDefault
--json-jOutput as JSONNofalse
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-
--profile <PROFILE>-pWorkspace profileNo-
--limit <LIMIT>-lMaximum number of users to listNo-

workspace user remove

Remove a user from a workspace

Usage

tailor-sdk workspace user remove [options]

Options

OptionAliasDescriptionRequiredDefault
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-
--profile <PROFILE>-pWorkspace profileNo-
--email <EMAIL>-Email address of the user to removeYes-
--yes-ySkip confirmation promptsNofalse

workspace user update

Update a user's role in a workspace

Usage

tailor-sdk workspace user update [options]

Options

OptionAliasDescriptionRequiredDefault
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-
--profile <PROFILE>-pWorkspace profileNo-
--email <EMAIL>-Email address of the user to updateYes-
--role <ROLE>-rNew role to assign (admin, editor, viewer)Yes-