Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tailor-platform/sdk/llms.txt

Use this file to discover all available pages before exploring further.

Display detailed information about your deployed application including configuration, URLs, and metadata. This command queries the workspace for the current application state.

​
Command Syntax

tailor-sdk show [options]

​
Options

​
--json
boolean
default:"false"
Output information as JSON format instead of human-readable text.Alias: -j
​
--workspace-id
string
Workspace ID to query. Can also be set via TAILOR_PLATFORM_WORKSPACE_ID environment variable or workspace profile.Alias: -w
​
--profile
string
Workspace profile name. Profiles store workspace ID and authentication token for easy switching between environments.Alias: -p
​
--config
string
default:"tailor.config.ts"
Path to SDK config file.Alias: -c

​
Common Options

The following common options are also available:
  • --env-file / -e - Path to environment file (error if not found)
  • --env-file-if-exists - Path to environment file (ignored if not found)
  • --verbose - Enable verbose logging (show stack traces on error)

​
Usage Examples

​
Show Application Info

tailor-sdk show --workspace-id ws_1234567890
Displays application information in human-readable format.

​
Show with Profile

tailor-sdk show --profile production
Uses the “production” profile to identify the workspace.

​
Show as JSON

tailor-sdk show -w ws_1234567890 --json
Outputs application information as JSON for parsing by other tools. 
tailor-sdk show --profile staging -j
Combines profile usage with JSON output.

​
Show with Custom Config

tailor-sdk show --config config/tailor.config.ts -w ws_1234567890
Uses a custom configuration file location.

​
Output Information

The show command displays the following information:

​
Application Details

​
name
string
Application name from your configuration
​
domain
string
Custom domain assigned to the application (if configured)
​
url
string
Full URL where the application is accessible
​
auth
string
Auth namespace used by the application

​
Security Configuration

​
cors
string[]
CORS allowed origins configured for the application
​
allowedIpAddresses
string[]
IP addresses allowed to access the application (if IP restrictions are enabled)
​
disableIntrospection
boolean
Whether GraphQL introspection is disabled

​
Workspace Details

​
workspaceId
string
Workspace ID where the application is deployed
​
workspaceName
string
Human-readable workspace name
​
workspaceRegion
string
Cloud region where the workspace is hosted

​
Timestamps

​
createdAt
Date | null
When the application was first created
​
updatedAt
Date | null
When the application was last updated

​
Output Examples

​
Human-Readable Format

$ tailor-sdk show -w ws_1234567890

Application: my-app
Workspace: My Workspace (ws_1234567890)
Region: us-east-1

URL: https://my-app.tailor.tech
Domain: app.example.com
Auth Namespace: my-app-auth

CORS:
  - https://example.com
  - https://app.example.com

Allowed IP Addresses: (none)
Introspection Disabled: false

Created: 2024-01-15T10:30:00Z
Updated: 2024-03-03T14:22:00Z

​
JSON Format

{
  "name": "my-app",
  "workspaceId": "ws_1234567890",
  "workspaceName": "My Workspace",
  "workspaceRegion": "us-east-1",
  "domain": "app.example.com",
  "url": "https://my-app.tailor.tech",
  "auth": "my-app-auth",
  "cors": [
    "https://example.com",
    "https://app.example.com"
  ],
  "allowedIpAddresses": [],
  "disableIntrospection": false,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-03-03T14:22:00.000Z"
}

​
Use Cases

​
Verify Deployment

tailor-sdk show --profile production
Quickly verify your production application is deployed and check its configuration.

​
Get Application URL

tailor-sdk show -w ws_1234567890 -j | jq -r '.url'
Extract just the application URL using jq.

​
Check CORS Configuration

tailor-sdk show --profile staging -j | jq -r '.cors[]'
List all configured CORS origins.

​
Compare Environments

tailor-sdk show --profile dev -j > dev.json
tailor-sdk show --profile prod -j > prod.json
diff dev.json prod.json
Compare configuration between development and production.

​
Authentication

Authentication token priority:
  1. TAILOR_PLATFORM_TOKEN environment variable
  2. TAILOR_TOKEN environment variable (deprecated)
  3. Profile specified via --profile or TAILOR_PLATFORM_PROFILE
  4. Current user from platform config (~/.config/tailor-platform/config.yaml)

​
Workspace ID Resolution

Workspace ID priority:
  1. --workspace-id command option
  2. TAILOR_PLATFORM_WORKSPACE_ID environment variable
  3. Profile specified via --profile or TAILOR_PLATFORM_PROFILE

​
Error Handling

If the application is not deployed: 
$ tailor-sdk show -w ws_1234567890

Error: Application "my-app" not found in workspace ws_1234567890
If workspace ID is not provided: 
$ tailor-sdk show

Error: Workspace ID is required. Provide via --workspace-id, 
TAILOR_PLATFORM_WORKSPACE_ID environment variable, or --profile.
The application name is read from your tailor.config.ts file. Make sure you’re in the correct project directory.
  • apply - Deploy application to workspace
  • remove - Remove application from workspace
  • workspace list - List all available workspaces

Build docs developers (and LLMs) love

Get started for freeTalk to us