Skip to content

CLI 0.2.0 doc updates #4647

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

Merged
atovpeko merged 4 commits into from
Jan 30, 2026
Merged

CLI 0.2.0 doc updates #4647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
577e1b5
020 updates
atovpeko Jan 27, 2026
1e48ce3
020 updates
atovpeko Jan 27, 2026
18cb045
mcp tool updates
atovpeko Jan 28, 2026
25e787e
Merge branch 'latest' into 4646-tiger-cli-0200
atovpeko Jan 30, 2026
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
14 changes: 7 additions & 7 deletions _partials/_devops-cli-config-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@

| Flag | Default | Description |
|---------------------------|-------------------|-----------------------------------------------------------------------------|
| `analytics` | `true` | Set to `false` to disable usage analytics |
| `color ` | `true` | Set to `false` to disable colored output |
| `debug` | No debugging | Enable debug logging |
| `analytics` | `true` | Enable or disable usage analytics |
| `color` | `true` | Enable or disable colored output |
| `debug` | `false` | Enable or disable debug logging |
| `docs_mcp` | `true` | Enable or disable the $COMPANY documentation MCP proxy |
| `output` | `table` | Set the output format to `json`, `yaml`, or `table` |
| `password-storage` string | `keyring` | Set the password storage method. Options are `keyring`, `pgpass`, or `none` |
| `service-id` string | - | Set the $SERVICE_LONG to manage |
| `version_check_interval` | `24h` | Set how often the $CLI_SHORT checks for a new version |
| `output` | `table` | Set the output format to `json`, `yaml`, or `table` |
| `password_storage` | `keyring` | Set the password storage method. Options are `keyring`, `pgpass`, or `none` |
| `service_id` | - | Set the default $SERVICE_SHORT to manage |
| `version_check_interval` | `24h` | Set how often the $CLI_SHORT checks for a new version. Set to `0` to disable |

You can also set these configuration options as environment variables. Environment variables:
* Take precedence over configuration parameters values.
Expand Down
13 changes: 7 additions & 6 deletions _partials/_devops-cli-get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import RESTPrereqs from "versionContent/_partials/_prereqs-cloud-account-only.mdx";
import CLIINSTALL from "versionContent/_partials/_devops-cli-install.mdx";
import CLIREF from "versionContent/_partials/_devops-cli-reference.mdx";
import NotSupportedAzure from "versionContent/_partials/_not-supported-for-azure.mdx";

$CLI_LONG is a command-line interface that you use to manage $CLOUD_LONG resources
including VPCs, services, read replicas, and related infrastructure. $CLI_LONG calls $REST_LONG to communicate with
Expand All @@ -14,8 +13,6 @@ service.

<RESTPrereqs />

<NotSupportedAzure />


## Install and configure $CLI_LONG

Expand All @@ -35,15 +32,19 @@ Create a new $SERVICE_LONG using $CLI_LONG:
1. **Submit a $SERVICE_SHORT creation request**

By default, $CLI_LONG creates a $SERVICE_SHORT for you that matches your [$PRICING_PLAN][pricing-plans]:
* **$FREE**: shared CPU/memory and the `time-series` and `ai` capabilities
* **$FREE**: shared CPU/memory and the `time-series` and `ai` capabilities (only available in `us-east-1` region)
* **Paid $PRICING_PLAN**: 0.5 CPU and 2 GB memory with the `time-series` capability
```shell
tiger service create
```
To control the $SERVICE_SHORT configuration, use the [`service create` flags][cli-create-custom-service]. For
example, to create a free service if you are in a paid $PRICING_PLAN, call
To control the $SERVICE_SHORT configuration, use the [`service create` flags][cli-create-custom-service]. For
example, to create a free service if you are in a paid $PRICING_PLAN, call
`tiger service create --memory shared --cpu shared`.

<Highlight type="note">
Free services with shared CPU/memory are only available in the `us-east-1` region. Paid services can be created in any available AWS or Azure region using the `--region` flag.
</Highlight>

$CLOUD_LONG creates a Development environment for you. That is, no delete protection, high-availability, spooling or
read replication. You see something like:
```terminaloutput
Expand Down
16 changes: 8 additions & 8 deletions _partials/_devops-cli-global-flags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

| Flag | Default | Description |
|-------------------------------|-------------------|-----------------------------------------------------------------------------|
| `--analytics` | `true` | Set to `false` to disable usage analytics |
| `--color ` | `true` | Set to `false` to disable colored output |
| `--config-dir` string | `~/.config/tiger` | Set the directory that holds `config.yaml` |
| `--debug` | No debugging | Enable debug logging |
| `--help` | - | Print help about the current command. For example, `tiger service --help` |
| `--password-storage` string | keyring | Set the password storage method. Options are `keyring`, `pgpass`, or `none` |
| `--service-id` string | - | Set the $SERVICE_LONG to manage |
| `--skip-update-check` | - | Do not check if a new version of $CLI_LONG is available |
| `--analytics` | `true` | Enable or disable usage analytics |
| `--color` | `true` | Enable or disable colored output |
| `--config-dir` | `~/.config/tiger` | Set the directory that holds `config.yaml` |
| `--debug` | `false` | Enable or disable debug logging |
| `--help`, `-h` | - | Print help about the current command. For example, `tiger service --help` |
| `--password-storage` | `keyring` | Set the password storage method. Options are `keyring`, `pgpass`, or `none` |
| `--service-id` | - | Set the default $SERVICE_SHORT to manage |
| `--skip-update-check` | `false` | Skip checking if a new version of $CLI_LONG is available |
Loading