@tailor-platform/sdk 1.62.0 → 1.65.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +69 -0
  2. package/dist/{actor-J2gJ0eK5.d.mts → actor-D_2aJjYO.d.mts} +2 -2
  3. package/dist/{application-BezXGbrU.mjs → application-76hhIhnJ.mjs} +42 -5
  4. package/dist/application-76hhIhnJ.mjs.map +1 -0
  5. package/dist/application-av2raLs6.mjs +4 -0
  6. package/dist/cli/index.mjs +505 -121
  7. package/dist/cli/index.mjs.map +1 -1
  8. package/dist/cli/lib.d.mts +24 -31
  9. package/dist/cli/lib.mjs +2 -2
  10. package/dist/configure/index.d.mts +5 -5
  11. package/dist/configure/index.mjs.map +1 -1
  12. package/dist/{index-CfRFkXIO.d.mts → index-Bhjep8cS.d.mts} +2 -2
  13. package/dist/{index-DUupuPhZ.d.mts → index-CZ2r3qiO.d.mts} +2 -2
  14. package/dist/{index-CPRnOjjt.d.mts → index-Db2RvnEH.d.mts} +2 -2
  15. package/dist/{index-CLxubakC.d.mts → index-DcXIjt9F.d.mts} +5 -5
  16. package/dist/{index-CQZVJ5SX.d.mts → index-QpC0TNbH.d.mts} +2 -2
  17. package/dist/plugin/builtin/enum-constants/index.d.mts +1 -1
  18. package/dist/plugin/builtin/file-utils/index.d.mts +1 -1
  19. package/dist/plugin/builtin/kysely-type/index.d.mts +1 -1
  20. package/dist/plugin/builtin/seed/index.d.mts +1 -1
  21. package/dist/plugin/index.d.mts +2 -2
  22. package/dist/{plugin-C_FyVSdl.d.mts → plugin-DylAsA4Z.d.mts} +2 -2
  23. package/dist/{runtime-C6o4hiYq.mjs → runtime-C7qTBDD2.mjs} +565 -99
  24. package/dist/runtime-C7qTBDD2.mjs.map +1 -0
  25. package/dist/{tailordb-BlBGmQK-.d.mts → tailordb-C-ar4XCX.d.mts} +4 -4
  26. package/dist/utils/test/index.d.mts +3 -3
  27. package/dist/{workflow.generated-Bf1tWylx.d.mts → workflow.generated-CCDsY0ce.d.mts} +42 -6
  28. package/docs/cli/auth.md +4 -4
  29. package/docs/cli/function.md +8 -8
  30. package/docs/cli/query.md +1 -1
  31. package/docs/cli/setup.md +18 -12
  32. package/docs/cli/workflow.md +10 -10
  33. package/docs/cli/workspace.md +14 -10
  34. package/docs/cli-reference.md +4 -4
  35. package/docs/github-actions.md +337 -0
  36. package/docs/services/auth.md +19 -0
  37. package/docs/services/idp.md +96 -0
  38. package/docs/services/tailordb-migration.md +17 -6
  39. package/package.json +12 -12
  40. package/dist/application-BezXGbrU.mjs.map +0 -1
  41. package/dist/application-DSXntqnV.mjs +0 -4
  42. package/dist/runtime-C6o4hiYq.mjs.map +0 -1
@@ -11,8 +11,8 @@ type InferFieldsOutput<F extends Record<string, {
11
11
  _output: any;
12
12
  [key: string]: any;
13
13
  }>> = DeepWritable<Prettify<NullableToOptional<{ [K in keyof F]: output<F[K]> }>>>;
