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.
Commands for managing and deploying static websites.
staticwebsite
Manage static websites in your workspace.
Usage
tailor-sdk staticwebsite [command]
| Command | Description |
|---|
staticwebsite deploy | Deploy a static website from a local build directory |
staticwebsite list | List all static websites in a workspace |
staticwebsite get | Get details of a specific static website |
staticwebsite deploy
Deploy a static website from a local build directory.
Usage
tailor-sdk staticwebsite deploy [options]
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
--name <NAME> | -n | Static website name | Yes | - |
--dir <DIR> | -d | Path to the static website files | Yes | - |
tailor-sdk staticwebsite deploy --name my-website --dir ./dist
tailor-sdk staticwebsite deploy -n my-website -d ./dist -w ws_abc123
tailor-sdk staticwebsite deploy -n my-website -d ./build --json
Deployment Notes
- The deployment process uploads all files from the specified directory
- Files are uploaded with appropriate MIME types based on file extensions
- Unsupported file types or invalid files will be skipped with warnings
- The deployment URL is returned after successful deployment
staticwebsite list
List all static websites in a workspace.
Usage
tailor-sdk staticwebsite list [options]
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
tailor-sdk staticwebsite list
tailor-sdk staticwebsite list --json
tailor-sdk staticwebsite list -w ws_abc123
staticwebsite get
Get details of a specific static website.
Usage
tailor-sdk staticwebsite get [options] <name>
| Argument | Description | Required |
|---|
name | Static website name | Yes |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
tailor-sdk staticwebsite get my-website
tailor-sdk staticwebsite get my-website --json
tailor-sdk staticwebsite get my-website -w ws_abc123