CLI Reference

Tailor SDK provides a command-line interface for managing projects and workspaces.

Usage

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">comman</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Common Options

The following options are available for most commands:

  • -e, --env-file - Specify a custom environment file path
  • -v, --verbose - Enable detailed logging output

Environment Variables

You can use environment variables to configure workspace and authentication:

  • TAILOR_PLATFORM_WORKSPACE_ID - Specify workspace ID for the apply command
  • TAILOR_PLATFORM_TOKEN - Specify authentication token (alternative to using login)
  • TAILOR_PLATFORM_PROFILE - Specify workspace profile name to use (combines user and workspace configuration)
  • TAILOR_PLATFORM_SDK_CONFIG_PATH - Specify path to the SDK config file (alternative to using --config option)

Commands

init

Initialize a new project using create-tailor-sdk.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">init</span><span style="color: var(--shiki-color-text)"> [name] [options]</span></span>
<span></span>

Arguments:

  • name - Project name

Options:

  • --template - Template name

generate

Generate files using Tailor configuration.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">generate</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -c, --config - Path to the SDK config file (default: tailor.config.ts)
  • -w, --watch - Watch for type/resolver changes and regenerate

apply

Apply Tailor configuration to deploy your application.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">apply</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -w, --workspace-id - ID of the workspace to apply the configuration to
  • -p, --profile - Workspace profile to use
  • -c, --config - Path to the SDK config file (default: tailor.config.ts)
  • -d, --dryRun - Run the command without making any changes

show

Show information about the deployed application.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">show</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -w, --workspace-id - ID of the workspace to show the application from
  • -p, --profile - Workspace profile to use
  • -c, --config - Path to the SDK config file (default: tailor.config.ts)
  • -f, --format - Output format: table or json (default: table)

login

Login to Tailor Platform.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">login</span></span>
<span></span>

logout

Logout from Tailor Platform.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">logout</span></span>
<span></span>

workspace

Manage Tailor Platform workspaces.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workspace</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">subcomman</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

workspace create

Create a new Tailor Platform workspace.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workspace</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">create</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -n, --name - Name of the workspace (required)
  • -r, --region - Region of the workspace: us-west or asia-northeast (required)
  • -d, --delete-protection - Enable delete protection for the workspace
  • --organization-id - Organization ID to associate the workspace with
  • --folder-id - Folder ID to associate the workspace with
  • -f, --format - Output format: table or json (default: table)

workspace list

List all Tailor Platform workspaces.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workspace</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">list</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -f, --format - Output format: table or json (default: table)

workspace delete

Delete a Tailor Platform workspace.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">workspace</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">delete</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -w, --workspace-id - ID of the workspace to delete (required)
  • -y, --yes - Skip confirmation prompt

profile

Manage workspace profiles (user + workspace combinations).

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">profile</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">subcomman</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

profile create

Create a new profile.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">profile</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">create</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">nam</span><span style="color: var(--shiki-color-text)">e</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Arguments:

  • name - Profile name (required)

Options:

  • -u, --user - User email (required)
  • -w, --workspace-id - Workspace ID (required)
  • -f, --format - Output format: table or json (default: table)

profile list

List all profiles.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">profile</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">list</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -f, --format - Output format: table or json (default: table)

profile update

Update profile properties.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">profile</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">update</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">nam</span><span style="color: var(--shiki-color-text)">e</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Arguments:

  • name - Profile name (required)

Options:

  • -u, --user - New user email
  • -w, --workspace-id - New workspace ID
  • -f, --format - Output format: table or json (default: table)

profile delete

Delete a profile.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">profile</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">delete</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">nam</span><span style="color: var(--shiki-color-text)">e</span><span style="color: var(--shiki-token-keyword)">&gt;</span></span>
<span></span>

Arguments:

  • name - Profile name (required)

user

Manage Tailor Platform users.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">user</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">subcomman</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

user current

Show current user.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">user</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">current</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

user list

List all users.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">user</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">list</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -f, --format - Output format: table or json (default: table)

user use

Set current user.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">user</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">use</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">use</span><span style="color: var(--shiki-color-text)">r</span><span style="color: var(--shiki-token-keyword)">&gt;</span></span>
<span></span>

Arguments:

  • user - User email (required)

machineuser

Manage machine users in your Tailor Platform application.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">machineuser</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">subcomman</span><span style="color: var(--shiki-color-text)">d</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

machineuser list

List all machine users in the application.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">machineuser</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">list</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Options:

  • -w, --workspace-id - ID of the workspace
  • -p, --profile - Workspace profile to use
  • -c, --config - Path to the SDK config file (default: tailor.config.ts)
  • -f, --format - Output format: table or json (default: table)

machineuser token

Get an access token for a machine user.

<span><span style="color: var(--shiki-token-function)">tailor-sdk</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">machineuser</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string)">token</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-keyword)">&lt;</span><span style="color: var(--shiki-token-string)">nam</span><span style="color: var(--shiki-color-text)">e</span><span style="color: var(--shiki-token-keyword)">&gt;</span><span style="color: var(--shiki-color-text)"> [options]</span></span>
<span></span>

Arguments:

  • name - Machine user name (required)

Options:

  • -w, --workspace-id - ID of the workspace
  • -p, --profile - Workspace profile to use
  • -c, --config - Path to the SDK config file (default: tailor.config.ts)
  • -f, --format - Output format: table or json (default: table)