@tailor-platform/sdk 1.17.1 → 1.18.0

package/docs/cli/user.md

@@ -2,46 +2,74 @@
 
 Commands for authentication and user management.
 
-<!-- politty:command:login:start -->
+<!-- politty:command:login:heading:start -->
 
 ## login
 
+<!-- politty:command:login:heading:end -->
+
+<!-- politty:command:login:description:start -->
+
 Login to Tailor Platform.
 
+<!-- politty:command:login:description:end -->
+
+<!-- politty:command:login:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk login [options]
 ```
 
-<!-- politty:command:login:end -->
+<!-- politty:command:login:usage:end -->
 
-<!-- politty:command:logout:start -->
+<!-- politty:command:logout:heading:start -->
 
 ## logout
 
+<!-- politty:command:logout:heading:end -->
+
+<!-- politty:command:logout:description:start -->
+
 Logout from Tailor Platform.
 
+<!-- politty:command:logout:description:end -->
+
+<!-- politty:command:logout:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk logout [options]
 ```
 
-<!-- politty:command:logout:end -->
+<!-- politty:command:logout:usage:end -->
 
-<!-- politty:command:user:start -->
+<!-- politty:command:user:heading:start -->
 
 ## user
 
+<!-- politty:command:user:heading:end -->
+
+<!-- politty:command:user:description:start -->
+
 Manage Tailor Platform users.
 
+<!-- politty:command:user:description:end -->
+
+<!-- politty:command:user:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user [command]
 ```
 
+<!-- politty:command:user:usage:end -->
+
+<!-- politty:command:user:subcommands:start -->
+
 **Commands**
 
 | Command                         | Description                    |
@@ -51,76 +79,124 @@ tailor-sdk user [command]
 | [`user pat`](#user-pat)         | Manage personal access tokens. |
 | [`user switch`](#user-switch)   | Set current user.              |
 
-<!-- politty:command:user:end -->
-<!-- politty:command:user current:start -->
+<!-- politty:command:user:subcommands:end -->
+<!-- politty:command:user current:heading:start -->
 
 ### user current
 
+<!-- politty:command:user current:heading:end -->
+
+<!-- politty:command:user current:description:start -->
+
 Show current user.
 
+<!-- politty:command:user current:description:end -->
+
+<!-- politty:command:user current:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user current [options]
 ```
 
-<!-- politty:command:user current:end -->
-<!-- politty:command:user list:start -->
+<!-- politty:command:user current:usage:end -->
+<!-- politty:command:user list:heading:start -->
 
 ### user list
 
+<!-- politty:command:user list:heading:end -->
+
+<!-- politty:command:user list:description:start -->
+
 List all users.
 
+<!-- politty:command:user list:description:end -->
+
+<!-- politty:command:user list:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user list [options]
 ```
 
+<!-- politty:command:user list:usage:end -->
+
+<!-- politty:command:user list:options:start -->
+
 **Options**
 
 | Option   | Alias | Description    | Required | Default |
 | -------- | ----- | -------------- | -------- | ------- |
 | `--json` | `-j`  | Output as JSON | No       | `false` |
 
-<!-- politty:command:user list:end -->
-<!-- politty:command:user switch:start -->
+<!-- politty:command:user list:options:end -->
+<!-- politty:command:user switch:heading:start -->
 
 ### user switch
 
+<!-- politty:command:user switch:heading:end -->
+
+<!-- politty:command:user switch:description:start -->
+
 Set current user.
 
+<!-- politty:command:user switch:description:end -->
+
+<!-- politty:command:user switch:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user switch [options] <user>
 ```
 
+<!-- politty:command:user switch:usage:end -->
+
+<!-- politty:command:user switch:arguments:start -->
+
 **Arguments**
 
 | Argument | Description | Required |
 | -------- | ----------- | -------- |
 | `user`   | User email  | Yes      |
 
-<!-- politty:command:user switch:end -->
-<!-- politty:command:user pat:start -->
+<!-- politty:command:user switch:arguments:end -->
+<!-- politty:command:user pat:heading:start -->
 
 ### user pat
 
+<!-- politty:command:user pat:heading:end -->
+
+<!-- politty:command:user pat:description:start -->
+
 Manage personal access tokens.
 
