@tailor-platform/sdk 2.0.0-next.1 → 2.0.0-next.3

package/docs/cli/crashreport.md

@@ -2,36 +2,18 @@
 
 Commands for managing crash reports.
 
-<!-- politty:command:crashreport:heading:start -->
-
 ## crashreport
 
-<!-- politty:command:crashreport:heading:end -->
-
-<!-- politty:command:crashreport:description:start -->
-
 Manage crash reports.
 
-<!-- politty:command:crashreport:description:end -->
-
-<!-- politty:command:crashreport:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk crashreport [command]
+tailor crashreport [command]
 ```
 
-<!-- politty:command:crashreport:usage:end -->
-
-<!-- politty:command:crashreport:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:crashreport:global-options-link:end -->
-
-<!-- politty:command:crashreport:subcommands:start -->
-
 **Commands**
 
 | Command                                 | Description                                    |
@@ -39,31 +21,16 @@ See [Global Options](../cli-reference.md#global-options) for options available t
 | [`crashreport list`](#crashreport-list) | List local crash report files.                 |
 | [`crashreport send`](#crashreport-send) | Submit a crash report to help improve the SDK. |
 
-<!-- politty:command:crashreport:subcommands:end -->
-<!-- politty:command:crashreport list:heading:start -->
-
 ### crashreport list
 
-<!-- politty:command:crashreport list:heading:end -->
-
-<!-- politty:command:crashreport list:description:start -->
-
 List local crash report files.
 
-<!-- politty:command:crashreport list:description:end -->
-
-<!-- politty:command:crashreport list:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk crashreport list [options]
+tailor crashreport list [options]
 ```
 
-<!-- politty:command:crashreport list:usage:end -->
-
-<!-- politty:command:crashreport list:options:start -->
-
 **Options**
 
 | Option            | Alias | Description                                              | Required | Default  |
@@ -71,47 +38,22 @@ tailor-sdk crashreport list [options]
 | `--order <ORDER>` | -     | Sort order (asc or desc)                                 | No       | `"desc"` |
 | `--limit <LIMIT>` | `-l`  | Maximum number of items to return (0 or omit: unlimited) | No       | -        |
 
-<!-- politty:command:crashreport list:options:end -->
-
-<!-- politty:command:crashreport list:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:crashreport list:global-options-link:end -->
-<!-- politty:command:crashreport send:heading:start -->
-
 ### crashreport send
 
-<!-- politty:command:crashreport send:heading:end -->
-
-<!-- politty:command:crashreport send:description:start -->
-
 Submit a crash report to help improve the SDK.
 
-<!-- politty:command:crashreport send:description:end -->
-
-<!-- politty:command:crashreport send:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk crashreport send [options]
+tailor crashreport send [options]
 ```
 
-<!-- politty:command:crashreport send:usage:end -->
-
-<!-- politty:command:crashreport send:options:start -->
-
 **Options**
 
 | Option          | Alias | Description                   | Required | Default |
 | --------------- | ----- | ----------------------------- | -------- | ------- |
 | `--file <FILE>` | -     | Path to the crash report file | Yes      | -       |
 
-<!-- politty:command:crashreport send:options:end -->
-
-<!-- politty:command:crashreport send:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
-
-<!-- politty:command:crashreport send:global-options-link:end -->

package/docs/cli/executor.md

@@ -2,30 +2,16 @@
 
 Commands for managing executors and executor jobs.
 
-<!-- politty:command:executor:heading:start -->
-
 ## executor
 
-<!-- politty:command:executor:heading:end -->
-
-<!-- politty:command:executor:description:start -->
-
 Manage executors
 
-<!-- politty:command:executor:description:end -->
-
-<!-- politty:command:executor:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk executor [command]
+tailor executor [command]
 ```
 
-<!-- politty:command:executor:usage:end -->
-
-<!-- politty:command:executor:subcommands:start -->
-
 **Commands**
 
 | Command                                 | Description                   |
