Skip to content

Application Commands

Commands for managing Tailor Platform applications. These commands work with tailor.config.ts.

init

Initialize a new project using create-sdk.

Usage

tailor-sdk init [options] [name]

Arguments

ArgumentDescriptionRequired
nameProject nameNo

Options

OptionAliasDescriptionRequiredDefault
--template <TEMPLATE>-tTemplate nameNo-

See Global Options for options available to all commands.

generate

Generate files using Tailor configuration.

Usage

tailor-sdk generate [options]

Options

OptionAliasDescriptionRequiredDefault
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"
--watch-WWatch for type/resolver changes and regenerateNofalse

See Global Options for options available to all commands.

apply

Apply Tailor configuration to deploy your application.

Usage

tailor-sdk apply [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH
--yes-ySkip confirmation promptsNofalse-
--dry-run-dRun the command without making any changesNo--
--no-schema-check-Skip schema diff check against migration snapshotsNo--
--no-cache-Disable bundle caching for this runNo--
--clean-cache-Clean the bundle cache before buildingNo--

See Global Options for options available to all commands.

Migration Handling:

When migrations are configured (db.tailordb.migration in config), the apply command automatically:

  1. Detects pending migration scripts that haven't been executed
  2. Applies schema changes in a safe order (pre-migration → script execution → post-migration)
  3. Executes migration scripts via TestExecScript API
  4. Updates migration state labels in TailorDB metadata

See TailorDB Commands for details on automatic migration execution.

Schema Check:

By default, apply performs two verification steps:

  1. Local schema check: Verifies that local schema changes match the migration files. This ensures migrations are properly generated before deployment.
  2. Remote schema check: Verifies that the remote schema matches the expected state based on migration history. This detects schema drift caused by manual changes or other developers.

If remote schema drift is detected, the apply will fail with an error showing the differences. This helps prevent applying migrations to an inconsistent state.

Use --no-schema-check to skip both verifications (not recommended for production).

Plan Output:

Before applying changes, apply shows a preview of the planned resource changes.

  • + means the resource will be created
  • ~ means the resource will be updated
  • - means the resource will be deleted
  • ± means the resource will be replaced

After the detailed list, a summary line is printed:

text
Plan: 5 to create, 3 to update, 1 to delete, 25 unchanged

Use --dry-run to preview the plan without applying anything.

remove

Remove all resources managed by the application from the workspace.

Usage

tailor-sdk remove [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH
--yes-ySkip confirmation promptsNofalse-

See Global Options for options available to all commands.

show

Show information about the deployed application.

Usage

tailor-sdk show [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH

See Global Options for options available to all commands.

open

Open Tailor Platform Console.

Usage

tailor-sdk open [options]

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH

See Global Options for options available to all commands.

api

Call Tailor Platform API endpoints directly.

Usage

tailor-sdk api [options] [command] <endpoint>

Arguments

ArgumentDescriptionRequired
endpointAPI endpoint to call (e.g., 'GetApplication' or 'tailor.v1.OperatorService/GetApplication').Yes

Options

OptionAliasDescriptionRequiredDefaultEnv
--workspace-id <WORKSPACE_ID>-wWorkspace IDNo-TAILOR_PLATFORM_WORKSPACE_ID
--profile <PROFILE>-pWorkspace profileNo-TAILOR_PLATFORM_PROFILE
--config <CONFIG>-cPath to SDK config fileNo"tailor.config.ts"TAILOR_PLATFORM_SDK_CONFIG_PATH
--body <BODY>-bRequest body as JSON.No"{}"-

See Global Options for options available to all commands.

Examples

Call an endpoint; workspaceId is auto-injected.

bash
$ tailor-sdk api GetApplication -b '{"applicationName":"app-1"}'

List all invocable OperatorService methods.

bash
$ tailor-sdk api list

Show the input message tree for an endpoint.

bash
$ tailor-sdk api inspect GetApplication

Notes

Use tailor-sdk api list to enumerate invocable methods and tailor-sdk api inspect <endpoint> to print an endpoint's input message tree (combine with --json for machine-readable output).

The request body is inferred from the proto definition of the target endpoint, and commonly required fields are auto-injected so they can be omitted from --body:

  • workspaceId — resolved from -w / TAILOR_PLATFORM_WORKSPACE_ID / the selected profile.
  • namespaceName — resolved from tailor.config.ts based on the endpoint's service:
    • Auth / Tenant / UserProfile endpoints use auth.name.
    • IdP / TailorDB / Pipeline endpoints use the sole configured namespace when exactly one is defined.

Values already present in --body are never overridden. If a value cannot be resolved (e.g. no config found), injection is silently skipped and the server-side validation error takes precedence.

api inspect

Print the input message tree of an OperatorService endpoint.

Usage

tailor-sdk api inspect <endpoint>

Arguments

ArgumentDescriptionRequired
endpointAPI endpoint to inspect (e.g., 'GetApplication' or 'tailor.v1.OperatorService/GetApplication').Yes

See Global Options for options available to all commands.

Examples

Show fields of GetApplicationRequest.

bash
$ tailor-sdk api inspect GetApplication

Inspect a deeply nested input with (oneof config) annotations.

bash
$ tailor-sdk api inspect CreateExecutorExecutor

Notes

Combine with the global --json flag for a machine-readable descriptor. Recursive type references and oneof membership are annotated. Use tailor-sdk api list to discover endpoint names.

api list

List all invocable OperatorService methods.

Usage

tailor-sdk api list

See Global Options for options available to all commands.

Notes

Only unary RPCs are listed; streaming methods are excluded because tailor-sdk api run issues a single JSON POST and reads one JSON response.