+<!-- politty:command:user pat:description:end -->
+
+<!-- politty:command:user pat:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user pat [options] [command]
 ```
 
+<!-- politty:command:user pat:usage:end -->
+
+<!-- politty:command:user pat:options:start -->
+
 **Options**
 
 | Option   | Alias | Description    | Required | Default |
 | -------- | ----- | -------------- | -------- | ------- |
 | `--json` | `-j`  | Output as JSON | No       | `false` |
 
+<!-- politty:command:user pat:options:end -->
+
+<!-- politty:command:user pat:subcommands:start -->
+
 **Commands**
 
 | Command                               | Description                                           |
@@ -130,44 +206,72 @@ tailor-sdk user pat [options] [command]
 | [`user pat list`](#user-pat-list)     | List all personal access tokens.                      |
 | [`user pat update`](#user-pat-update) | Update a personal access token (delete and recreate). |
 
-<!-- politty:command:user pat:end -->
-<!-- politty:command:user pat list:start -->
+<!-- politty:command:user pat:subcommands:end -->
+<!-- politty:command:user pat list:heading:start -->
 
 #### user pat list
 
+<!-- politty:command:user pat list:heading:end -->
+
+<!-- politty:command:user pat list:description:start -->
+
 List all personal access tokens.
 
+<!-- politty:command:user pat list:description:end -->
+
+<!-- politty:command:user pat list:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user pat list [options]
 ```
 
+<!-- politty:command:user pat list:usage:end -->
+
+<!-- politty:command:user pat list:options:start -->
+
 **Options**
 
 | Option   | Alias | Description    | Required | Default |
 | -------- | ----- | -------------- | -------- | ------- |
 | `--json` | `-j`  | Output as JSON | No       | `false` |
 
-<!-- politty:command:user pat list:end -->
-<!-- politty:command:user pat create:start -->
+<!-- politty:command:user pat list:options:end -->
+<!-- politty:command:user pat create:heading:start -->
 
 #### user pat create
 
+<!-- politty:command:user pat create:heading:end -->
+
+<!-- politty:command:user pat create:description:start -->
+
 Create a new personal access token.
 
+<!-- politty:command:user pat create:description:end -->
+
+<!-- politty:command:user pat create:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user pat create [options] <name>
 ```
 
+<!-- politty:command:user pat create:usage:end -->
+
+<!-- politty:command:user pat create:arguments:start -->
+
 **Arguments**
 
 | Argument | Description | Required |
 | -------- | ----------- | -------- |
 | `name`   | Token name  | Yes      |
 
+<!-- politty:command:user pat create:arguments:end -->
+
+<!-- politty:command:user pat create:options:start -->
+
 **Options**
 
 | Option    | Alias | Description                                 | Required | Default |
@@ -175,44 +279,72 @@ tailor-sdk user pat create [options] <name>
 | `--json`  | `-j`  | Output as JSON                              | No       | `false` |
 | `--write` | `-W`  | Grant write permission (default: read-only) | No       | `false` |
 
-<!-- politty:command:user pat create:end -->
-<!-- politty:command:user pat delete:start -->
+<!-- politty:command:user pat create:options:end -->
+<!-- politty:command:user pat delete:heading:start -->
 
 #### user pat delete
 
+<!-- politty:command:user pat delete:heading:end -->
+
+<!-- politty:command:user pat delete:description:start -->
+
 Delete a personal access token.
 
+<!-- politty:command:user pat delete:description:end -->
+
+<!-- politty:command:user pat delete:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user pat delete [options] <name>
 ```
 
+<!-- politty:command:user pat delete:usage:end -->
+
+<!-- politty:command:user pat delete:arguments:start -->
+
 **Arguments**
 
 | Argument | Description | Required |
 | -------- | ----------- | -------- |
 | `name`   | Token name  | Yes      |
 
-<!-- politty:command:user pat delete:end -->
-<!-- politty:command:user pat update:start -->
+<!-- politty:command:user pat delete:arguments:end -->
+<!-- politty:command:user pat update:heading:start -->
 
 #### user pat update
 
+<!-- politty:command:user pat update:heading:end -->
+
+<!-- politty:command:user pat update:description:start -->
+
 Update a personal access token (delete and recreate).
 
