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

package/docs/cli/setup.md

@@ -10,7 +10,7 @@ Commands for setting up project infrastructure.
 
 <!-- politty:command:setup:description:start -->
 
-Set up project infrastructure.
+Generate a CI deploy workflow for your project. (beta)
 
 <!-- politty:command:setup:description:end -->
 
@@ -19,18 +19,36 @@ Set up project infrastructure.
 **Usage**
 
 ```
-tailor-sdk setup [command]
+tailor-sdk setup [options] [command]
 ```
 
 <!-- politty:command:setup:usage:end -->
 
+<!-- politty:command:setup:options:start -->
+
+**Options**
+
+| Option                              | Alias | Description                                                                                                                                       | Required | Default    |
+| ----------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------- |
+| `--provider <PROVIDER>`             | `-p`  | CI provider to generate for (only 'github' is supported)                                                                                          | No       | `"github"` |
+| `--workspace-name <WORKSPACE_NAME>` | `-n`  | Workspace name (defaults to the config 'name')                                                                                                    | No       | -          |
+| `--branch <BRANCH>`                 | -     | Branch target: deploy trigger branch (defaults to the detected default branch). Tag target: tag-reachability guard branch (no guard when omitted) | No       | -          |
+| `--tag`                             | -     | Generate a tag target (deploy on tag push)                                                                                                        | No       | `false`    |
+| `--tag-pattern <TAG_PATTERN>`       | -     | Tag glob to match (requires --tag; defaults to v\*)                                                                                               | No       | -          |
+| `--environment <ENVIRONMENT>`       | -     | GitHub Environment for the plan/deploy jobs (defaults to the workspace name)                                                                      | No       | -          |
+| `--no-plan`                         | -     | Disable the plan job for a branch target (cannot be combined with --tag)                                                                          | No       | `false`    |
+| `--dir <DIR>`                       | `-d`  | App directory (for monorepo setups)                                                                                                               | No       | `"."`      |
+| `--force`                           | -     | Discard hand edits / take over unmanaged files and regenerate                                                                                     | No       | `false`    |
+
+<!-- politty:command:setup:options:end -->
+
 <!-- politty:command:setup:subcommands:start -->
 
 **Commands**
 
