Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 119 additions & 100 deletions docs/sdk/cli-reference.md

Large diffs are not rendered by default.

165 changes: 163 additions & 2 deletions docs/sdk/cli/auth.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,167 @@
# Auth Resource Commands

Commands for managing Auth service resources (machine users and OAuth2 clients).
Commands for managing Auth service resources (auth connections, machine users, and OAuth2 clients).

<!-- politty:command:authconnection:heading:start -->

## authconnection

<!-- politty:command:authconnection:heading:end -->

<!-- politty:command:authconnection:description:start -->

Manage auth connections.

<!-- politty:command:authconnection:description:end -->

<!-- politty:command:authconnection:usage:start -->

**Usage**

```
tailor-sdk authconnection [command]
```

<!-- politty:command:authconnection:usage:end -->

<!-- politty:command:authconnection:subcommands:start -->

**Commands**

| Command | Description |
| ------------------------------------------------------- | --------------------------------------------- |
| [`authconnection authorize`](#authconnection-authorize) | Authorize an auth connection via OAuth2 flow. |
| [`authconnection list`](#authconnection-list) | List all auth connections. |
| [`authconnection revoke`](#authconnection-revoke) | Revoke an auth connection. |

<!-- politty:command:authconnection:subcommands:end -->

<!-- politty:command:authconnection:global-options-link:start -->

See [Global Options](../cli-reference.md#global-options) for options available to all commands.

<!-- politty:command:authconnection:global-options-link:end -->
<!-- politty:command:authconnection authorize:heading:start -->

### authconnection authorize

<!-- politty:command:authconnection authorize:heading:end -->

<!-- politty:command:authconnection authorize:description:start -->

Authorize an auth connection via OAuth2 flow.

<!-- politty:command:authconnection authorize:description:end -->

<!-- politty:command:authconnection authorize:usage:start -->

**Usage**

```
tailor-sdk authconnection authorize [options]
```

<!-- politty:command:authconnection authorize:usage:end -->

<!-- politty:command:authconnection authorize: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` |
| `--name <NAME>` | `-n` | Auth connection name | Yes | - | - |
| `--scopes <SCOPES>` | - | OAuth2 scopes to request (comma-separated) | No | `"openid,profile,email"` | - |
| `--port <PORT>` | - | Local callback server port | No | `8080` | - |
| `--no-browser` | - | Don't open browser automatically | No | `false` | - |

<!-- politty:command:authconnection authorize:options:end -->

<!-- politty:command:authconnection authorize:global-options-link:start -->

See [Global Options](../cli-reference.md#global-options) for options available to all commands.

<!-- politty:command:authconnection authorize:global-options-link:end -->

<!-- politty:command:authconnection list:heading:start -->

### authconnection list

<!-- politty:command:authconnection list:heading:end -->

<!-- politty:command:authconnection list:description:start -->

List all auth connections.

<!-- politty:command:authconnection list:description:end -->

<!-- politty:command:authconnection list:usage:start -->

**Usage**

```
tailor-sdk authconnection list [options]
```

<!-- politty:command:authconnection list:usage:end -->

<!-- politty:command:authconnection list: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` |

<!-- politty:command:authconnection list:options:end -->

<!-- politty:command:authconnection list:global-options-link:start -->

See [Global Options](../cli-reference.md#global-options) for options available to all commands.

<!-- politty:command:authconnection list:global-options-link:end -->
<!-- politty:command:authconnection revoke:heading:start -->

### authconnection revoke

<!-- politty:command:authconnection revoke:heading:end -->

<!-- politty:command:authconnection revoke:description:start -->

Revoke an auth connection.

<!-- politty:command:authconnection revoke:description:end -->

<!-- politty:command:authconnection revoke:usage:start -->

**Usage**

```
tailor-sdk authconnection revoke [options]
```

<!-- politty:command:authconnection revoke:usage:end -->

<!-- politty:command:authconnection revoke: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` |
| `--name <NAME>` | `-n` | Auth connection name | Yes | - | - |
| `--yes` | `-y` | Skip confirmation prompts | No | `false` | - |

<!-- politty:command:authconnection revoke:options:end -->

<!-- politty:command:authconnection revoke:global-options-link:start -->

See [Global Options](../cli-reference.md#global-options) for options available to all commands.

<!-- politty:command:authconnection revoke:global-options-link:end -->

<!-- politty:command:machineuser:heading:start -->

Expand Down Expand Up @@ -156,8 +317,8 @@ tailor-sdk oauth2client [command]

| Command | Description |
| ----------------------------------------- | -------------------------------------------------------- |
| [`oauth2client get`](#oauth2client-get) | Get OAuth2 client credentials (including client secret). |
| [`oauth2client list`](#oauth2client-list) | List all OAuth2 clients in the application. |
| [`oauth2client get`](#oauth2client-get) | Get OAuth2 client credentials (including client secret). |

<!-- politty:command:oauth2client:subcommands:end -->

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/cli/crash-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ See [Global Options](../cli-reference.md#global-options) for options available t

| Command | Description |
| ----------------------------------------- | ---------------------------------------------- |
| [`crash-report send`](#crash-report-send) | Submit a crash report to help improve the SDK. |
| [`crash-report list`](#crash-report-list) | List local crash report files. |
| [`crash-report send`](#crash-report-send) | Submit a crash report to help improve the SDK. |

<!-- politty:command:crash-report:subcommands:end -->
<!-- politty:command:crash-report list:heading:start -->
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/cli/executor.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ tailor-sdk executor [command]

| Command | Description |
| --------------------------------------- | ----------------------------- |
| [`executor trigger`](#executor-trigger) | Trigger an executor manually. |
| [`executor jobs`](#executor-jobs) | List or get executor jobs. |
| [`executor list`](#executor-list) | List all executors |
| [`executor get`](#executor-get) | Get executor details |
| [`executor jobs`](#executor-jobs) | List or get executor jobs. |
| [`executor trigger`](#executor-trigger) | Trigger an executor manually. |
| [`executor webhook`](#executor-webhook) | Manage executor webhooks |

<!-- politty:command:executor:subcommands:end -->
Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/cli/secret.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ tailor-sdk secret [command]

| Command | Description |
| --------------------------------- | ----------------------------- |
| [`secret vault`](#secret-vault) | Manage Secret Manager vaults. |
| [`secret create`](#secret-create) | Create a secret in a vault. |
| [`secret delete`](#secret-delete) | Delete a secret in a vault. |
| [`secret list`](#secret-list) | List all secrets in a vault. |
| [`secret update`](#secret-update) | Update a secret in a vault. |
| [`secret vault`](#secret-vault) | Manage Secret Manager vaults. |
| [`secret list`](#secret-list) | List all secrets in a vault. |
| [`secret delete`](#secret-delete) | Delete a secret in a vault. |

<!-- politty:command:secret:subcommands:end -->

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/cli/staticwebsite.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ tailor-sdk staticwebsite [command]
| Command | Description |
| ----------------------------------------------- | ----------------------------------------------------- |
| [`staticwebsite deploy`](#staticwebsite-deploy) | Deploy a static website from a local build directory. |
| [`staticwebsite get`](#staticwebsite-get) | Get details of a specific static website. |
| [`staticwebsite list`](#staticwebsite-list) | List all static websites in a workspace. |
| [`staticwebsite get`](#staticwebsite-get) | Get details of a specific static website. |

<!-- politty:command:staticwebsite:subcommands:end -->

Expand Down
6 changes: 4 additions & 2 deletions docs/sdk/cli/tailordb.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ tailor-sdk tailordb [command]

| Command | Description |
| ------------------------------------------- | --------------------------------------------------------------------- |
| [`tailordb erd`](#tailordb-erd) | Generate ERD artifacts for TailorDB namespaces using Liam ERD. (beta) |
| [`tailordb migration`](#tailordb-migration) | Manage TailorDB schema migrations. |
| [`tailordb truncate`](#tailordb-truncate) | Truncate (delete all records from) TailorDB tables. |
| [`tailordb migration`](#tailordb-migration) | Manage TailorDB schema migrations. |
| [`tailordb erd`](#tailordb-erd) | Generate ERD artifacts for TailorDB namespaces using Liam ERD. (beta) |

<!-- politty:command:tailordb:subcommands:end -->

Expand Down Expand Up @@ -105,6 +105,8 @@ Manage TailorDB schema migrations.

<!-- politty:command:tailordb migration:description:end -->

Note: Migration scripts are automatically executed during `tailor-sdk apply`. See [Automatic Migration Execution](#automatic-migration-execution) for details.

<!-- politty:command:tailordb migration:usage:start -->

**Usage**
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/cli/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ tailor-sdk user [command]
| ------------------------------- | ------------------------------ |
| [`user current`](#user-current) | Show current user. |
| [`user list`](#user-list) | List all users. |
| [`user pat`](#user-pat) | Manage personal access tokens. |
| [`user switch`](#user-switch) | Set current user. |
| [`user pat`](#user-pat) | Manage personal access tokens. |

<!-- politty:command:user:subcommands:end -->

Expand Down Expand Up @@ -243,9 +243,9 @@ tailor-sdk user pat [command]

| Command | Description |
| ------------------------------------- | ----------------------------------------------------- |
| [`user pat list`](#user-pat-list) | List all personal access tokens. |
| [`user pat create`](#user-pat-create) | Create a new personal access token. |
| [`user pat delete`](#user-pat-delete) | Delete a personal access token. |
| [`user pat list`](#user-pat-list) | List all personal access tokens. |
| [`user pat update`](#user-pat-update) | Update a personal access token (delete and recreate). |

<!-- politty:command:user pat:subcommands:end -->
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/generator/builtin.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Generates a TypeScript file containing:

- Type definitions for all TailorDB types
- `getDB(namespace)` function to create Kysely instances
- Utility types for Timestamp and Serial fields
- Utility types for `Timestamp`, `Serial`, and `ObjectColumnType` (wraps nested objects containing date/datetime fields to provide correct insert vs select types)

### Usage

Expand Down
Loading