+<!-- politty:command:user pat update:description:end -->
+
+<!-- politty:command:user pat update:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk user pat update [options] <name>
 ```
 
+<!-- politty:command:user pat update:usage:end -->
+
+<!-- politty:command:user pat update:arguments:start -->
+
 **Arguments**
 
 | Argument | Description | Required |
 | -------- | ----------- | -------- |
 | `name`   | Token name  | Yes      |
 
+<!-- politty:command:user pat update:arguments:end -->
+
+<!-- politty:command:user pat update:options:start -->
+
 **Options**
 
 | Option    | Alias | Description                                                | Required | Default |
@@ -220,7 +352,7 @@ tailor-sdk user pat update [options] <name>
 | `--json`  | `-j`  | Output as JSON                                             | No       | `false` |
 | `--write` | `-W`  | Grant write permission (if not specified, keeps read-only) | No       | `false` |
 
-<!-- politty:command:user pat update:end -->
+<!-- politty:command:user pat update:options:end -->
 
 When no subcommand is provided, defaults to `list`.
 

package/docs/cli/workflow.md

@@ -2,18 +2,30 @@
 
 Commands for managing workflows and workflow executions.
 
-<!-- politty:command:workflow:start -->
+<!-- politty:command:workflow:heading:start -->
 
 ## workflow
 
+<!-- politty:command:workflow:heading:end -->
+
+<!-- politty:command:workflow:description:start -->
+
 Manage workflows and workflow executions.
 
+<!-- politty:command:workflow:description:end -->
+
+<!-- politty:command:workflow:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk workflow [command]
 ```
 
+<!-- politty:command:workflow:usage:end -->
+
+<!-- politty:command:workflow:subcommands:start -->
+
 **Commands**
 
 | Command                                       | Description                                    |
