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 workspace profiles.
Profiles are named combinations of a user and workspace ID that allow you to quickly switch between different development contexts.
profile
Manage workspace profiles (user + workspace combinations).
Usage
tailor-sdk profile [command]
| Command | Description |
|---|
profile list | List all profiles |
profile create | Create a new profile |
profile update | Update profile properties |
profile delete | Delete a profile |
list.
What are Profiles?
Profiles store a combination of:
- User: The authenticated user email
- Workspace ID: The workspace to operate in
Instead of specifying --workspace-id on every command, you can use --profile <name> to reference a saved profile.
Example Workflow
# Create profiles for different environments
tailor-sdk profile create dev -u dev@example.com -w workspace-dev-id
tailor-sdk profile create prod -u prod@example.com -w workspace-prod-id
# Use profiles in commands
tailor-sdk apply --profile dev
tailor-sdk workspace get --profile prod
profile list
List all profiles.
Usage
tailor-sdk profile list [options]
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
[
{
"name": "dev",
"user": "dev@example.com",
"workspaceId": "550e8400-e29b-41d4-a716-446655440000"
},
{
"name": "prod",
"user": "prod@example.com",
"workspaceId": "660e8400-e29b-41d4-a716-446655440001"
}
]
profile create
Create a new profile.
Usage
tailor-sdk profile create [options] <name>
| Argument | Description | Required |
|---|
name | Profile name | Yes |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--user <USER> | -u | User email | Yes | - |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | Yes | - |
tailor-sdk profile create dev -u dev@example.com -w 550e8400-e29b-41d4-a716-446655440000
Profile "dev" created successfully.
{
"name": "dev",
"user": "dev@example.com",
"workspaceId": "550e8400-e29b-41d4-a716-446655440000"
}
The user must be authenticated (logged in) before creating a profile. The workspace must also exist and be accessible to the user.
profile update
Update profile properties.
Usage
tailor-sdk profile update [options] <name>
| Argument | Description | Required |
|---|
name | Profile name | Yes |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--user <USER> | -u | New user email | No | - |
--workspace-id <WORKSPACE_ID> | -w | New workspace ID | No | - |
tailor-sdk profile update dev -u newuser@example.com
tailor-sdk profile update dev -w new-workspace-id
tailor-sdk profile update dev -u newuser@example.com -w new-workspace-id
Profile "dev" updated successfully
{
"name": "dev",
"user": "newuser@example.com",
"workspaceId": "new-workspace-id"
}
At least one property (user or workspace ID) must be provided when updating a profile.
profile delete
Delete a profile.
Usage
tailor-sdk profile delete [options] <name>
| Argument | Description | Required |
|---|
name | Profile name | Yes |
tailor-sdk profile delete dev
Profile "dev" deleted successfully.
Deleting a profile only removes the profile configuration. It does not delete the workspace or affect the user account.