-| Command                         | Description                                       |
-| ------------------------------- | ------------------------------------------------- |
-| [`setup github`](#setup-github) | Generate a GitHub Actions deploy workflow. (beta) |
+| Command                       | Description                                                                      |
+| ----------------------------- | -------------------------------------------------------------------------------- |
+| [`setup check`](#setup-check) | Audit generated workflows for drift against the current config/repo (read-only). |
 
 <!-- politty:command:setup:subcommands:end -->
 
@@ -39,50 +57,34 @@ tailor-sdk setup [command]
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
 <!-- politty:command:setup:global-options-link:end -->
-<!-- politty:command:setup github:heading:start -->
 
-### setup github
+<!-- politty:command:setup check:heading:start -->
+
+### setup check
 
-<!-- politty:command:setup github:heading:end -->
+<!-- politty:command:setup check:heading:end -->
 
-<!-- politty:command:setup github:description:start -->
+<!-- politty:command:setup check:description:start -->
 
-Generate a GitHub Actions deploy workflow. (beta)
+Audit generated workflows for drift against the current config/repo (read-only).
 
-<!-- politty:command:setup github:description:end -->
+<!-- politty:command:setup check:description:end -->
 
-<!-- politty:command:setup github:usage:start -->
+<!-- politty:command:setup check:usage:start -->
 
 **Usage**
 
 ```
-tailor-sdk setup github [options]
+tailor-sdk setup check
 ```
 
-<!-- politty:command:setup github:usage:end -->
-
-<!-- politty:command:setup github:options:start -->
-
-**Options**
-
-| Option                              | Alias | Description                                                                                                                                       | Required | Default |
-| ----------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
-| `--workspace-name <WORKSPACE_NAME>` | `-n`  | Workspace name (defaults to the config 'name')                                                                                                    | No       | -       |
-| `--branch <BRANCH>`                 | -     | Branch target: deploy trigger branch (defaults to the detected default branch). Tag target: tag-reachability guard branch (no guard when omitted) | No       | -       |
-| `--tag`                             | -     | Generate a tag target (deploy on tag push)                                                                                                        | No       | `false` |
-| `--tag-pattern <TAG_PATTERN>`       | -     | Tag glob to match (requires --tag; defaults to v\*)                                                                                               | No       | -       |
-| `--environment <ENVIRONMENT>`       | -     | GitHub Environment for the plan/deploy jobs (defaults to the workspace name)                                                                      | No       | -       |
-| `--no-plan`                         | -     | Disable the plan job for a branch target (cannot be combined with --tag)                                                                          | No       | `false` |
-| `--dir <DIR>`                       | `-d`  | App directory (for monorepo setups)                                                                                                               | No       | `"."`   |
-| `--force`                           | -     | Discard hand edits / take over unmanaged files and regenerate                                                                                     | No       | `false` |
-
-<!-- politty:command:setup github:options:end -->
+<!-- politty:command:setup check:usage:end -->
 
-<!-- politty:command:setup github:global-options-link:start -->
+<!-- politty:command:setup check:global-options-link:start -->
 
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:setup github:global-options-link:end -->
+<!-- politty:command:setup check:global-options-link:end -->
 
 ## Further reading
 

package/docs/cli/workflow.md

@@ -33,6 +33,7 @@ tailor-sdk workflow [command]
 | [`workflow list`](#workflow-list)             | List all workflows in the workspace.           |
 | [`workflow get`](#workflow-get)               | Get workflow details.                          |
 | [`workflow start`](#workflow-start)           | Start a workflow execution.                    |
+| [`workflow wait`](#workflow-wait)             | Wait for a workflow execution.                 |
 | [`workflow executions`](#workflow-executions) | List or get workflow executions.               |
 | [`workflow resume`](#workflow-resume)         | Resume a failed or pending workflow execution. |
 
@@ -175,8 +176,10 @@ tailor-sdk workflow start [options] <name>
 | `--machine-user <MACHINE_USER>` | `-m`  | Machine user name. Falls back to the active profile's default machine user. | No       | -                    | `TAILOR_PLATFORM_MACHINE_USER_NAME` |
 | `--arg <ARG>`                   | `-a`  | Workflow argument (JSON string)                                             | No       | -                    | -                                   |
 | `--wait`                        | `-W`  | Wait for execution to complete                                              | No       | `false`              | -                                   |
-| `--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`              | -                                   |
+| `--interval <INTERVAL>`         | `-i`  | Polling interval when waiting (e.g., '3s', '500ms', '1m')                   | No       | `"3s"`               | -                                   |
+| `--timeout <TIMEOUT>`           | `-t`  | Maximum time to wait (e.g., '30s', '10m')                                   | No       | `"10m"`              | -                                   |
+| `--until <UNTIL>`               | `-u`  | Wait target (success, suspended, terminal)                                  | No       | `"terminal"`         | -                                   |
+| `--logs`                        | `-l`  | Display job execution logs after completion                                 | No       | `false`              | -                                   |
 
 <!-- politty:command:workflow start:options:end -->
 
@@ -185,6 +188,136 @@ tailor-sdk workflow start [options] <name>
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
 <!-- politty:command:workflow start:global-options-link:end -->
+<!-- politty:command:workflow wait:heading:start -->
+
+### workflow wait
+
+<!-- politty:command:workflow wait:heading:end -->
+
+<!-- politty:command:workflow wait:description:start -->
+
+Wait for a workflow execution.
+
+<!-- politty:command:workflow wait:description:end -->
+
+<!-- politty:command:workflow wait:usage:start -->
+
+**Usage**
+
+```
+tailor-sdk workflow wait [options] <execution-id>
+```
+
+<!-- politty:command:workflow wait:usage:end -->
+
+<!-- politty:command:workflow wait:arguments:start -->
+
+**Arguments**
+
+| Argument       | Description  | Required |
+| -------------- | ------------ | -------- |
+| `execution-id` | Execution ID | Yes      |
+
+<!-- politty:command:workflow wait:arguments:end -->
+
+<!-- politty:command:workflow wait:options:start -->
+
+**Options**
+
+| Option                          | Alias | Description                                               | Required | Default      | Env                            |
+| ------------------------------- | ----- | --------------------------------------------------------- | -------- | ------------ | ------------------------------ |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID                                              | No       | -            | `TAILOR_PLATFORM_WORKSPACE_ID` |
+| `--profile <PROFILE>`           | `-p`  | Workspace profile                                         | No       | -            | `TAILOR_PLATFORM_PROFILE`      |
+| `--interval <INTERVAL>`         | `-i`  | Polling interval when waiting (e.g., '3s', '500ms', '1m') | No       | `"3s"`       | -                              |
+| `--timeout <TIMEOUT>`           | `-t`  | Maximum time to wait (e.g., '30s', '10m')                 | No       | `"10m"`      | -                              |
+| `--until <UNTIL>`               | `-u`  | Wait target (success, suspended, terminal)                | No       | `"terminal"` | -                              |
+| `--logs`                        | `-l`  | Display job execution logs after completion               | No       | `false`      | -                              |
+
+<!-- politty:command:workflow wait:options:end -->
+
+<!-- politty:command:workflow wait:global-options-link:start -->
+
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
+
+<!-- politty:command:workflow wait:global-options-link:end -->
+
+<!-- politty:command:workflow wait:examples:start -->
+
+**Examples**
+
+**Wait for workflow success**
+
+```bash
+$ tailor-sdk workflow wait execution-id --until success --timeout 10m --json
+```
+
+**Wait for a workflow wait point**
+
+```bash
+$ tailor-sdk workflow wait execution-id --until suspended --timeout 6m --logs --json
+```
+
+**Wait for success, failure, or suspension**
+
+```bash
+$ tailor-sdk workflow wait execution-id --until terminal
+```
+
+<!-- politty:command:workflow wait:examples:end -->
+
+**Shell automation**
+
+Capture the execution ID from `workflow start` and wait for the same run from a
+separate command:
+
+```bash
+execution_id="$(
+  tailor-sdk workflow start order-workflow --json | jq -r '.executionId'
+)"
+
+tailor-sdk workflow wait "$execution_id" \
+  --until success \
+  --timeout 10m \
+  --interval 5s \
+  --json
+```
+
+Wait until a workflow reaches a wait point, such as an approval step:
+
+```bash
+tailor-sdk workflow wait "$execution_id" \
+  --until suspended \
+  --timeout 6m \
+  --logs \
+  --json
+```
+
+**Programmatic API**
+
+Use `waitWorkflowExecution` when a script already has an execution ID and needs
+the same waiter behavior as the CLI:
+
+```ts
+import { waitWorkflowExecution } from "@tailor-platform/sdk/cli";
+
+const executionId = process.env.EXECUTION_ID;
+
+if (!executionId) {
+  throw new Error("EXECUTION_ID is required");
+}
+
+const result = await waitWorkflowExecution({
+  executionId,
+  until: "success",
+  timeout: 10 * 60 * 1000,
+  interval: 5000,
+});
+
+if (result.timedOut) {
+  throw new Error(`Workflow ${result.id} timed out at ${result.status}`);
+}
+```
+
 <!-- politty:command:workflow executions:heading:start -->
 
 ### workflow executions
@@ -221,17 +354,19 @@ tailor-sdk workflow executions [options] [execution-id]
 
 **Options**
 
-| Option                            | Alias | Description                                                    | Required | Default  | Env                            |
-| --------------------------------- | ----- | -------------------------------------------------------------- | -------- | -------- | ------------------------------ |
-| `--workspace-id <WORKSPACE_ID>`   | `-w`  | Workspace ID                                                   | No       | -        | `TAILOR_PLATFORM_WORKSPACE_ID` |
-| `--profile <PROFILE>`             | `-p`  | Workspace profile                                              | No       | -        | `TAILOR_PLATFORM_PROFILE`      |
-| `--order <ORDER>`                 | -     | Sort order (asc or desc)                                       | No       | `"desc"` | -                              |
-| `--limit <LIMIT>`                 | `-l`  | Maximum number of items to return (0: unlimited)               | No       | `50`     | -                              |
-| `--workflow-name <WORKFLOW_NAME>` | `-n`  | Filter by workflow name (list mode only)                       | No       | -        | -                              |
-| `--status <STATUS>`               | `-s`  | Filter by status (list mode only)                              | No       | -        | -                              |
-| `--wait`                          | `-W`  | Wait for execution to complete                                 | No       | `false`  | -                              |
-| `--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`  | -                              |
+| Option                            | Alias | Description                                               | Required | Default      | Env                            |
+| --------------------------------- | ----- | --------------------------------------------------------- | -------- | ------------ | ------------------------------ |
+| `--workspace-id <WORKSPACE_ID>`   | `-w`  | Workspace ID                                              | No       | -            | `TAILOR_PLATFORM_WORKSPACE_ID` |
+| `--profile <PROFILE>`             | `-p`  | Workspace profile                                         | No       | -            | `TAILOR_PLATFORM_PROFILE`      |
+| `--order <ORDER>`                 | -     | Sort order (asc or desc)                                  | No       | `"desc"`     | -                              |
+| `--limit <LIMIT>`                 | `-l`  | Maximum number of items to return (0: unlimited)          | No       | `50`         | -                              |
+| `--workflow-name <WORKFLOW_NAME>` | `-n`  | Filter by workflow name (list mode only)                  | No       | -            | -                              |
+| `--status <STATUS>`               | `-s`  | Filter by status (list mode only)                         | No       | -            | -                              |
+| `--wait`                          | `-W`  | Wait for execution to complete                            | No       | `false`      | -                              |
+| `--interval <INTERVAL>`           | `-i`  | Polling interval when waiting (e.g., '3s', '500ms', '1m') | No       | `"3s"`       | -                              |
+| `--timeout <TIMEOUT>`             | `-t`  | Maximum time to wait (e.g., '30s', '10m')                 | No       | `"10m"`      | -                              |
+| `--until <UNTIL>`                 | `-u`  | Wait target (success, suspended, terminal)                | No       | `"terminal"` | -                              |
+| `--logs`                          | -     | Display job execution logs (detail mode only)             | No       | `false`      | -                              |
 
 <!-- politty:command:workflow executions:options:end -->
 
@@ -276,13 +411,15 @@ tailor-sdk workflow resume [options] <execution-id>
 
 **Options**
 
-| Option                          | Alias | Description                                                    | Required | Default | Env                            |
-| ------------------------------- | ----- | -------------------------------------------------------------- | -------- | ------- | ------------------------------ |
-| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID                                                   | No       | -       | `TAILOR_PLATFORM_WORKSPACE_ID` |
-| `--profile <PROFILE>`           | `-p`  | Workspace profile                                              | No       | -       | `TAILOR_PLATFORM_PROFILE`      |
-| `--wait`                        | `-W`  | Wait for execution to complete                                 | No       | `false` | -                              |
-| `--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` | -                              |
+| Option                          | Alias | Description                                               | Required | Default      | Env                            |
+| ------------------------------- | ----- | --------------------------------------------------------- | -------- | ------------ | ------------------------------ |
+| `--workspace-id <WORKSPACE_ID>` | `-w`  | Workspace ID                                              | No       | -            | `TAILOR_PLATFORM_WORKSPACE_ID` |
+| `--profile <PROFILE>`           | `-p`  | Workspace profile                                         | No       | -            | `TAILOR_PLATFORM_PROFILE`      |
+| `--wait`                        | `-W`  | Wait for execution to complete                            | No       | `false`      | -                              |
+| `--interval <INTERVAL>`         | `-i`  | Polling interval when waiting (e.g., '3s', '500ms', '1m') | No       | `"3s"`       | -                              |
+| `--timeout <TIMEOUT>`           | `-t`  | Maximum time to wait (e.g., '30s', '10m')                 | No       | `"10m"`      | -                              |
+| `--until <UNTIL>`               | `-u`  | Wait target (success, suspended, terminal)                | No       | `"terminal"` | -                              |
+| `--logs`                        | `-l`  | Display job execution logs after completion               | No       | `false`      | -                              |
 
 <!-- politty:command:workflow resume:options:end -->
 

package/docs/cli-reference.md

@@ -65,23 +65,24 @@ tailor-sdk deploy --env-file .env --env-file .env.production
 
 You can use environment variables to configure workspace and authentication:
 
-| Variable                                     | Description                                                                                       |
-| -------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `TAILOR_PLATFORM_WORKSPACE_ID`               | Workspace ID for deployment commands                                                              |
-| `TAILOR_PLATFORM_ORGANIZATION_ID`            | Organization ID for organization commands                                                         |
-| `TAILOR_PLATFORM_FOLDER_ID`                  | Folder ID for folder commands                                                                     |
-| `TAILOR_PLATFORM_TOKEN`                      | Authentication token (alternative to `login`)                                                     |
-| `TAILOR_TOKEN`                               | **Deprecated.** Use `TAILOR_PLATFORM_TOKEN` instead                                               |
-| `TAILOR_PLATFORM_PROFILE`                    | Workspace profile name                                                                            |
-| `TAILOR_PLATFORM_SDK_CONFIG_PATH`            | Path to SDK config file                                                                           |
-| `TAILOR_PLATFORM_SDK_DTS_PATH`               | Output path for generated `tailor.d.ts` type definition file                                      |
-| `TAILOR_PLATFORM_MACHINE_USER_CLIENT_ID`     | Client ID for `login --machine-user`                                                              |
-| `TAILOR_PLATFORM_MACHINE_USER_CLIENT_SECRET` | Client secret for `login --machine-user`                                                          |
-| `TAILOR_PLATFORM_MACHINE_USER_NAME`          | Default machine user name for `query`, `workflow start`, `function test-run`, `machineuser token` |
-| `TAILOR_BUNDLE_CONCURRENCY`                  | Max concurrent bundle workers for `deploy` (resolvers/executors/workflows). Defaults to CPU count |
-| `VISUAL` / `EDITOR`                          | Preferred editor for commands that open files (e.g., `vim`, `code`, `nano`)                       |
-| `TAILOR_CRASH_REPORTS_LOCAL`                 | Local crash log writing: `on` (default) or `off`                                                  |
-| `TAILOR_CRASH_REPORTS_REMOTE`                | Automatic crash report submission: `off` (default) or `on`                                        |
+| Variable                                     | Description                                                                                                  |
+| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| `TAILOR_PLATFORM_WORKSPACE_ID`               | Workspace ID for deployment commands                                                                         |
+| `TAILOR_PLATFORM_ORGANIZATION_ID`            | Organization ID for organization commands                                                                    |
+| `TAILOR_PLATFORM_FOLDER_ID`                  | Folder ID for folder commands                                                                                |
+| `TAILOR_PLATFORM_TOKEN`                      | Authentication token (alternative to `login`)                                                                |
+| `TAILOR_TOKEN`                               | **Deprecated.** Use `TAILOR_PLATFORM_TOKEN` instead                                                          |
+| `TAILOR_PLATFORM_PROFILE`                    | Workspace profile name                                                                                       |
+| `TAILOR_PLATFORM_SDK_CONFIG_PATH`            | Path to SDK config file                                                                                      |
+| `TAILOR_PLATFORM_SDK_DTS_PATH`               | Output path for generated `tailor.d.ts` type definition file                                                 |
+| `TAILOR_PLATFORM_MACHINE_USER_CLIENT_ID`     | Client ID for `login --machine-user`                                                                         |
+| `TAILOR_PLATFORM_MACHINE_USER_CLIENT_SECRET` | Client secret for `login --machine-user`                                                                     |
+| `TAILOR_PLATFORM_MACHINE_USER_NAME`          | Default machine user name for `query`, `workflow start`, `function test-run`, `machineuser token`            |
+| `TAILOR_BUNDLE_CONCURRENCY`                  | Max concurrent bundle workers for `deploy` (resolvers/executors/workflows). Defaults to CPU count            |
+| `TAILOR_APPLY_CONCURRENCY`                   | Max concurrent unary platform RPCs during `apply`/`deploy` (streaming uploads are not gated). Defaults to 16 |
+| `VISUAL` / `EDITOR`                          | Preferred editor for commands that open files (e.g., `vim`, `code`, `nano`)                                  |
+| `TAILOR_CRASH_REPORTS_LOCAL`                 | Local crash log writing: `on` (default) or `off`                                                             |
+| `TAILOR_CRASH_REPORTS_REMOTE`                | Automatic crash report submission: `off` (default) or `on`                                                   |
 
 ### Authentication Token Priority
 
@@ -92,6 +93,10 @@ Token resolution follows this priority order:
 3. Profile specified via `--profile` option or `TAILOR_PLATFORM_PROFILE`
 4. Current user from platform config (`~/.config/tailor-platform/config.yaml`)
 
+`tailor-sdk login` stores local CLI login tokens in the OS keyring by default
+when available. If the keyring is unavailable, tokens are stored in the platform
+config file.
+
 ### Workspace ID Priority
 
 Workspace ID resolution follows this priority order:
@@ -222,6 +227,7 @@ Commands for managing workflows and executions.
 | [workflow list](./cli/workflow.md#workflow-list)             | List all workflows in the workspace.           |
 | [workflow get](./cli/workflow.md#workflow-get)               | Get workflow details.                          |
 | [workflow start](./cli/workflow.md#workflow-start)           | Start a workflow execution.                    |
+| [workflow wait](./cli/workflow.md#workflow-wait)             | Wait for a workflow execution.                 |
 | [workflow executions](./cli/workflow.md#workflow-executions) | List or get workflow executions.               |
 | [workflow resume](./cli/workflow.md#workflow-resume)         | Resume a failed or pending workflow execution. |
 
@@ -287,9 +293,9 @@ Commands for managing crash reports.
 
 Commands for setting up project infrastructure.
 
-| Command                                     | Description                                       |
-| ------------------------------------------- | ------------------------------------------------- |
-| [setup github](./cli/setup.md#setup-github) | Generate a GitHub Actions deploy workflow. (beta) |
+| Command                                   | Description                                                                      |
+| ----------------------------------------- | -------------------------------------------------------------------------------- |
+| [setup check](./cli/setup.md#setup-check) | Audit generated workflows for drift against the current config/repo (read-only). |
 
 ### [Upgrade Commands](./cli/upgrade.md)
 

package/docs/github-actions.md

@@ -1,6 +1,6 @@
 # GitHub Actions Integration
 
-`tailor-sdk setup github` generates a GitHub Actions workflow that deploys your
+`tailor-sdk setup` generates a GitHub Actions workflow that deploys your
 Tailor Platform application automatically on push or tag.
 
 > **Beta:** This command is under active development. CLI flags, the generated
@@ -14,13 +14,16 @@ lives):
 
 ```bash
 # Branch target: deploy to stg on every push to main
-tailor-sdk setup github -n my-app-stg
+tailor-sdk setup -n my-app-stg
 
 # Tag target: deploy to production when a tag is pushed, with an approval gate
-tailor-sdk setup github -n my-app-prod \
+tailor-sdk setup -n my-app-prod \
   --tag --branch main --environment production
 ```
 
+`setup` defaults to the GitHub provider; `--provider github` (`-p github`) is
+accepted but optional, and other providers are not yet supported.
+
 After running the command, follow the **Next steps** printed to the terminal to
 set the required secrets, set the `TAILOR_PLATFORM_WORKSPACE_ID` variable, and
 commit the generated files.
@@ -33,7 +36,7 @@ before the first deploy (see [Targeting a workspace](#targeting-a-workspace)).
 ## Targets
 
 A _target_ is one workflow file that handles one deployment destination.
-Run `setup github` once per target.
+Run `setup` once per target.
 
 ### Branch target (recommended for staging)
 
@@ -41,9 +44,9 @@ The branch target fires on pull requests and pushes to the branch you specify
 (defaulting to the repository's default branch when `--branch` is omitted):
 
 ```bash
-tailor-sdk setup github -n my-app-stg
+tailor-sdk setup -n my-app-stg
 # Equivalent to:
-tailor-sdk setup github -n my-app-stg --branch main
+tailor-sdk setup -n my-app-stg --branch main
 ```
 
 What it does:
@@ -66,7 +69,7 @@ The tag target fires when a tag matching `--tag-pattern` (default `v*`) is
 pushed:
 
 ```bash
-tailor-sdk setup github -n my-app-prod \
+tailor-sdk setup -n my-app-prod \
   --tag --tag-pattern "v*" --branch main --environment production
 ```
 
@@ -136,7 +139,7 @@ environment is planned.)
 
 ## Generated files
 
-Running `setup github` creates or updates:
+Running `setup` creates or updates:
 
 ### `.github/workflows/tailor-<workspace-name>.yml`
 
@@ -148,10 +151,10 @@ edit or rename them — the SDK tracks them by id.
 
 You can add your own jobs and steps around the managed ones. To add
 project-specific setup (such as private registry authentication or a system
-dependency), add a step _before_ the managed setup steps. For post-install
-extras (such as `playwright install`), add a step _after_ them.
+dependency), add a step _before_ the managed `tailor-setup` step. For
+post-install extras (such as `playwright install`), add a step _after_ it.
 
-Note that re-running `setup github` currently regenerates the whole file: if
+Note that re-running `setup` currently regenerates the whole file: if
 the file differs from what the SDK last wrote — whether you edited a managed
 step or added your own — the command stops and reports the conflict. Pass
 `--force` to discard your edits and regenerate from the current template, then
@@ -167,7 +170,7 @@ detect hand edits.
 
 ### `tailor.config.ts` (id injection)
 
-If your config does not already have an `id` field, `setup github` injects one.
+If your config does not already have an `id` field, `setup` injects one.
 This `id` must be committed alongside the workflow file. In CI, `tailor-sdk
 deploy` refuses to inject a new id — if the id were assigned fresh on each CI
 run, every deploy would create a brand-new application and lose ownership of
@@ -238,7 +241,7 @@ you can deploy any commit regardless of branch membership.
 For a monorepo where your SDK app lives in a subdirectory, pass `--dir`:
 
 ```bash
-tailor-sdk setup github -n my-app --dir apps/backend
+tailor-sdk setup -n my-app --dir apps/backend
 ```
 
 The generated workflow adds a `paths` filter on `apps/backend/**` so the
@@ -303,10 +306,10 @@ A typical setup with staging and production:
 
 ```bash
 # Staging: main → stg (deploy on every push to main)
-tailor-sdk setup github -n my-app-stg
+tailor-sdk setup -n my-app-stg
 
 # Production: tagged commits → prod, with approval gate and branch guard
-tailor-sdk setup github -n my-app-prod \
+tailor-sdk setup -n my-app-prod \
   --tag --branch main --environment production
 ```
 
@@ -326,9 +329,19 @@ gh secret set TAILOR_PLATFORM_MACHINE_USER_CLIENT_SECRET --env production
 
 Commit both workflow files and `.github/tailor-sdk.lock`.
 
+## Checking for drift
+
+`tailor-sdk setup check` audits the workflows recorded in
+`.github/tailor-sdk.lock` against your current config and repository, without
+writing anything. It reports when a workflow file is missing or hand-edited, a
+newer template is available, `tailor.config.ts` is no longer under the recorded
+`--dir`, or the repository default branch no longer matches a branch target's
+trigger. It exits non-zero when it finds drift, so you can run it in CI. Each
+finding names a stable rule key for future suppression.
+
 ## Updating the generated workflow
 
-When you upgrade the SDK, re-run `setup github` with the same flags to pick up
+When you upgrade the SDK, re-run `setup` with the same flags to pick up
 template improvements. If the SDK detects that you have hand-edited a managed
 section, it stops and asks you to use `--force` to overwrite your edits, or to
 move your customizations into your own steps before regenerating.