14
- type JsonValue = string | number | boolean | null | JsonValue[] | {
15
- [key: string]: JsonValue;
14
+ type JsonValue$1 = string | number | boolean | null | JsonValue$1[] | {
15
+ [key: string]: JsonValue$1;
16
16
  };
17
17
  /**
18
18
  * A looser version of JsonValue that accepts interfaces.
@@ -859,5 +859,5 @@ interface TailorDBType {
859
859
  files?: TailorDBTypeMetadata["files"];
860
860
  }
861
861
  //#endregion
862
- export { InferredAttributeList as A, FieldOutput as C, Validators as D, FieldValidateInput as E, InferFieldsOutput as F, JsonCompatible as I, JsonValue as L, TailorInvoker as M, TailorUser as N, AttributeList as O, unauthenticatedTailorUser as P, Prettify as R, FieldOptions as S, TailorToTs as T, PluginAttachment as _, TypeSourceInfoEntry as a, EnumValue as b, TailorAnyDBType as c, TailorDBType$1 as d, DBFieldMetadata as f, TailorField as g, SerialConfig as h, TailorDBType as i, InferredAttributeMap as j, AttributeMap as k, TailorDBField as l, GqlOperationsConfig as m, RelationType as n, ValueOperand as o, DefinedDBFieldMetadata as p, TailorDBServiceInput as r, TailorAnyDBField as s, IndexDef as t, TailorDBInstance as u, ArrayFieldOutput as v, TailorFieldType as w, FieldMetadata as x, DefinedFieldMetadata as y, output as z };
863
- //# sourceMappingURL=tailordb-BlBGmQK-.d.mts.map
862
+ export { InferredAttributeList as A, FieldOutput as C, Validators as D, FieldValidateInput as E, InferFieldsOutput as F, JsonCompatible as I, JsonValue$1 as L, TailorInvoker as M, TailorUser as N, AttributeList as O, unauthenticatedTailorUser as P, Prettify as R, FieldOptions as S, TailorToTs as T, PluginAttachment as _, TypeSourceInfoEntry as a, EnumValue as b, TailorAnyDBType as c, TailorDBType$1 as d, DBFieldMetadata as f, TailorField as g, SerialConfig as h, TailorDBType as i, InferredAttributeMap as j, AttributeMap as k, TailorDBField as l, GqlOperationsConfig as m, RelationType as n, ValueOperand as o, DefinedDBFieldMetadata as p, TailorDBServiceInput as r, TailorAnyDBField as s, IndexDef as t, TailorDBInstance as u, ArrayFieldOutput as v, TailorFieldType as w, FieldMetadata as x, DefinedFieldMetadata as y, output as z };
863
+ //# sourceMappingURL=tailordb-C-ar4XCX.d.mts.map
@@ -1,6 +1,6 @@
1
- import { M as TailorInvoker } from "../../tailordb-BlBGmQK-.mjs";
2
- import { W as TailorDBType } from "../../workflow.generated-Bf1tWylx.mjs";
3
- import { At as TailorField, Ct as WORKFLOW_TEST_ENV_KEY, n as output } from "../../index-CLxubakC.mjs";
1
+ import { M as TailorInvoker } from "../../tailordb-C-ar4XCX.mjs";
2
+ import { J as TailorDBType } from "../../workflow.generated-CCDsY0ce.mjs";
3
+ import { At as TailorField, Ct as WORKFLOW_TEST_ENV_KEY, n as output } from "../../index-DcXIjt9F.mjs";
4
4
  import { StandardSchemaV1 } from "@standard-schema/spec";
5
5
 
6
6
  //#region src/utils/test/mock.d.ts
@@ -1,7 +1,7 @@
1
- import { C as FieldOutput$1, D as Validators, E as FieldValidateInput, F as InferFieldsOutput, N as TailorUser, R as Prettify, S as FieldOptions, T as TailorToTs, b as EnumValue, d as TailorDBType$1, f as DBFieldMetadata, g as TailorField, h as SerialConfig, j as InferredAttributeMap, l as TailorDBField$1, m as GqlOperationsConfig, n as RelationType, o as ValueOperand, p as DefinedDBFieldMetadata, r as TailorDBServiceInput, s as TailorAnyDBField$1, t as IndexDef, u as TailorDBInstance$1, v as ArrayFieldOutput, w as TailorFieldType, x as FieldMetadata, y as DefinedFieldMetadata, z as output } from "./tailordb-BlBGmQK-.mjs";
2
- import { B as IdProvider, G as SCIMAttribute, H as OAuth2ClientInput, J as SCIMConfig, L as AuthInvoker, R as BuiltinIdP, V as OAuth2Client, X as TenantProvider, r as PluginConfigs } from "./plugin-C_FyVSdl.mjs";
1
+ import { C as FieldOutput$1, D as Validators, E as FieldValidateInput, F as InferFieldsOutput, N as TailorUser, R as Prettify, S as FieldOptions, T as TailorToTs, b as EnumValue, d as TailorDBType$1, f as DBFieldMetadata, g as TailorField, h as SerialConfig, j as InferredAttributeMap, l as TailorDBField$1, m as GqlOperationsConfig, n as RelationType, o as ValueOperand, p as DefinedDBFieldMetadata, r as TailorDBServiceInput, s as TailorAnyDBField$1, t as IndexDef, u as TailorDBInstance$1, v as ArrayFieldOutput, w as TailorFieldType, x as FieldMetadata, y as DefinedFieldMetadata, z as output } from "./tailordb-C-ar4XCX.mjs";
2
+ import { B as IdProvider, G as SCIMAttribute, H as OAuth2ClientInput, J as SCIMConfig, L as AuthInvoker, R as BuiltinIdP, V as OAuth2Client, X as TenantProvider, r as PluginConfigs } from "./plugin-DylAsA4Z.mjs";
3
3
  import { n as TailorEnv } from "./env-B-g-qgE4.mjs";
4
- import { IsAny, JsonObject, NonEmptyObject } from "type-fest";
4
+ import { IsAny, JsonObject, JsonValue, NonEmptyObject } from "type-fest";
5
5
  import { StandardSchemaV1 } from "@standard-schema/spec";
6
6
 
7
7
  //#region src/configure/types/field.d.ts
@@ -700,8 +700,44 @@ type MachineUser<User extends TailorDBInstance$1, AttributeMap extends UserAttri
700
700
  } : {
701
701
  attributeList: AttributeListToTuple<User, AttributeList>;
702
702
  });
703
+ /** Upstream OAuth provider that federated a login through the Built-in IdP. */
704
+ type FederatedIdentityProvider = "google" | "microsoft";
705
+ /**
706
+ * Profile claims forwarded from the upstream OAuth provider's ID token.
707
+ *
708
+ * Commonly present claims are typed; any other claim the provider issues is
709
+ * forwarded as-is and reachable through the index signature. Availability
710
+ * varies by provider (e.g. Microsoft does not issue `picture`).
711
+ */
712
+ type FederatedIdentityClaims = {
713
+ name?: string;
714
+ given_name?: string;
715
+ family_name?: string;
716
+ picture?: string;
717
+ locale?: string;
718
+ [claim: string]: JsonValue | undefined;
719
+ };
720
+ /**
721
+ * The upstream identity that federated this login, populated when a user signs
722
+ * in through a Built-in IdP OAuth provider (Google or Microsoft).
723
+ *
724
+ * Available on {@link BeforeLoginClaims.federated_identity}; `undefined` for
725
+ * password logins.
726
+ */
727
+ type FederatedIdentity = {
728
+ provider: FederatedIdentityProvider;
729
+ claims: FederatedIdentityClaims;
730
+ };
731
+ /**
732
+ * Token claims passed to the {@link BeforeLoginHook} handler. Carries the IdP's
733
+ * own claims (e.g. `sub`, `email`) plus, for federated logins, the upstream
734
+ * provider's profile under {@link BeforeLoginClaims.federated_identity}.
735
+ */
736
+ type BeforeLoginClaims = JsonObject & {
737
+ /** Present only for federated (Google/Microsoft) logins; `undefined` for password logins. */federated_identity?: FederatedIdentity;
738
+ };
703
739
  type BeforeLoginHookArgs = {
704
- claims: JsonObject;
740
+ claims: BeforeLoginClaims;
705
741
  idpConfigName: string; /** Environment variables defined in `defineConfig({ env })`. */
706
742
  env: TailorEnv;
707
743
  };
@@ -1412,5 +1448,5 @@ type ConcurrencyPolicy = {
1412
1448
  /** Maximum number of concurrent executions (1-1000) */maxConcurrentExecutions: number;
1413
1449
  };
1414
1450
  //#endregion
1415
- export { BeforeLoginHookArgs as A, TailorAnyDBField as B, IdPGqlOperationsInput as C, AuthExternalConfig as D, AuthConnectionTokenResult as E, UserAttributeListKey as F, db as G, TailorDBField as H, UserAttributeMap as I, TailorTypePermission as J, PermissionCondition as K, UsernameFieldKey as L, OAuth2ClientGrantType as M, SCIMAttributeType as N, AuthOwnConfig as O, UserAttributeKey as P, AllowedValuesOutput as Q, AuthConnectionConfig as R, IdPGqlOperations as S, AuthConfig as T, TailorDBInstance as U, TailorAnyDBType as V, TailorDBType as W, unsafeAllowAllTypePermission as X, unsafeAllowAllGqlPermission as Y, AllowedValues as Z, IdPConfig as _, ExecutorServiceConfig as a, IdpDefinitionBrand as b, ResolverServiceConfig as c, WorkflowServiceInput as d, StaticWebsiteConfig as f, SecretsDefinitionBrand as g, SecretsConfig as h, AppConfig as i, DefinedAuth as j, AuthServiceInput as k, ResolverServiceInput as l, StaticWebsiteInput as m, RetryPolicy as n, ExecutorServiceInput as o, StaticWebsiteDefinitionBrand as p, TailorTypeGqlPermission as q, HttpAdapterConfigInput as r, ResolverExternalConfig as s, ConcurrencyPolicy as t, WorkflowServiceConfig as u, IdPExternalConfig as v, IdPInput as w, IdPEmailConfig as x, IdPUserField as y, AuthConnectionOAuth2Config as z };
1416
- //# sourceMappingURL=workflow.generated-Bf1tWylx.d.mts.map
1451
+ export { unsafeAllowAllGqlPermission as $, BeforeLoginClaims as A, UserAttributeMap as B, IdPGqlOperationsInput as C, AuthExternalConfig as D, AuthConnectionTokenResult as E, FederatedIdentityProvider as F, TailorAnyDBType as G, AuthConnectionConfig as H, OAuth2ClientGrantType as I, TailorDBType as J, TailorDBField as K, SCIMAttributeType as L, DefinedAuth as M, FederatedIdentity as N, AuthOwnConfig as O, FederatedIdentityClaims as P, TailorTypePermission as Q, UserAttributeKey as R, IdPGqlOperations as S, AuthConfig as T, AuthConnectionOAuth2Config as U, UsernameFieldKey as V, TailorAnyDBField as W, PermissionCondition as X, db as Y, TailorTypeGqlPermission as Z, IdPConfig as _, ExecutorServiceConfig as a, IdpDefinitionBrand as b, ResolverServiceConfig as c, WorkflowServiceInput as d, unsafeAllowAllTypePermission as et, StaticWebsiteConfig as f, SecretsDefinitionBrand as g, SecretsConfig as h, AppConfig as i, BeforeLoginHookArgs as j, AuthServiceInput as k, ResolverServiceInput as l, StaticWebsiteInput as m, RetryPolicy as n, AllowedValuesOutput as nt, ExecutorServiceInput as o, StaticWebsiteDefinitionBrand as p, TailorDBInstance as q, HttpAdapterConfigInput as r, ResolverExternalConfig as s, ConcurrencyPolicy as t, AllowedValues as tt, WorkflowServiceConfig as u, IdPExternalConfig as v, IdPInput as w, IdPEmailConfig as x, IdPUserField as y, UserAttributeListKey as z };
1452
+ //# sourceMappingURL=workflow.generated-CCDsY0ce.d.mts.map
package/docs/cli/auth.md CHANGED
@@ -350,7 +350,7 @@ Get an access token for a machine user.
350
350
  **Usage**
351
351
 
352
352
  ```
353
- tailor-sdk machineuser token [options] <name>
353
+ tailor-sdk machineuser token [options] [name]
354
354
  ```
355
355
 
356
356
  <!-- politty:command:machineuser token:usage:end -->
@@ -359,9 +359,9 @@ tailor-sdk machineuser token [options] <name>
359
359
 
360
360
  **Arguments**
361
361
 
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 |
365
365
 
366
366
  <!-- politty:command:machineuser token:arguments:end -->
367
367
 
@@ -245,14 +245,14 @@ tailor-sdk function test-run [options] <file>
245
245
 
246
246
  **Options**
247
247
 
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"` | - |
256
256
 
257
257
  <!-- politty:command:function test-run:options:end -->
258
258
  <!-- politty:command:function test-run:examples:start -->
package/docs/cli/query.md CHANGED
@@ -33,7 +33,7 @@ tailor-sdk query [options]
33
33
  | `--query <QUERY>` | `-q` | Query string to execute directly; omit to start REPL mode | No | - | - |
34
34
  | `--file <FILE>` | `-f` | Read query string from file; omit to start REPL mode | No | - | - |
35
35
  | `--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` |
37
37
  | `--newline-on-enter` | - | REPL: when true, Enter inserts a newline and Shift+Enter submits. Use --no-newline-on-enter to swap. | No | - | - |
38
38
 
39
39
  <!-- politty:command:query:options:end -->
package/docs/cli/setup.md CHANGED
@@ -28,9 +28,9 @@ tailor-sdk setup [command]
28
28
 
29
29
  **Commands**
30
30
 
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) |
34
34
 