@@ -36,38 +22,18 @@ tailor-sdk executor [command]
 | [`executor get`](#executor-get)         | Get executor details          |
 | [`executor webhook`](#executor-webhook) | Manage executor webhooks      |
 
-<!-- politty:command:executor:subcommands:end -->
-
-<!-- politty:command:executor:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:executor:global-options-link:end -->
-
-<!-- politty:command:executor list:heading:start -->
-
 ### executor list
 
-<!-- politty:command:executor list:heading:end -->
-
-<!-- politty:command:executor list:description:start -->
-
 List all executors
 
-<!-- politty:command:executor list:description:end -->
-
-<!-- politty:command:executor list:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk executor list [options]
+tailor executor list [options]
 ```
 
-<!-- politty:command:executor list:usage:end -->
-
-<!-- politty:command:executor list:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                              | Required | Default  | Env                            |
@@ -77,48 +43,24 @@ tailor-sdk executor list [options]
 | `--order <ORDER>`               | -     | Sort order (asc or desc)                                 | No       | `"desc"` | -                              |
 | `--limit <LIMIT>`               | `-l`  | Maximum number of items to return (0 or omit: unlimited) | No       | -        | -                              |
 
-<!-- politty:command:executor list:options:end -->
-
-<!-- politty:command:executor list:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:executor list:global-options-link:end -->
-
-<!-- politty:command:executor get:heading:start -->
-
 ### executor get
 
-<!-- politty:command:executor get:heading:end -->
-
-<!-- politty:command:executor get:description:start -->
-
 Get executor details
 
-<!-- politty:command:executor get:description:end -->
-
-<!-- politty:command:executor get:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk executor get [options] <name>
+tailor executor get [options] <name>
 ```
 
-<!-- politty:command:executor get:usage:end -->
-
-<!-- politty:command:executor get:arguments:start -->
-
 **Arguments**
 
 | Argument | Description   | Required |
 | -------- | ------------- | -------- |
 | `name`   | Executor name | Yes      |
 
-<!-- politty:command:executor get:arguments:end -->
-
-<!-- politty:command:executor get:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description       | Required | Default | Env                            |
@@ -126,38 +68,18 @@ tailor-sdk executor get [options] <name>
 | `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID      | No       | -       | `TAILOR_PLATFORM_WORKSPACE_ID` |
 | `--profile <PROFILE>`           | `-p`  | Workspace profile | No       | -       | `TAILOR_PLATFORM_PROFILE`      |
 
-<!-- politty:command:executor get:options:end -->
-
-<!-- politty:command:executor get:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:executor get:global-options-link:end -->
-
-<!-- politty:command:executor jobs:heading:start -->
-
 ### executor jobs
 
-<!-- politty:command:executor jobs:heading:end -->
-
-<!-- politty:command:executor jobs:description:start -->
-
 List or get executor jobs.
 
-<!-- politty:command:executor jobs:description:end -->
-
-<!-- politty:command:executor jobs:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk executor jobs [options] <executor-name> [job-id]
+tailor executor jobs [options] <executor-name> [job-id]
 ```
 
-<!-- politty:command:executor jobs:usage:end -->
-
-<!-- politty:command:executor jobs:arguments:start -->
-
 **Arguments**
 
 | Argument        | Description                             | Required |
@@ -165,10 +87,6 @@ tailor-sdk executor jobs [options] <executor-name> [job-id]
 | `executor-name` | Executor name                           | Yes      |
 | `job-id`        | Job ID (if provided, shows job details) | No       |
 
-<!-- politty:command:executor jobs:arguments:end -->
-
-<!-- politty:command:executor jobs:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                                                                           | Required | Default  | Env                            |
@@ -179,100 +97,73 @@ tailor-sdk executor jobs [options] <executor-name> [job-id]
 | `--attempts`                    | -     | Show job attempts (only with job ID) (detail mode only)                                               | No       | `false`  | -                              |
 | `--wait`                        | `-W`  | Wait for job completion and downstream execution (workflow/function) if applicable (detail mode only) | No       | `false`  | -                              |
 | `--interval <INTERVAL>`         | `-i`  | Polling interval when using --wait (e.g., '3s', '500ms', '1m')                                        | No       | `"3s"`   | -                              |
+| `--timeout <TIMEOUT>`           | `-t`  | Maximum time to wait when using --wait (e.g., '30s', '5m')                                            | No       | `"5m"`   | -                              |
 | `--order <ORDER>`               | -     | Sort order (asc or desc)                                                                              | No       | `"desc"` | -                              |
 | `--limit <LIMIT>`               | -     | Maximum number of jobs to list (0: unlimited, default: 50) (list mode only)                           | No       | `50`     | -                              |
 | `--logs`                        | `-l`  | Display function execution logs after completion (requires --wait)                                    | No       | `false`  | -                              |
 
-<!-- politty:command:executor jobs:options:end -->
-
-<!-- politty:command:executor jobs:examples:start -->
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
 **Examples**
 
 **List jobs for an executor (default: 50 jobs)**
 
 ```bash
-$ tailor-sdk executor jobs my-executor
+$ tailor executor jobs my-executor
 ```
 
 **Limit the number of jobs**
 
 ```bash
-$ tailor-sdk executor jobs my-executor --limit 10
+$ tailor executor jobs my-executor --limit 10
 ```
 
 **Filter by status**
 
 ```bash
-$ tailor-sdk executor jobs my-executor -s RUNNING
+$ tailor executor jobs my-executor -s RUNNING
 ```
 
 **Get job details**
 
 ```bash
-$ tailor-sdk executor jobs my-executor <job-id>
+$ tailor executor jobs my-executor <job-id>
 ```
 
 **Get job details with attempts**
 
 ```bash
-$ tailor-sdk executor jobs my-executor <job-id> --attempts
+$ tailor executor jobs my-executor <job-id> --attempts
 ```
 
 **Wait for job to complete**
 
 ```bash
-$ tailor-sdk executor jobs my-executor <job-id> -W
+$ tailor executor jobs my-executor <job-id> -W
 ```
 
 **Wait for job with logs**
 
 ```bash
-$ tailor-sdk executor jobs my-executor <job-id> -W -l
+$ tailor executor jobs my-executor <job-id> -W -l
 ```
 
-<!-- politty:command:executor jobs:examples:end -->
-
-<!-- politty:command:executor jobs:global-options-link:start -->
-
-See [Global Options](../cli-reference.md#global-options) for options available to all commands.
-
-<!-- politty:command:executor jobs:global-options-link:end -->
-
-<!-- politty:command:executor trigger:heading:start -->
-
 ### executor trigger
 
-<!-- politty:command:executor trigger:heading:end -->
-
-<!-- politty:command:executor trigger:description:start -->
-
 Trigger an executor manually.
 
-<!-- politty:command:executor trigger:description:end -->
-
-<!-- politty:command:executor trigger:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk executor trigger [options] <executor-name>
+tailor executor trigger [options] <executor-name>
 ```
 
-<!-- politty:command:executor trigger:usage:end -->
-
-<!-- politty:command:executor trigger:arguments:start -->
-
 **Arguments**
 
 | Argument        | Description   | Required |
 | --------------- | ------------- | -------- |
 | `executor-name` | Executor name | Yes      |
 
-<!-- politty:command:executor trigger:arguments:end -->
-
-<!-- politty:command:executor trigger:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                                                        | Required | Default | Env                            |
@@ -283,47 +174,91 @@ tailor-sdk executor trigger [options] <executor-name>
 | `--header <HEADER>`             | `-H`  | Request header (format: 'Key: Value', can be specified multiple times)             | No       | -       | -                              |
 | `--wait`                        | `-W`  | Wait for job completion and downstream execution (workflow/function) if applicable | No       | `false` | -                              |
 | `--interval <INTERVAL>`         | `-i`  | Polling interval when using --wait (e.g., '3s', '500ms', '1m')                     | No       | `"3s"`  | -                              |
+| `--timeout <TIMEOUT>`           | `-t`  | Maximum time to wait when using --wait (e.g., '30s', '5m')                         | No       | `"5m"`  | -                              |
 | `--logs`                        | `-l`  | Display function execution logs after completion (requires --wait)                 | No       | `false` | -                              |
 
-<!-- politty:command:executor trigger:options:end -->
-
-<!-- politty:command:executor trigger:examples:start -->
-
 **Examples**
 
 **Trigger an executor**
 
 ```bash
-$ tailor-sdk executor trigger my-executor
+$ tailor executor trigger my-executor
 ```
 
 **Trigger with data**
 
 ```bash
-$ tailor-sdk executor trigger my-executor -d '{"message": "hello"}'
+$ tailor executor trigger my-executor -d '{"message": "hello"}'
 ```
 
 **Trigger with data and headers**
 
 ```bash
-$ tailor-sdk executor trigger my-executor -d '{"message": "hello"}' -H "X-Custom: value" -H "X-Another: value2"
+$ tailor executor trigger my-executor -d '{"message": "hello"}' -H "X-Custom: value" -H "X-Another: value2"
 ```
 
 **Trigger and wait for completion**
 
 ```bash
-$ tailor-sdk executor trigger my-executor -W
+$ tailor executor trigger my-executor -W
 ```
 
 **Trigger, wait, and show logs**
 
 ```bash
-$ tailor-sdk executor trigger my-executor -W -l
+$ tailor executor trigger my-executor -W -l
 ```
 
-<!-- politty:command:executor trigger:examples:end -->
+**Shell automation**
+
+Trigger an executor and wait for the executor job plus any downstream workflow or
+function execution:
+
+```bash
+tailor executor trigger daily-workflow \
+  --wait \
+  --timeout 5m \
+  --interval 5s \
+  --json
+```
 
-<!-- politty:command:executor trigger:notes:start -->
+Wait for an existing job when another process already captured the job ID:
+
+```bash
+tailor executor jobs daily-workflow "$job_id" \
+  --wait \
+  --timeout 5m \
+  --logs \
+  --json
+```
+
+**Programmatic API**
+
+Import your executor definition and pass it to the typed API:
+
+```ts
+import { triggerExecutor, watchExecutorJob } from "@tailor-platform/sdk/cli";
+import dailyWorkflow from "../executors/dailyWorkflow";
+
+const { jobId } = await triggerExecutor({
+  executor: dailyWorkflow,
+});
+
+if (!jobId) {
+  throw new Error("Executor trigger did not return a job ID");
+}
+
+const result = await watchExecutorJob({
+  executor: dailyWorkflow,
+  jobId,
+  timeout: 5 * 60 * 1000,
+  interval: 5000,
+});
+
+if (result.timedOut) {
+  throw new Error(`Executor job ${result.job.id} timed out at ${result.job.status}`);
+}
+```
 
 **Notes**
 
@@ -342,37 +277,19 @@ When using `--wait`, the CLI tracks not only the executor job but also any downs
 
 The `--logs` option displays logs from the downstream execution when available.
 
-<!-- politty:command:executor trigger:notes:end -->
-
-<!-- politty:command:executor trigger:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:executor trigger:global-options-link:end -->
-
-<!-- politty:command:executor webhook:heading:start -->
-
 ### executor webhook
 
-<!-- politty:command:executor webhook:heading:end -->
-
-<!-- politty:command:executor webhook:description:start -->
-
 Manage executor webhooks
 
-<!-- politty:command:executor webhook:description:end -->
-
-<!-- politty:command:executor webhook:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk executor webhook [command]
+tailor executor webhook [command]
 ```
 
-<!-- politty:command:executor webhook:usage:end -->
-
-<!-- politty:command:executor webhook:subcommands:start -->
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
 **Commands**
 
@@ -380,38 +297,16 @@ tailor-sdk executor webhook [command]
 | ------------------------------------------------- | --------------------------------------------- |
 | [`executor webhook list`](#executor-webhook-list) | List executors with incoming webhook triggers |
 
-<!-- politty:command:executor webhook:subcommands:end -->
-
-<!-- politty:command:executor webhook:global-options-link:start -->
-
-See [Global Options](../cli-reference.md#global-options) for options available to all commands.
-
-<!-- politty:command:executor webhook:global-options-link:end -->
-
-<!-- politty:command:executor webhook list:heading:start -->
-
 #### executor webhook list
 
-<!-- politty:command:executor webhook list:heading:end -->
-
-<!-- politty:command:executor webhook list:description:start -->
-
 List executors with incoming webhook triggers
 
-<!-- politty:command:executor webhook list:description:end -->
-
-<!-- politty:command:executor webhook list:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk executor webhook list [options]
+tailor executor webhook list [options]
 ```
 
-<!-- politty:command:executor webhook list:usage:end -->
-
-<!-- politty:command:executor webhook list:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                              | Required | Default  | Env                            |
@@ -421,10 +316,4 @@ tailor-sdk executor webhook list [options]
 | `--order <ORDER>`               | -     | Sort order (asc or desc)                                 | No       | `"desc"` | -                              |
 | `--limit <LIMIT>`               | `-l`  | Maximum number of items to return (0 or omit: unlimited) | No       | -        | -                              |
 
-<!-- politty:command:executor webhook list:options:end -->
-
-<!-- politty:command:executor webhook list:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
-
-<!-- politty:command:executor webhook list:global-options-link:end -->