Skip to content

Update SDK pages #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update SDK pages #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 29 additions & 8 deletions docs/sdk/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,18 @@ tailor-sdk apply --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_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 |
| `VISUAL` / `EDITOR` | Preferred editor for commands that open files (e.g., `vim`, `code`, `nano`) |
| Variable | Description |
| -------------------------------------------- | --------------------------------------------------------------------------- |
| `TAILOR_PLATFORM_WORKSPACE_ID` | Workspace ID for deployment 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_MACHINE_USER_CLIENT_ID` | Client ID for `login --machineuser` |
| `TAILOR_PLATFORM_MACHINE_USER_CLIENT_SECRET` | Client secret for `login --machineuser` |
| `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

Expand Down Expand Up @@ -203,6 +207,23 @@ Commands for managing and deploying static websites.
| [staticwebsite list](cli/staticwebsite.md#staticwebsite-list) | List static websites in a workspace |
| [staticwebsite get](cli/staticwebsite.md#staticwebsite-get) | Get details of a static website |

### [Crash Report Commands](cli/crash-report)

Commands for managing crash reports.

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

### [Setup Commands](cli/setup)

Commands for setting up project infrastructure.

| Command | Description |
| ------------------------------------------- | ----------------------------------------------- |
| [setup github](cli/setup.md#setup-github) | Generate GitHub Actions workflow for deployment |

### [Completion](cli/completion)

Generate shell completion scripts for bash, zsh, and fish.
Expand Down
107 changes: 107 additions & 0 deletions docs/sdk/cli/crash-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# Crash Report Commands

Commands for managing crash reports.

<!-- politty:command:crash-report:heading:start -->

## crash-report

<!-- politty:command:crash-report:heading:end -->

<!-- politty:command:crash-report:description:start -->

Manage crash reports.

<!-- politty:command:crash-report:description:end -->

<!-- politty:command:crash-report:usage:start -->

**Usage**

```
tailor-sdk crash-report [command]
```

<!-- politty:command:crash-report:usage:end -->

<!-- politty:command:crash-report:global-options-link:start -->

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

<!-- politty:command:crash-report:global-options-link:end -->

<!-- politty:command:crash-report:subcommands:start -->

**Commands**

| 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. |

<!-- politty:command:crash-report:subcommands:end -->
<!-- politty:command:crash-report list:heading:start -->

### crash-report list

<!-- politty:command:crash-report list:heading:end -->

<!-- politty:command:crash-report list:description:start -->

List local crash report files.

<!-- politty:command:crash-report list:description:end -->

<!-- politty:command:crash-report list:usage:start -->

**Usage**

```
tailor-sdk crash-report list
```

<!-- politty:command:crash-report list:usage:end -->

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

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

<!-- politty:command:crash-report list:global-options-link:end -->

<!-- politty:command:crash-report send:heading:start -->

### crash-report send

<!-- politty:command:crash-report send:heading:end -->

<!-- politty:command:crash-report send:description:start -->

Submit a crash report to help improve the SDK.

<!-- politty:command:crash-report send:description:end -->

<!-- politty:command:crash-report send:usage:start -->

**Usage**

```
tailor-sdk crash-report send [options]
```

<!-- politty:command:crash-report send:usage:end -->

<!-- politty:command:crash-report send:options:start -->

**Options**

| Option | Alias | Description | Required | Default |
| --------------- | ----- | ----------------------------- | -------- | ------- |
| `--file <FILE>` | - | Path to the crash report file | Yes | - |

<!-- politty:command:crash-report send:options:end -->

<!-- politty:command:crash-report send:global-options-link:start -->

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

<!-- politty:command:crash-report send:global-options-link:end -->
30 changes: 16 additions & 14 deletions docs/sdk/cli/secret.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,13 +243,14 @@ tailor-sdk secret create [options]

**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` |
| `--vault-name <VAULT_NAME>` | `-V` | Vault name | Yes | - | - |
| `--name <NAME>` | `-n` | Secret name | Yes | - | - |
| `--value <VALUE>` | `-v` | Secret value | Yes | - | - |
| 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` |
| `--vault-name <VAULT_NAME>` | `-V` | Vault name | Yes | - | - |
| `--name <NAME>` | `-n` | Secret name | Yes | - | - |
| `--value <VALUE>` | `-v` | Secret value | Yes | - | - |
| `--yes` | `-y` | Skip confirmation prompts | No | `false` | - |

<!-- politty:command:secret create:options:end -->

Expand Down Expand Up @@ -284,13 +285,14 @@ tailor-sdk secret update [options]

**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` |
| `--vault-name <VAULT_NAME>` | `-V` | Vault name | Yes | - | - |
| `--name <NAME>` | `-n` | Secret name | Yes | - | - |
| `--value <VALUE>` | `-v` | Secret value | Yes | - | - |
| 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` |
| `--vault-name <VAULT_NAME>` | `-V` | Vault name | Yes | - | - |
| `--name <NAME>` | `-n` | Secret name | Yes | - | - |
| `--value <VALUE>` | `-v` | Secret value | Yes | - | - |
| `--yes` | `-y` | Skip confirmation prompts | No | `false` | - |

<!-- politty:command:secret update:options:end -->

Expand Down
82 changes: 82 additions & 0 deletions docs/sdk/cli/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Setup Commands

Commands for setting up project infrastructure.

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

## setup

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

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

Set up project infrastructure.

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

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

**Usage**

```
tailor-sdk setup [command]
```

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

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

**Commands**

| Command | Description |
| ------------------------------- | ------------------------------------------------------- |
| [`setup github`](#setup-github) | Generate GitHub Actions workflow for deployment. (beta) |

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

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

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 github:heading:end -->

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

Generate GitHub Actions workflow for deployment. (beta)

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

<!-- politty:command:setup github:usage:start -->

**Usage**

```
tailor-sdk setup github [options]
```

<!-- 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 | Yes | - |
| `--workspace-region <WORKSPACE_REGION>` | `-r` | Workspace region | Yes | - |
| `--organization-id <ORGANIZATION_ID>` | `-o` | Organization ID | Yes | - |
| `--folder-id <FOLDER_ID>` | `-f` | Folder ID | Yes | - |
| `--dir <DIR>` | `-d` | App directory (for monorepo setups) | No | `"."` |

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

<!-- politty:command:setup github: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 -->
43 changes: 21 additions & 22 deletions docs/sdk/cli/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,31 @@ Login to Tailor Platform.
**Usage**

```
tailor-sdk login
tailor-sdk login [options]
```

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

<!-- politty:command:login:options:start -->

**Options**

> One of the following option groups is required:

**User Login:**

_no options_

**Machine User Login:**

| Option | Alias | Description | Required | Default | Env |
| --------------------------------- | ----- | --------------------------------- | -------- | ------- | -------------------------------------------- |
| `--machineuser <MACHINEUSER>` | - | Login as a platform machine user. | Yes | - | - |
| `--client-id <CLIENT_ID>` | - | Client ID | Yes | - | `TAILOR_PLATFORM_MACHINE_USER_CLIENT_ID` |
| `--client-secret <CLIENT_SECRET>` | - | Client secret | No | - | `TAILOR_PLATFORM_MACHINE_USER_CLIENT_SECRET` |

<!-- politty:command:login:options:end -->

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

See [Global Options](../cli-reference.md#global-options) for options available to all commands.
Expand Down Expand Up @@ -148,13 +168,6 @@ tailor-sdk user list
<!-- politty:command:user list:usage:end -->

<!-- politty:command:user list:options:start -->

**Options**

| Option | Alias | Description | Required | Default |
| -------- | ----- | -------------- | -------- | ------- |
| `--json` | `-j` | Output as JSON | No | `false` |

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

<!-- politty:command:user list:global-options-link:start -->
Expand Down Expand Up @@ -222,13 +235,6 @@ tailor-sdk user pat [command]
<!-- politty:command:user pat:usage:end -->

<!-- politty:command:user pat:options:start -->

**Options**

| Option | Alias | Description | Required | Default |
| -------- | ----- | -------------- | -------- | ------- |
| `--json` | `-j` | Output as JSON | No | `false` |

<!-- politty:command:user pat:options:end -->

<!-- politty:command:user pat:subcommands:start -->
Expand Down Expand Up @@ -272,13 +278,6 @@ tailor-sdk user pat list
<!-- politty:command:user pat list:usage:end -->

<!-- politty:command:user pat list:options:start -->

**Options**

| Option | Alias | Description | Required | Default |
| -------- | ----- | -------------- | -------- | ------- |
| `--json` | `-j` | Output as JSON | No | `false` |

<!-- politty:command:user pat list:options:end -->

<!-- politty:command:user pat list:global-options-link:start -->
Expand Down
7 changes: 0 additions & 7 deletions docs/sdk/cli/workspace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,13 +274,6 @@ tailor-sdk profile list
<!-- politty:command:profile list:usage:end -->

<!-- politty:command:profile list:options:start -->

**Options**

| Option | Alias | Description | Required | Default |
| -------- | ----- | -------------- | -------- | ------- |
| `--json` | `-j` | Output as JSON | No | `false` |

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

<!-- politty:command:profile list:global-options-link:start -->
Expand Down
Loading