35
35
  <!-- politty:command:setup:subcommands:end -->
36
36
 
@@ -47,7 +47,7 @@ See [Global Options](../cli-reference.md#global-options) for options available t
47
47
 
48
48
  <!-- politty:command:setup github:description:start -->
49
49
 
50
- Generate GitHub Actions workflow for deployment. (beta)
50
+ Generate a GitHub Actions deploy workflow. (beta)
51
51
 
52
52
  <!-- politty:command:setup github:description:end -->
53
53
 
@@ -65,14 +65,16 @@ tailor-sdk setup github [options]
65
65
 
66
66
  **Options**
67
67
 
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` |
76
78
 
77
79
  <!-- politty:command:setup github:options:end -->
78
80
 
@@ -81,3 +83,7 @@ tailor-sdk setup github [options]
81
83
  See [Global Options](../cli-reference.md#global-options) for options available to all commands.
82
84
 
83
85
  <!-- politty:command:setup github:global-options-link:end -->
86
+
87
+ ## Further reading
88
+
89
+ - [GitHub Actions Integration](../github-actions.md) — usage guide: targets, generated files, secrets, approval gates, and rollback.
@@ -167,16 +167,16 @@ tailor-sdk workflow start [options] <name>
167
167
 
168
168
  **Options**
169
169
 
170
- | Option | Alias | Description | Required | Default | Env |
171
- | ------------------------------- | ----- | -------------------------------------------------------------- | -------- | -------------------- | ----------------------------------- |
172
- | `--workspace-id <WORKSPACE_ID>` | `-w` | Workspace ID | No | - | `TAILOR_PLATFORM_WORKSPACE_ID` |
173
- | `--profile <PROFILE>` | `-p` | Workspace profile | No | - | `TAILOR_PLATFORM_PROFILE` |
174
- | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` | `TAILOR_PLATFORM_SDK_CONFIG_PATH` |
175
- | `--machine-user <MACHINE_USER>` | `-m` | Machine user name | Yes | - | `TAILOR_PLATFORM_MACHINE_USER_NAME` |
176
- | `--arg <ARG>` | `-a` | Workflow argument (JSON string) | No | - | - |
177
- | `--wait` | `-W` | Wait for execution to complete | No | `false` | - |
178
- | `--interval <INTERVAL>` | `-i` | Polling interval when using --wait (e.g., '3s', '500ms', '1m') | No | `"3s"` | - |
179
- | `--logs` | `-l` | Display job execution logs after completion (requires --wait) | No | `false` | - |
170
+ | Option | Alias | Description | Required | Default | Env |
171
+ | ------------------------------- | ----- | --------------------------------------------------------------------------- | -------- | -------------------- | ----------------------------------- |
172
+ | `--workspace-id <WORKSPACE_ID>` | `-w` | Workspace ID | No | - | `TAILOR_PLATFORM_WORKSPACE_ID` |
173
+ | `--profile <PROFILE>` | `-p` | Workspace profile | No | - | `TAILOR_PLATFORM_PROFILE` |
174
+ | `--config <CONFIG>` | `-c` | Path to SDK config file | No | `"tailor.config.ts"` | `TAILOR_PLATFORM_SDK_CONFIG_PATH` |
175
+ | `--machine-user <MACHINE_USER>` | `-m` | Machine user name. Falls back to the active profile's default machine user. | No | - | `TAILOR_PLATFORM_MACHINE_USER_NAME` |
176
+ | `--arg <ARG>` | `-a` | Workflow argument (JSON string) | No | - | - |
177
+ | `--wait` | `-W` | Wait for execution to complete | No | `false` | - |
178
+ | `--interval <INTERVAL>` | `-i` | Polling interval when using --wait (e.g., '3s', '500ms', '1m') | No | `"3s"` | - |
179
+ | `--logs` | `-l` | Display job execution logs after completion (requires --wait) | No | `false` | - |
180
180
 
181
181
  <!-- politty:command:workflow start:options:end -->
182
182
 
@@ -241,11 +241,13 @@ tailor-sdk profile create [options] <name>
241
241
 
242
242
  **Options**
243
243
 
244
- | Option | Alias | Description | Required | Default |
245
- | ------------------------------- | ----- | --------------------------------------------------------------------------------- | -------- | --------- |
246
- | `--user <USER>` | `-u` | User email | Yes | - |
247
- | `--workspace-id <WORKSPACE_ID>` | `-w` | Workspace ID | Yes | - |
248
- | `--permission <PERMISSION>` | - | Profile permission. 'read' blocks all write commands while the profile is active. | No | `"write"` |
244
+ | Option | Alias | Description | Required | Default |
245
+ | ------------------------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------- |
246
+ | `--user <USER>` | `-u` | User email | Yes | - |
247
+ | `--workspace-id <WORKSPACE_ID>` | `-w` | Workspace ID | Yes | - |
248
+ | `--permission <PERMISSION>` | - | Profile permission. 'read' blocks all write commands while the profile is active. | No | `"write"` |
249
+ | `--machine-user <MACHINE_USER>` | `-m` | Default machine user name for application-data commands (query, workflow start, function test-run, machineuser token). | No | - |
250
+ | `--machine-user-override <MACHINE_USER_OVERRIDE>` | - | Whether the command line or TAILOR_PLATFORM_MACHINE_USER_NAME may override the profile's machine user. 'deny' requires --machine-user. | No | - |
249
251
 
250
252
  <!-- politty:command:profile create:options:end -->
251
253
 
@@ -320,11 +322,13 @@ tailor-sdk profile update [options] <name>
320
322
 
321
323
  **Options**
322
324
 
323
- | Option | Alias | Description | Required | Default |
324
- | ------------------------------- | ----- | ------------------------------------------------------------------------------------ | -------- | ------- |
325
- | `--user <USER>` | `-u` | New user email | No | - |
326
- | `--workspace-id <WORKSPACE_ID>` | `-w` | New workspace ID | No | - |
327
- | `--permission <PERMISSION>` | - | Profile permission. 'read' blocks all write commands; 'write' lifts the restriction. | No | - |
325
+ | Option | Alias | Description | Required | Default |
326
+ | ------------------------------------------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
327
+ | `--user <USER>` | `-u` | New user email | No | - |
328
+ | `--workspace-id <WORKSPACE_ID>` | `-w` | New workspace ID | No | - |
329
+ | `--permission <PERMISSION>` | - | Profile permission. 'read' blocks all write commands; 'write' lifts the restriction. | No | - |
330
+ | `--machine-user <MACHINE_USER>` | `-m` | Default machine user name for application-data commands (query, workflow start, function test-run, machineuser token). Pass an empty string to clear. | No | - |
331
+ | `--machine-user-override <MACHINE_USER_OVERRIDE>` | - | Whether the command line or TAILOR_PLATFORM_MACHINE_USER_NAME may override the profile's machine user. 'deny' requires --machine-user; 'allow' lifts the restriction. | No | - |
328
332
 
329
333
  <!-- politty:command:profile update:options:end -->
330
334
 
@@ -77,7 +77,7 @@ You can use environment variables to configure workspace and authentication:
77
77
  | `TAILOR_PLATFORM_SDK_DTS_PATH` | Output path for generated `tailor.d.ts` type definition file |
78
78
  | `TAILOR_PLATFORM_MACHINE_USER_CLIENT_ID` | Client ID for `login --machine-user` |
79
79
  | `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` |
81
81
  | `TAILOR_BUNDLE_CONCURRENCY` | Max concurrent bundle workers for `deploy` (resolvers/executors/workflows). Defaults to CPU count |
82
82
  | `VISUAL` / `EDITOR` | Preferred editor for commands that open files (e.g., `vim`, `code`, `nano`) |
83
83
  | `TAILOR_CRASH_REPORTS_LOCAL` | Local crash log writing: `on` (default) or `off` |
@@ -287,9 +287,9 @@ Commands for managing crash reports.
287
287
 
288
288
  Commands for setting up project infrastructure.
289
289
 
290
- | Command | Description |
291
- | ------------------------------------------- | ------------------------------------------------------- |
292
- | [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) |
293
293
 
294
294
  ### [Upgrade Commands](./cli/upgrade.md)
295
295