Skip to content

Commit efe55cf

Browse files
tailor-docs-bot[bot]tailor-docs-bot[bot]
committed
Update SDK pages
1 parent 7abaff1 commit efe55cf

11 files changed

Lines changed: 479 additions & 60 deletions

File tree

‎docs/sdk/cli-reference.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You can use environment variables to configure workspace and authentication:
7777
| `TAILOR_PLATFORM_SDK_DTS_PATH` | Output path for generated `tailor.d.ts` type definition file |
7878
| `TAILOR_PLATFORM_MACHINE_USER_CLIENT_ID` | Client ID for `login --machine-user` |
7979
| `TAILOR_PLATFORM_MACHINE_USER_CLIENT_SECRET` | Client secret for `login --machine-user` |
80-
| `TAILOR_PLATFORM_MACHINE_USER_NAME` | Default machine user name for `query`, `workflow start`, `function test-run` |
80+
| `TAILOR_PLATFORM_MACHINE_USER_NAME` | Default machine user name for `query`, `workflow start`, `function test-run`, `machineuser token` |
8181
| `TAILOR_BUNDLE_CONCURRENCY` | Max concurrent bundle workers for `deploy` (resolvers/executors/workflows). Defaults to CPU count |
8282
| `VISUAL` / `EDITOR` | Preferred editor for commands that open files (e.g., `vim`, `code`, `nano`) |
8383
| `TAILOR_CRASH_REPORTS_LOCAL` | Local crash log writing: `on` (default) or `off` |
@@ -130,6 +130,7 @@ Commands for managing TailorDB tables, data, and schema migrations.
130130
| [tailordb migration script](cli/tailordb.md#tailordb-migration-script) | Add a migration script (migrate.ts) template to an existing migration directory. |
131131
| [tailordb migration set](cli/tailordb.md#tailordb-migration-set) | Set migration checkpoint to a specific number. |
132132
| [tailordb migration status](cli/tailordb.md#tailordb-migration-status) | Show the current migration status for TailorDB namespaces, including applied and pending migrations. |
133+
| [tailordb migration sync](cli/tailordb.md#tailordb-migration-sync) | Sync remote TailorDB schema to a specific migration snapshot (recovery from --no-schema-check drift). |
133134
| [tailordb erd export](cli/tailordb.md#tailordb-erd-export) | Export TailorDB ERD static viewer from local TailorDB schema. |
134135
| [tailordb erd serve](cli/tailordb.md#tailordb-erd-serve) | Generate and serve TailorDB ERD locally with watch reload. (beta) |
135136
| [tailordb erd deploy](cli/tailordb.md#tailordb-erd-deploy) | Deploy ERD static website for TailorDB namespace(s). |
@@ -286,9 +287,9 @@ Commands for managing crash reports.
286287

287288
Commands for setting up project infrastructure.
288289

289-
| Command | Description |
290-
| ------------------------------------------- | ------------------------------------------------------- |
291-
| [setup github](cli/setup.md#setup-github) | Generate GitHub Actions workflow for deployment. (beta) |
290+
| Command | Description |
291+
| ------------------------------------------- | ------------------------------------------------- |
292+
| [setup github](cli/setup.md#setup-github) | Generate a GitHub Actions deploy workflow. (beta) |
292293

293294
### [Upgrade Commands](cli/upgrade)
294295

‎docs/sdk/cli/application.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -117,16 +117,17 @@ tailor-sdk deploy [options]
117117

118118
**Options**
119119

120-
| Option | Alias | Description | Required | Default | Env |
121-
| ------------------------------- | ----- | -------------------------------------------------- | -------- | -------------------- | --------------------------------- |
122-
| `--workspace-id <WORKSPACE_ID>` | `-w` | Workspace ID | No | - | `TAILOR_PLATFORM_WORKSPACE_ID` |
123-
| `--profile <PROFILE>` | `-p` | Workspace profile | No | - | `TAILOR_PLATFORM_PROFILE` |
124-
| `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` | `TAILOR_PLATFORM_SDK_CONFIG_PATH` |
125-
| `--yes` | `-y` | Skip confirmation prompts | No | `false` | - |
126-
| `--dry-run` | `-d` | Run the command without making any changes | No | - | - |
127-
| `--no-schema-check` | - | Skip schema diff check against migration snapshots | No | - | - |
128-
| `--no-cache` | - | Disable bundle caching for this run | No | - | - |
129-
| `--clean-cache` | - | Clean the bundle cache before building | No | - | - |
120+
| Option | Alias | Description | Required | Default | Env |
121+
| ------------------------------- | ----- | ----------------------------------------------------------------- | -------- | -------------------- | --------------------------------- |
122+
| `--workspace-id <WORKSPACE_ID>` | `-w` | Workspace ID | No | - | `TAILOR_PLATFORM_WORKSPACE_ID` |
123+
| `--profile <PROFILE>` | `-p` | Workspace profile | No | - | `TAILOR_PLATFORM_PROFILE` |
124+
| `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` | `TAILOR_PLATFORM_SDK_CONFIG_PATH` |
125+
| `--yes` | `-y` | Skip confirmation prompts | No | `false` | - |
126+
| `--dry-run` | `-d` | Run the command without making any changes | No | - | - |
127+
| `--no-schema-check` | - | Skip schema diff check against migration snapshots | No | - | - |
128+
| `--no-validate` | - | Skip client-side validation against platform resource constraints | No | - | - |
129+
| `--no-cache` | - | Disable bundle caching for this run | No | - | - |
130+
| `--clean-cache` | - | Clean the bundle cache before building | No | - | - |
130131

131132
<!-- politty:command:deploy:options:end -->
132133

‎docs/sdk/cli/auth.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ Get an access token for a machine user.
350350
**Usage**
351351

352352
```
353-
tailor-sdk machineuser token [options] <name>
353+
tailor-sdk machineuser token [options] [name]
354354
```
355355

356356
<!-- politty:command:machineuser token:usage:end -->
@@ -359,9 +359,9 @@ tailor-sdk machineuser token [options] <name>
359359

360360
**Arguments**
361361

362-
| Argument | Description | Required |
363-
| -------- | ----------------- | -------- |
364-
| `name` | Machine user name | Yes |
362+
| Argument | Description | Required |
363+
| -------- | --------------------------------------------------------------------------- | -------- |
364+
| `name` | Machine user name. Falls back to the active profile's default machine user. | No |
365365

366366
<!-- politty:command:machineuser token:arguments:end -->
367367

‎docs/sdk/cli/function.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -245,14 +245,14 @@ tailor-sdk function test-run [options] <file>
245245

246246
**Options**
247247

248-
| Option | Alias | Description | Required | Default | Env |
249-
| ------------------------------- | ----- | ------------------------------------------------------------------------ | -------- | -------------------- | ----------------------------------- |
250-
| `--workspace-id <WORKSPACE_ID>` | `-w` | Workspace ID | No | - | `TAILOR_PLATFORM_WORKSPACE_ID` |
251-
| `--profile <PROFILE>` | `-p` | Workspace profile | No | - | `TAILOR_PLATFORM_PROFILE` |
252-
| `--name <NAME>` | `-n` | Workflow job name to run (matches the `name` field of createWorkflowJob) | No | - | - |
253-
| `--arg <ARG>` | `-a` | JSON argument to pass to the function | No | - | - |
254-
| `--machine-user <MACHINE_USER>` | `-m` | Machine user name for authentication | No | - | `TAILOR_PLATFORM_MACHINE_USER_NAME` |
255-
| `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` | - |
248+
| Option | Alias | Description | Required | Default | Env |
249+
| ------------------------------- | ----- | ---------------------------------------------------------------------------------------------- | -------- | -------------------- | ----------------------------------- |
250+
| `--workspace-id <WORKSPACE_ID>` | `-w` | Workspace ID | No | - | `TAILOR_PLATFORM_WORKSPACE_ID` |
251+
| `--profile <PROFILE>` | `-p` | Workspace profile | No | - | `TAILOR_PLATFORM_PROFILE` |
252+
| `--name <NAME>` | `-n` | Workflow job name to run (matches the `name` field of createWorkflowJob) | No | - | - |
253+
| `--arg <ARG>` | `-a` | JSON argument to pass to the function | No | - | - |
254+
| `--machine-user <MACHINE_USER>` | `-m` | Machine user name for authentication. Falls back to the active profile's default machine user. | No | - | `TAILOR_PLATFORM_MACHINE_USER_NAME` |
255+
| `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` | - |
256256

257257
<!-- politty:command:function test-run:options:end -->
258258
<!-- politty:command:function test-run:examples:start -->

‎docs/sdk/cli/query.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ tailor-sdk query [options]
3333
| `--query <QUERY>` | `-q` | Query string to execute directly; omit to start REPL mode | No | - | - |
3434
| `--file <FILE>` | `-f` | Read query string from file; omit to start REPL mode | No | - | - |
3535
| `--edit` | - | Open a temporary file in your editor; omit to start REPL mode | No | `false` | - |
36-
| `--machine-user <MACHINE_USER>` | `-m` | Machine user name for query execution | Yes | - | `TAILOR_PLATFORM_MACHINE_USER_NAME` |
36+
| `--machine-user <MACHINE_USER>` | `-m` | Machine user name for query execution. Falls back to the active profile's default machine user. | No | - | `TAILOR_PLATFORM_MACHINE_USER_NAME` |
3737
| `--newline-on-enter` | - | REPL: when true, Enter inserts a newline and Shift+Enter submits. Use --no-newline-on-enter to swap. | No | - | - |
3838

3939
<!-- politty:command:query:options:end -->

‎docs/sdk/cli/setup.md‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ tailor-sdk setup [command]
2828

2929
**Commands**
3030

31-
| Command | Description |
32-
| ------------------------------- | ------------------------------------------------------- |
33-
| [`setup github`](#setup-github) | Generate GitHub Actions workflow for deployment. (beta) |
31+
| Command | Description |
32+
| ------------------------------- | ------------------------------------------------- |
33+
| [`setup github`](#setup-github) | Generate a GitHub Actions deploy workflow. (beta) |
3434

3535
<!-- politty:command:setup:subcommands:end -->
3636

@@ -47,7 +47,7 @@ See [Global Options](../cli-reference.md#global-options) for options available t
4747

4848
<!-- politty:command:setup github:description:start -->
4949

50-
Generate GitHub Actions workflow for deployment. (beta)
50+
Generate a GitHub Actions deploy workflow. (beta)
5151

5252
<!-- politty:command:setup github:description:end -->
5353

@@ -65,14 +65,16 @@ tailor-sdk setup github [options]
6565

6666
**Options**
6767

68-
| Option | Alias | Description | Required | Default |
69-
| --------------------------------------- | ----- | ----------------------------------- | -------- | ------- |
70-
| `--workspace-name <WORKSPACE_NAME>` | `-n` | Workspace name | Yes | - |
71-
| `--workspace-region <WORKSPACE_REGION>` | `-r` | Workspace region | Yes | - |
72-
| `--organization-id <ORGANIZATION_ID>` | `-o` | Organization ID | Yes | - |
73-
| `--folder-id <FOLDER_ID>` | `-f` | Folder ID | Yes | - |
74-
| `--dir <DIR>` | `-d` | App directory (for monorepo setups) | No | `"."` |
75-
| `--with-plan` | `-p` | Include plan job for PR previews | No | `false` |
68+
| Option | Alias | Description | Required | Default |
69+
| ----------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
70+
| `--workspace-name <WORKSPACE_NAME>` | `-n` | Workspace name (defaults to the config 'name') | No | - |
71+
| `--branch <BRANCH>` | - | Branch target: deploy trigger branch (defaults to the detected default branch). Tag target: tag-reachability guard branch (no guard when omitted) | No | - |
72+
| `--tag` | - | Generate a tag target (deploy on tag push) | No | `false` |
73+
| `--tag-pattern <TAG_PATTERN>` | - | Tag glob to match (requires --tag; defaults to v\*) | No | - |
74+
| `--environment <ENVIRONMENT>` | - | GitHub Environment for the plan/deploy jobs (defaults to the workspace name) | No | - |
75+
| `--no-plan` | - | Disable the plan job for a branch target (cannot be combined with --tag) | No | `false` |
76+
| `--dir <DIR>` | `-d` | App directory (for monorepo setups) | No | `"."` |
77+
| `--force` | - | Discard hand edits / take over unmanaged files and regenerate | No | `false` |
7678

7779
<!-- politty:command:setup github:options:end -->
7880

@@ -81,3 +83,7 @@ tailor-sdk setup github [options]
8183
See [Global Options](../cli-reference.md#global-options) for options available to all commands.
8284

8385
<!-- politty:command:setup github:global-options-link:end -->
86+
87+
## Further reading
88+
89+
- [GitHub Actions Integration](../github-actions) — usage guide: targets, generated files, secrets, approval gates, and rollback.

0 commit comments

Comments
 (0)