@@ -24,19 +36,31 @@ tailor-sdk workflow [command]
 | [`workflow executions`](#workflow-executions) | List or get workflow executions.               |
 | [`workflow resume`](#workflow-resume)         | Resume a failed or pending workflow execution. |
 
-<!-- politty:command:workflow:end -->
-<!-- politty:command:workflow list:start -->
+<!-- politty:command:workflow:subcommands:end -->
+<!-- politty:command:workflow list:heading:start -->
 
 ### workflow list
 
+<!-- politty:command:workflow list:heading:end -->
+
+<!-- politty:command:workflow list:description:start -->
+
 List all workflows in the workspace.
 
+<!-- politty:command:workflow list:description:end -->
+
+<!-- politty:command:workflow list:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk workflow list [options]
 ```
 
+<!-- politty:command:workflow list:usage:end -->
+
+<!-- politty:command:workflow list:options:start -->
+
 **Options**
 
 | Option                          | Alias | Description       | Required | Default |
@@ -45,25 +69,41 @@ tailor-sdk workflow list [options]
 | `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID      | No       | -       |
 | `--profile <PROFILE>`           | `-p`  | Workspace profile | No       | -       |
 
-<!-- politty:command:workflow list:end -->
-<!-- politty:command:workflow get:start -->
+<!-- politty:command:workflow list:options:end -->
+<!-- politty:command:workflow get:heading:start -->
 
 ### workflow get
 
+<!-- politty:command:workflow get:heading:end -->
+
+<!-- politty:command:workflow get:description:start -->
+
 Get workflow details.
 
+<!-- politty:command:workflow get:description:end -->
+
+<!-- politty:command:workflow get:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk workflow get [options] <name>
 ```
 
+<!-- politty:command:workflow get:usage:end -->
+
+<!-- politty:command:workflow get:arguments:start -->
+
 **Arguments**
 
 | Argument | Description   | Required |
 | -------- | ------------- | -------- |
 | `name`   | Workflow name | Yes      |
 
+<!-- politty:command:workflow get:arguments:end -->
+
+<!-- politty:command:workflow get:options:start -->
+
 **Options**
 
 | Option                          | Alias | Description       | Required | Default |
@@ -72,25 +112,41 @@ tailor-sdk workflow get [options] <name>
 | `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID      | No       | -       |
 | `--profile <PROFILE>`           | `-p`  | Workspace profile | No       | -       |
 
-<!-- politty:command:workflow get:end -->
-<!-- politty:command:workflow start:start -->
+<!-- politty:command:workflow get:options:end -->
+<!-- politty:command:workflow start:heading:start -->
 
 ### workflow start
 
+<!-- politty:command:workflow start:heading:end -->
+
+<!-- politty:command:workflow start:description:start -->
+
 Start a workflow execution.
 
+<!-- politty:command:workflow start:description:end -->
+
+<!-- politty:command:workflow start:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk workflow start [options] <name>
 ```
 
+<!-- politty:command:workflow start:usage:end -->
+
+<!-- politty:command:workflow start:arguments:start -->
+
 **Arguments**
 
 | Argument | Description   | Required |
 | -------- | ------------- | -------- |
 | `name`   | Workflow name | Yes      |
 
+<!-- politty:command:workflow start:arguments:end -->
+
+<!-- politty:command:workflow start:options:start -->
+
 **Options**
 
 | Option                          | Alias | Description                                                    | Required | Default              |
@@ -105,25 +161,41 @@ tailor-sdk workflow start [options] <name>
 | `--interval <INTERVAL>`         | `-i`  | Polling interval when using --wait (e.g., '3s', '500ms', '1m') | No       | `"3s"`               |
 | `--logs`                        | `-l`  | Display job execution logs after completion (requires --wait)  | No       | `false`              |
 
-<!-- politty:command:workflow start:end -->
-<!-- politty:command:workflow executions:start -->
+<!-- politty:command:workflow start:options:end -->
+<!-- politty:command:workflow executions:heading:start -->
 
 ### workflow executions
 
+<!-- politty:command:workflow executions:heading:end -->
+
+<!-- politty:command:workflow executions:description:start -->
+
 List or get workflow executions.
 
+<!-- politty:command:workflow executions:description:end -->
+
+<!-- politty:command:workflow executions:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk workflow executions [options] [executionId]
 ```
 
+<!-- politty:command:workflow executions:usage:end -->
+
+<!-- politty:command:workflow executions:arguments:start -->
+
 **Arguments**
 
 | Argument      | Description                               | Required |
 | ------------- | ----------------------------------------- | -------- |
 | `executionId` | Execution ID (if provided, shows details) | No       |
 
+<!-- politty:command:workflow executions:arguments:end -->
+
+<!-- politty:command:workflow executions:options:start -->
+
 **Options**
 
 | Option                            | Alias | Description                                                    | Required | Default |
@@ -137,25 +209,41 @@ tailor-sdk workflow executions [options] [executionId]
 | `--interval <INTERVAL>`           | `-i`  | Polling interval when using --wait (e.g., '3s', '500ms', '1m') | No       | `"3s"`  |
 | `--logs`                          | -     | Display job execution logs (detail mode only)                  | No       | `false` |
 
-<!-- politty:command:workflow executions:end -->
-<!-- politty:command:workflow resume:start -->
+<!-- politty:command:workflow executions:options:end -->
+<!-- politty:command:workflow resume:heading:start -->
 
 ### workflow resume
 
+<!-- politty:command:workflow resume:heading:end -->
+
+<!-- politty:command:workflow resume:description:start -->
+
 Resume a failed or pending workflow execution.
 
+<!-- politty:command:workflow resume:description:end -->
+
+<!-- politty:command:workflow resume:usage:start -->
+
 **Usage**
 
 ```
 tailor-sdk workflow resume [options] <executionId>
 ```
 
+<!-- politty:command:workflow resume:usage:end -->
+
+<!-- politty:command:workflow resume:arguments:start -->
+
 **Arguments**
 
 | Argument      | Description         | Required |
 | ------------- | ------------------- | -------- |
 | `executionId` | Failed execution ID | Yes      |
 
+<!-- politty:command:workflow resume:arguments:end -->
+
+<!-- politty:command:workflow resume:options:start -->
+
 **Options**
 
 | Option                          | Alias | Description                                                    | Required | Default |
@@ -167,7 +255,7 @@ tailor-sdk workflow resume [options] <executionId>
 | `--interval <INTERVAL>`         | `-i`  | Polling interval when using --wait (e.g., '3s', '500ms', '1m') | No       | `"3s"`  |
 | `--logs`                        | `-l`  | Display job execution logs after completion (requires --wait)  | No       | `false` |
 
-<!-- politty:command:workflow resume:end -->
+<!-- politty:command:workflow resume:options:end -->
 
 **Usage Examples:**