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

package/docs/cli/setup.md

@@ -2,89 +2,185 @@
 
 Commands for setting up project infrastructure.
 
-<!-- politty:command:setup:heading:start -->
-
 ## setup
 
-<!-- politty:command:setup:heading:end -->
+Generate CI deploy workflows for your project. (beta)
+
+**Usage**
+
+```
+tailor setup <command>
+```
+
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:setup:description:start -->
+**Commands**
 
-Generate a CI deploy workflow for your project. (beta)
+| Command                                 | Description                                                                                      |
+| --------------------------------------- | ------------------------------------------------------------------------------------------------ |
+| [`setup branch`](#setup-branch)         | Generate a branch-target deploy workflow (push to branch triggers deploy).                       |
+| [`setup tag`](#setup-tag)               | Generate a tag-target deploy workflow (tag push triggers deploy).                                |
+| [`setup preview`](#setup-preview)       | Generate a preview workflow (PR open/sync triggers deploy to a per-PR workspace).                |
+| [`setup action`](#setup-action)         | Generate a per-app composite action for use with setup coordinate (monorepo multi-app deploys).  |
+| [`setup coordinate`](#setup-coordinate) | Generate a coordinator workflow that orchestrates multiple --action-generated composite actions. |
+| [`setup check`](#setup-check)           | Audit generated workflows for drift against the current config/repo (read-only).                 |
+| [`setup delete`](#setup-delete)         | Delete managed workflow/action file(s) and their .github/tailor.lock entries.                    |
 
-<!-- politty:command:setup:description:end -->
+### setup action
 
-<!-- politty:command:setup:usage:start -->
+Generate a per-app composite action for use with setup coordinate (monorepo multi-app deploys).
 
 **Usage**
 
 ```
-tailor-sdk setup [options] [command]
+tailor setup action [options]
 ```
 
-<!-- politty:command:setup:usage:end -->
+**Options**
+
+| Option                        | Alias | Description                                         | Required | Default |
+| ----------------------------- | ----- | --------------------------------------------------- | -------- | ------- |
+| `--name <NAME>`               | `-n`  | Name (defaults to the config 'name')                | No       | -       |
+| `--dir <DIR>`                 | `-d`  | App directory                                       | No       | `"."`   |
+| `--environment <ENVIRONMENT>` | -     | GitHub Environment (defaults to the workspace name) | No       | -       |
+| `--force`                     | -     | Discard hand edits and regenerate                   | No       | `false` |
+
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
+
+### setup branch
 
-<!-- politty:command:setup:options:start -->
+Generate a branch-target deploy workflow (push to branch triggers deploy).
+
+**Usage**
+
+```
+tailor setup branch [options]
+```
 
 **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`    |
+| Option                        | Alias | Description                                                                    | Required | Default |
+| ----------------------------- | ----- | ------------------------------------------------------------------------------ | -------- | ------- |
+| `--name <NAME>`               | `-n`  | Name (defaults to the config 'name')                                           | No       | -       |
+| `--branch <BRANCH>`           | -     | Deploy trigger branch (defaults to the detected default branch)                | No       | -       |
+| `--environment <ENVIRONMENT>` | -     | GitHub Environment for the plan/deploy jobs (defaults to the workspace name)   | No       | -       |
+| `--erd-preview`               | -     | Add PR ERD viewer artifacts with current/diff previews for TailorDB namespaces | 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 -->
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:setup:subcommands:start -->
+### setup check
 
-**Commands**
+Audit generated workflows for drift against the current config/repo (read-only).
 
-| Command                       | Description                                                                      |
-| ----------------------------- | -------------------------------------------------------------------------------- |
-| [`setup check`](#setup-check) | Audit generated workflows for drift against the current config/repo (read-only). |
+**Usage**
 
-<!-- politty:command:setup:subcommands:end -->
+```
+tailor setup check [options]
+```
+
+**Options**
 
-<!-- politty:command:setup:global-options-link:start -->
+| Option | Alias | Description                                                                                      | Required | Default |
+| ------ | ----- | ------------------------------------------------------------------------------------------------ | -------- | ------- |
+| `--ci` | -     | Run in CI mode: skip checks that are handled by the runtime (e.g. TAILOR_PLATFORM_WORKSPACE_ID). | No       | `false` |
 
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:setup:global-options-link:end -->
+### setup coordinate
 
-<!-- politty:command:setup check:heading:start -->
+Generate a coordinator workflow that orchestrates multiple --action-generated composite actions.
 
-### setup check
+**Usage**
+
+```
+tailor setup coordinate [options]
+```
 
-<!-- politty:command:setup check:heading:end -->
+**Options**
 
-<!-- politty:command:setup check:description:start -->
+| Option                        | Alias | Description                                                                             | Required | Default |
+| ----------------------------- | ----- | --------------------------------------------------------------------------------------- | -------- | ------- |
+| `--name <NAME>`               | `-n`  | Coordinator name (used in the generated workflow file name and job names)               | Yes      | -       |
+| `--action <ACTION>`           | -     | Composite action to include (can be specified multiple times). tailor- prefix optional. | Yes      | -       |
+| `--branch <BRANCH>`           | -     | Branch target: deploy trigger branch (defaults to the detected default branch)          | No       | -       |
+| `--tag`                       | -     | Generate a tag target coordinator                                                       | No       | `false` |
+| `--environment <ENVIRONMENT>` | -     | GitHub Environment for the plan/deploy jobs                                             | No       | -       |
+| `--force`                     | -     | Discard hand edits and regenerate                                                       | No       | `false` |
 
-Audit generated workflows for drift against the current config/repo (read-only).
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:setup check:description:end -->
+### setup delete
 
-<!-- politty:command:setup check:usage:start -->
+Delete managed workflow/action file(s) and their .github/tailor.lock entries.
 
 **Usage**
 
 ```
-tailor-sdk setup check
+tailor setup delete [options] <files>
 ```
 
-<!-- politty:command:setup check:usage:end -->
+**Arguments**
+
+| Argument | Description                                                                                | Required |
+| -------- | ------------------------------------------------------------------------------------------ | -------- |
+| `files`  | Workflow/action file(s) to delete, as generated under .github/workflows or .github/actions | Yes      |
+
+**Options**
 
-<!-- politty:command:setup check:global-options-link:start -->
+| Option  | Alias | Description               | Required | Default |
+| ------- | ----- | ------------------------- | -------- | ------- |
+| `--yes` | `-y`  | Skip confirmation prompts | No       | `false` |
 
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:setup check:global-options-link:end -->
+### setup preview
+
+Generate a preview workflow (PR open/sync triggers deploy to a per-PR workspace).
+
+**Usage**
+
+```
+tailor setup preview [options]
+```
+
+**Options**
+
+| Option                        | Alias | Description                                                               | Required | Default |
+| ----------------------------- | ----- | ------------------------------------------------------------------------- | -------- | ------- |
+| `--name <NAME>`               | `-n`  | Name (defaults to the config 'name')                                      | No       | -       |
+| `--branch <BRANCH>`           | -     | Branch to filter PRs by (defaults to the detected default branch)         | No       | -       |
+| `--region <REGION>`           | -     | Workspace region for preview workspace creation (e.g. us-west). Required. | Yes      | -       |
+| `--require-preview-label`     | -     | Deploy preview only for PRs labeled `tailor:preview` instead of all PRs.  | No       | `false` |
+| `--environment <ENVIRONMENT>` | -     | GitHub Environment for the preview jobs (defaults to the workspace name)  | No       | -       |
+| `--dir <DIR>`                 | `-d`  | App directory (for monorepo setups)                                       | No       | `"."`   |
+| `--force`                     | -     | Discard hand edits / take over unmanaged files and regenerate             | No       | `false` |
+
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
+
+### setup tag
+
+Generate a tag-target deploy workflow (tag push triggers deploy).
+
+**Usage**
+
+```
+tailor setup tag [options]
+```
+
+**Options**
+
+| Option                        | Alias | Description                                                                  | Required | Default |
+| ----------------------------- | ----- | ---------------------------------------------------------------------------- | -------- | ------- |
+| `--name <NAME>`               | `-n`  | Name (defaults to the config 'name')                                         | No       | -       |
+| `--tag-pattern <TAG_PATTERN>` | -     | Tag glob to match (defaults to v\*)                                          | No       | `"v*"`  |
+| `--branch <BRANCH>`           | -     | Tag-reachability guard branch (no guard when omitted)                        | No       | -       |
+| `--environment <ENVIRONMENT>` | -     | GitHub Environment for the plan/deploy jobs (defaults to the workspace name) | No       | -       |
+| `--dir <DIR>`                 | `-d`  | App directory (for monorepo setups)                                          | No       | `"."`   |
+| `--force`                     | -     | Discard hand edits / take over unmanaged files and regenerate                | No       | `false` |
+
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
 ## Further reading
 

package/docs/cli/skills.md

@@ -1,75 +1,86 @@
-<!-- politty:command:skills:heading:start -->
-
 ## skills
 
-<!-- politty:command:skills:heading:end -->
+Manage Tailor SDK agent skills.
 
-<!-- politty:command:skills:description:start -->
+**Usage**
 
-Manage Tailor SDK agent skills.
+```
+tailor skills [command]
+```
+
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
+
+**Commands**
+
+| Command                           | Description                                   |
+| --------------------------------- | --------------------------------------------- |
+| [`skills sync`](#skills-sync)     | Remove and reinstall Tailor SDK agent skills. |
+| [`skills add`](#skills-add)       | Install Tailor SDK agent skills.              |
+| [`skills remove`](#skills-remove) | Remove installed Tailor SDK agent skills.     |
+| [`skills list`](#skills-list)     | List Tailor SDK agent skills.                 |
 
-<!-- politty:command:skills:description:end -->
+### skills add
 
-<!-- politty:command:skills:usage:start -->
+Install Tailor SDK agent skills.
 
 **Usage**
 
 ```
-tailor-sdk skills [command]
+tailor skills add [name]
 ```
 
-<!-- politty:command:skills:usage:end -->
+**Arguments**
 
-<!-- politty:command:skills:global-options-link:start -->
+| Argument | Description                             | Required |
+| -------- | --------------------------------------- | -------- |
+| `name`   | Skill name(s) to install (default: all) | No       |
 
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:skills:global-options-link:end -->
+### skills list
 
-<!-- politty:command:skills:subcommands:start -->
+List Tailor SDK agent skills.
 
-**Commands**
+**Usage**
+
+```
+tailor skills list
+```
+
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-| Command                             | Description                                                        |
-| ----------------------------------- | ------------------------------------------------------------------ |
-| [`skills install`](#skills-install) | Install the tailor-sdk agent skill from the installed SDK package. |
+### skills remove
 
-<!-- politty:command:skills:subcommands:end -->
-<!-- politty:command:skills install:heading:start -->
+Remove installed Tailor SDK agent skills.
 
-### skills install
+**Usage**
+
+```
+tailor skills remove [name]
+```
 
-<!-- politty:command:skills install:heading:end -->
+**Arguments**
 
-<!-- politty:command:skills install:description:start -->
+| Argument | Description                         | Required |
+| -------- | ----------------------------------- | -------- |
+| `name`   | Skill name to remove (default: all) | No       |
 
-Install the tailor-sdk agent skill from the installed SDK package.
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:skills install:description:end -->
+### skills sync
 
-<!-- politty:command:skills install:usage:start -->
+Remove and reinstall Tailor SDK agent skills.
 
 **Usage**
 
 ```
-tailor-sdk skills install [options]
+tailor skills sync [options]
 ```
 
-<!-- politty:command:skills install:usage:end -->
-
-<!-- politty:command:skills install:options:start -->
-
 **Options**
 
-| Option            | Alias | Description                                                                  | Required | Default         |
-| ----------------- | ----- | ---------------------------------------------------------------------------- | -------- | --------------- |
-| `--agent <AGENT>` | `-a`  | vercel/skills agent name (e.g. claude-code, codex). Defaults to claude-code. | No       | `"claude-code"` |
-| `--yes`           | `-y`  | Auto-approve prompts.                                                        | No       | `false`         |
-
-<!-- politty:command:skills install:options:end -->
-
-<!-- politty:command:skills install:global-options-link:start -->
+| Option                | Alias | Description                      | Required | Default |
+| --------------------- | ----- | -------------------------------- | -------- | ------- |
+| `--exclude <EXCLUDE>` | `-x`  | Skill names to exclude from sync | No       | `[]`    |
 
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
-
-<!-- politty:command:skills install:global-options-link:end -->