Workspace Commands

Commands for managing workspaces and profiles.

workspace

Manage Tailor Platform workspaces.

Usage

tailor-sdk workspace [command]

Commands

Command	Description
workspace app	Manage workspace applications
workspace create	Create a new Tailor Platform workspace.
workspace delete	Delete a Tailor Platform workspace.
workspace get	Show detailed information about a workspace
workspace list	List all Tailor Platform workspaces.
workspace restore	Restore a deleted workspace
workspace user	Manage workspace users

See Global Options for options available to all commands.

workspace create

Create a new Tailor Platform workspace.

Usage

tailor-sdk workspace create [options]

Options

Option	Alias	Description	Required	Default	Env
--name <NAME>	-n	Workspace name	Yes	-	-
--region <REGION>	-r	Workspace region (us-west, asia-northeast)	Yes	-	-
--delete-protection	-d	Enable delete protection	No	false	-
--organization-id <ORGANIZATION_ID>	-o	Organization ID to workspace associate with	No	-	TAILOR_PLATFORM_ORGANIZATION_ID
--folder-id <FOLDER_ID>	-f	Folder ID to workspace associate with	No	-	TAILOR_PLATFORM_FOLDER_ID
--profile-name <PROFILE_NAME>	-p	Profile name to create	No	-	-
--profile-user <PROFILE_USER>	-	User email for the profile (defaults to current user)	No	-	-

See Global Options for options available to all commands.

workspace list

List all Tailor Platform workspaces.

Usage

tailor-sdk workspace list [options]

Options

Option	Alias	Description	Required	Default
--limit <LIMIT>	-l	Maximum number of workspaces to list	No	-

See Global Options for options available to all commands.

workspace delete

Delete a Tailor Platform workspace.

Usage

tailor-sdk workspace delete [options]

Options

Option	Alias	Description	Required	Default
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	Yes	-
--yes	-y	Skip confirmation prompts	No	false

See Global Options for options available to all commands.

profile

Manage workspace profiles (user + workspace combinations).

Usage

tailor-sdk profile [command]

Commands

Command	Description
profile create	Create a new profile.
profile delete	Delete a profile.
profile list	List all profiles.
profile update	Update profile properties.

See Global Options for options available to all commands.

profile create

Create a new profile.

Usage

tailor-sdk profile create [options] <name>

Arguments

Argument	Description	Required
name	Profile name	Yes

Options

Option	Alias	Description	Required	Default
--user <USER>	-u	User email	Yes	-
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	Yes	-

See Global Options for options available to all commands.

profile list

List all profiles.

Usage

tailor-sdk profile list

See Global Options for options available to all commands.

profile update

Update profile properties.

Usage

tailor-sdk profile update [options] <name>

Arguments

Argument	Description	Required
name	Profile name	Yes

Options

Option	Alias	Description	Required	Default
--user <USER>	-u	New user email	No	-
--workspace-id <WORKSPACE_ID>	-w	New workspace ID	No	-

See Global Options for options available to all commands.

profile delete

Delete a profile.

Usage

tailor-sdk profile delete <name>

Arguments

Argument	Description	Required
name	Profile name	Yes

See Global Options for options available to all commands.

workspace app

Manage workspace applications

Usage

tailor-sdk workspace app [command]

Commands

Command	Description
workspace app health	Check application schema health
workspace app list	List applications in a workspace

See Global Options for options available to all commands.

workspace app health

Check application schema health

Usage

tailor-sdk workspace app health [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--name <NAME>	-n	Application name	Yes	-	-

See Global Options for options available to all commands.

workspace app list

List applications in a workspace

Usage

tailor-sdk workspace app list [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--limit <LIMIT>	-l	Maximum number of applications to list	No	-	-

See Global Options for options available to all commands.

workspace get

Show detailed information about a workspace

Usage

tailor-sdk workspace get [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE

See Global Options for options available to all commands.

workspace restore

Restore a deleted workspace

Usage

tailor-sdk workspace restore [options]

Options

Option	Alias	Description	Required	Default
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	Yes	-
--yes	-y	Skip confirmation prompts	No	false

See Global Options for options available to all commands.

workspace user

Manage workspace users

Usage

tailor-sdk workspace user [command]

Commands

Command	Description
workspace user invite	Invite a user to a workspace
workspace user list	List users in a workspace
workspace user remove	Remove a user from a workspace
workspace user update	Update a user's role in a workspace

See Global Options for options available to all commands.

workspace user invite

Invite a user to a workspace

Usage

tailor-sdk workspace user invite [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--email <EMAIL>	-	Email address of the user to invite	Yes	-	-
--role <ROLE>	-r	Role to assign (admin, editor, viewer)	Yes	-	-

See Global Options for options available to all commands.

workspace user list

List users in a workspace

Usage

tailor-sdk workspace user list [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--limit <LIMIT>	-l	Maximum number of users to list	No	-	-

See Global Options for options available to all commands.

workspace user remove

Remove a user from a workspace

Usage

tailor-sdk workspace user remove [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--email <EMAIL>	-	Email address of the user to remove	Yes	-	-
--yes	-y	Skip confirmation prompts	No	false	-

See Global Options for options available to all commands.

workspace user update

Update a user's role in a workspace

Usage

tailor-sdk workspace user update [options]

Options

Option	Alias	Description	Required	Default	Env
--workspace-id <WORKSPACE_ID>	-w	Workspace ID	No	-	TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>	-p	Workspace profile	No	-	TAILOR_PLATFORM_PROFILE
--email <EMAIL>	-	Email address of the user to update	Yes	-	-
--role <ROLE>	-r	New role to assign (admin, editor, viewer)	Yes	-	-

See Global Options for options available to all commands.