From 4359a3fe2e4f64e4ebbb119d5676158747cfb0e2 Mon Sep 17 00:00:00 2001 From: Nathan Cochran Date: Thu, 30 Oct 2025 10:00:05 -0400 Subject: [PATCH 1/9] Fix erroneous references to --cpu-memory flag --- _partials/_devops-cli-reference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_partials/_devops-cli-reference.md b/_partials/_devops-cli-reference.md index a3e78d85a7..4064782464 100644 --- a/_partials/_devops-cli-reference.md +++ b/_partials/_devops-cli-reference.md @@ -18,9 +18,9 @@ You can use the following commands with $CLI_LONG. For more information on each | | unset `` | Clear the value of a configuration parameter. For example, `tiger config unset debug` | | | reset | Reset the configuration to the defaults. This also logs you out from the current $PROJECT_LONG | | service | | Manage the $SERVICE_LONGs in this $PROJECT_SHORT | -| | create | Create a new $SERVICE_SHORT in this $PROJECT_SHORT. Possible flags are:
Possible `cpu-memory` combinations are: | +| | create | Create a new $SERVICE_SHORT in this $PROJECT_SHORT. Possible flags are:
Allowed CPU/memory configurations are: Note: You can specify both CPU and memory together, or specify only one (the other will be automatically configured). | | | delete `` | Delete a $SERVICE_SHORT from this $PROJECT_SHORT. This operation is irreversible and requires confirmation by typing the service ID | -| | fork `` | Fork an existing service to create a new independent copy. Key features are:
  • Timing options: `--now`, `--last-snapshot`, `--to-timestamp`
  • Resource configuration: `--cpu-memory`
  • Naming: `--name `. Defaults to `{source-service-name}-fork`
  • Wait behavior: `--no-wait`, `--wait-timeout`
  • Default service: `--no-set-default`
| +| | fork `` | Fork an existing service to create a new independent copy. Key features are:
  • Timing options: `--now`, `--last-snapshot`, `--to-timestamp`
  • Resource configuration: `--cpu` (CPU allocation in millicores), `--memory` (memory allocation in gigabytes). Inherits from source service if not specified
  • Naming: `--name `. Defaults to `{source-service-name}-fork`
  • Wait behavior: `--no-wait`, `--wait-timeout`
  • Default service: `--no-set-default`
| | | get `` (aliases: describe, show) | Show detailed information about a specific $SERVICE_SHORT in this $PROJECT_SHORT | | | list | List all the $SERVICE_SHORTs in this $PROJECT_SHORT | | | update-password `` | Update the master password for a $SERVICE_SHORT | From 33946cd1826bb84aabf1b9f7fe81eaa1f6e8cde6 Mon Sep 17 00:00:00 2001 From: Nathan Cochran Date: Thu, 30 Oct 2025 17:15:03 -0400 Subject: [PATCH 2/9] Improve documentation of configuration parameters, env vars, and flags --- _partials/_devops-cli-reference.md | 62 +++++++++++++++++++++--------- 1 file changed, 43 insertions(+), 19 deletions(-) diff --git a/_partials/_devops-cli-reference.md b/_partials/_devops-cli-reference.md index 4064782464..77762ba15f 100644 --- a/_partials/_devops-cli-reference.md +++ b/_partials/_devops-cli-reference.md @@ -45,25 +45,49 @@ You can use the following global flags with $CLI_LONG: ## Configuration parameters -By default, $CLI_LONG stores your configuration in `~/.config/tiger/config.yaml`. The name of these -variables matches the flags you use to update them. However, you can override them using the following -environmental variables: - -- **Configuration parameters** - - `TIGER_CONFIG_DIR`: path to configuration directory (default: `~/.config/tiger`) - - `TIGER_API_URL`: $REST_LONG base endpoint (default: https://console.cloud.timescale.com/public/api/v1) - - `TIGER_CONSOLE_URL`: URL to $CONSOLE (default: https://console.cloud.timescale.com) - - `TIGER_GATEWAY_URL`: URL to the $CONSOLE gateway (default: https://console.cloud.timescale.com/api) - - `TIGER_DOCS_MCP`: enable/disable docs MCP proxy (default: `true`) - - `TIGER_DOCS_MCP_URL`: URL to $MCP_SHORT for $COMPANY docs (default: https://mcp.tigerdata.com/docs) - - `TIGER_SERVICE_ID`: ID for the $SERVICE_SHORT updated when you call $CLI_SHORT commands - - `TIGER_ANALYTICS`: enable or disable analytics (default: `true`) - - `TIGER_PASSWORD_STORAGE`: password storage method (keyring, pgpass, or none) - - `TIGER_DEBUG`: enable/disable debug logging (default: `false`) - - `TIGER_COLOR`: set to `false` to disable colored output (default: `true`) - - -- **Authentication parameters** +By default, $CLI_LONG stores your configuration in `~/.config/tiger/config.yaml`. + +### Configuration Options + +All configuration options can be set via `tiger config set `: + +- `analytics` - Enable/disable analytics (default: `true`) +- `color` - Enable/disable colored output (default: `true`) +- `debug` - Enable/disable debug logging (default: `false`) +- `docs_mcp` - Enable/disable docs MCP proxy (default: `true`) +- `output` - Output format: `json`, `yaml`, or `table` (default: `table`) +- `password_storage` - Password storage method: `keyring`, `pgpass`, or `none` (default: `keyring`) +- `service_id` - Default service ID +- `version_check_interval` - How often the CLI will check for new versions, 0 to disable (default: `24h`) + +### Environment Variables + +Environment variables override configuration file values. All variables use the `TIGER_` prefix: + +- `TIGER_ANALYTICS` - Enable/disable analytics +- `TIGER_COLOR` - Enable/disable colored output +- `TIGER_CONFIG_DIR` - Path to configuration directory (default: `~/.config/tiger`) +- `TIGER_DEBUG` - Enable/disable debug logging +- `TIGER_DOCS_MCP` - Enable/disable docs MCP proxy +- `TIGER_OUTPUT` - Output format: `json`, `yaml`, or `table` +- `TIGER_PASSWORD_STORAGE` - Password storage method: `keyring`, `pgpass`, or `none` +- `TIGER_SERVICE_ID` - Default service ID +- `TIGER_VERSION_CHECK_INTERVAL` - How often the CLI will check for new versions, 0 to disable + +### Global Flags + +These flags are available on all commands and take precedence over both environment variables and configuration file values: + +- `--analytics` - Enable/disable analytics +- `--color` - Enable/disable colored output +- `--config-dir ` - Path to configuration directory (default: `~/.config/tiger`) +- `--debug` - Enable/disable debug logging +- `--password-storage ` - Password storage method: `keyring`, `pgpass`, or `none` +- `--service-id ` - Specify service ID +- `--skip-update-check` - Skip checking for updates on startup (default: `false`) +- `-h, --help` - Show help information + +### Authentication parameters To authenticate without using the interactive login, either: - Set the following parameters with your [client credentials][rest-api-credentials], then `login`: From 2f51c8a188a6ef0e39b7cfc5e9e6f5acbffeb2f5 Mon Sep 17 00:00:00 2001 From: Nathan Cochran Date: Thu, 30 Oct 2025 17:26:31 -0400 Subject: [PATCH 3/9] Add new 'create role' command --- _partials/_devops-cli-reference.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_partials/_devops-cli-reference.md b/_partials/_devops-cli-reference.md index 77762ba15f..ac122b1018 100644 --- a/_partials/_devops-cli-reference.md +++ b/_partials/_devops-cli-reference.md @@ -27,6 +27,7 @@ You can use the following commands with $CLI_LONG. For more information on each | db | | Database operations and management | | | connect `` | Connect to a $SERVICE_SHORT | | | connection-string `` | Retrieve the connection string for a $SERVICE_SHORT | +| | create role `[service-id]` | Create a new database role with optional read-only enforcement. | | | save-password `` | Save the password for a service | | | test-connection `` | Test the connectivity to a $SERVICE_SHORT | | mcp | | Manage $MCP_LONG for AI Assistant integration | @@ -105,4 +106,4 @@ These flags are available on all commands and take precedence over both environm [get-project-id]: /integrations/:currentVersion:/find-connection-details/#find-your-project-and-service-id [create-client-credentials]: /integrations/:currentVersion:/find-connection-details/#create-client-credentials [curl]: https://curl.se/ -[rest-api-credentials]: https://console.cloud.timescale.com/dashboard/settings \ No newline at end of file +[rest-api-credentials]: https://console.cloud.timescale.com/dashboard/settings From 9deca739f30ae0aa651c373520a2738de2b56314 Mon Sep 17 00:00:00 2001 From: Nathan Cochran Date: Thu, 30 Oct 2025 17:27:02 -0400 Subject: [PATCH 4/9] Add backticks around output format --- _partials/_devops-cli-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_partials/_devops-cli-reference.md b/_partials/_devops-cli-reference.md index ac122b1018..f68b67d209 100644 --- a/_partials/_devops-cli-reference.md +++ b/_partials/_devops-cli-reference.md @@ -18,7 +18,7 @@ You can use the following commands with $CLI_LONG. For more information on each | | unset `` | Clear the value of a configuration parameter. For example, `tiger config unset debug` | | | reset | Reset the configuration to the defaults. This also logs you out from the current $PROJECT_LONG | | service | | Manage the $SERVICE_LONGs in this $PROJECT_SHORT | -| | create | Create a new $SERVICE_SHORT in this $PROJECT_SHORT. Possible flags are:
  • `--name`: service name (auto-generated if not provided)
  • `--addons`: addons to enable (time-series, ai, or none for PostgreSQL-only)
  • `--region`: region code where the service will be deployed
  • `--cpu`: CPU allocation in millicores or 'shared'
  • `--memory`: memory allocation in gigabytes or 'shared'
  • `--replicas`: number of high-availability replicas
  • `--no-wait`: don't wait for the operation to complete
  • `--wait-timeout`: wait timeout duration (for example, 30m, 1h30m, 90s)
  • `--no-set-default`: don't set this service as the default service
  • `--with-password`: include password in output
  • `--output, -o`: output format (`json`, `yaml`, table)

Allowed CPU/memory configurations are:
  • shared / shared
  • 0.5 CPU (500m) / 2GB
  • 1 CPU (1000m) / 4GB
  • 2 CPU (2000m) / 8GB
  • 4 CPU (4000m) / 16GB
  • 8 CPU (8000m) / 32GB
  • 16 CPU (16000m) / 64GB
  • 32 CPU (32000m) / 128GB
Note: You can specify both CPU and memory together, or specify only one (the other will be automatically configured). | +| | create | Create a new $SERVICE_SHORT in this $PROJECT_SHORT. Possible flags are:
  • `--name`: service name (auto-generated if not provided)
  • `--addons`: addons to enable (time-series, ai, or none for PostgreSQL-only)
  • `--region`: region code where the service will be deployed
  • `--cpu`: CPU allocation in millicores or 'shared'
  • `--memory`: memory allocation in gigabytes or 'shared'
  • `--replicas`: number of high-availability replicas
  • `--no-wait`: don't wait for the operation to complete
  • `--wait-timeout`: wait timeout duration (for example, 30m, 1h30m, 90s)
  • `--no-set-default`: don't set this service as the default service
  • `--with-password`: include password in output
  • `--output, -o`: output format (`json`, `yaml`, `table`)

Allowed CPU/memory configurations are:
  • shared / shared
  • 0.5 CPU (500m) / 2GB
  • 1 CPU (1000m) / 4GB
  • 2 CPU (2000m) / 8GB
  • 4 CPU (4000m) / 16GB
  • 8 CPU (8000m) / 32GB
  • 16 CPU (16000m) / 64GB
  • 32 CPU (32000m) / 128GB
Note: You can specify both CPU and memory together, or specify only one (the other will be automatically configured). | | | delete `` | Delete a $SERVICE_SHORT from this $PROJECT_SHORT. This operation is irreversible and requires confirmation by typing the service ID | | | fork `` | Fork an existing service to create a new independent copy. Key features are:
  • Timing options: `--now`, `--last-snapshot`, `--to-timestamp`
  • Resource configuration: `--cpu` (CPU allocation in millicores), `--memory` (memory allocation in gigabytes). Inherits from source service if not specified
  • Naming: `--name `. Defaults to `{source-service-name}-fork`
  • Wait behavior: `--no-wait`, `--wait-timeout`
  • Default service: `--no-set-default`
| | | get `` (aliases: describe, show) | Show detailed information about a specific $SERVICE_SHORT in this $PROJECT_SHORT | From ae4f0455871d50030ce72174591de5d06c1386b5 Mon Sep 17 00:00:00 2001 From: Nathan Cochran Date: Thu, 30 Oct 2025 17:30:05 -0400 Subject: [PATCH 5/9] Minor tweaks to global CLI flags --- _partials/_devops-cli-global-flags.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_partials/_devops-cli-global-flags.md b/_partials/_devops-cli-global-flags.md index 1fd8c692dc..4bfc3d0bad 100644 --- a/_partials/_devops-cli-global-flags.md +++ b/_partials/_devops-cli-global-flags.md @@ -3,9 +3,9 @@ |-------------------------------|-------------------|-----------------------------------------------------------------------------| | `--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` | +| `--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| \ No newline at end of file +| `--skip-update-check` | - | Do not check if a new version of $CLI_LONG is available | From 3b146454bfe69f459813e309aa8ae13aecf4e067 Mon Sep 17 00:00:00 2001 From: Nathan Cochran Date: Thu, 30 Oct 2025 17:44:14 -0400 Subject: [PATCH 6/9] List config options, not env vars --- _partials/_devops-cli-reference.md | 65 ++++++++++-------------------- 1 file changed, 21 insertions(+), 44 deletions(-) diff --git a/_partials/_devops-cli-reference.md b/_partials/_devops-cli-reference.md index f68b67d209..de4c50ea6c 100644 --- a/_partials/_devops-cli-reference.md +++ b/_partials/_devops-cli-reference.md @@ -37,66 +37,43 @@ You can use the following commands with $CLI_LONG. For more information on each | | start http | Start $MCP_LONG with HTTP transport. Includes flags: `--port` (default: `8080`), `--host` (default: `localhost`) | -## Global flags - -You can use the following global flags with $CLI_LONG: - - - ## Configuration parameters -By default, $CLI_LONG stores your configuration in `~/.config/tiger/config.yaml`. - -### Configuration Options - -All configuration options can be set via `tiger config set `: +By default, $CLI_LONG stores your configuration in `~/.config/tiger/config.yaml`. The location of the config +directory can be adjusted via the `--config-dir` flag or the `TIGER_CONFIG_DIR` environment variable. -- `analytics` - Enable/disable analytics (default: `true`) -- `color` - Enable/disable colored output (default: `true`) -- `debug` - Enable/disable debug logging (default: `false`) -- `docs_mcp` - Enable/disable docs MCP proxy (default: `true`) -- `output` - Output format: `json`, `yaml`, or `table` (default: `table`) -- `password_storage` - Password storage method: `keyring`, `pgpass`, or `none` (default: `keyring`) -- `service_id` - Default service ID -- `version_check_interval` - How often the CLI will check for new versions, 0 to disable (default: `24h`) +- **Configuration options** -### Environment Variables + All configuration options can be set via `tiger config set `: -Environment variables override configuration file values. All variables use the `TIGER_` prefix: + - `analytics` - Enable/disable analytics (default: `true`) + - `color` - Enable/disable colored output (default: `true`) + - `debug` - Enable/disable debug logging (default: `false`) + - `docs_mcp` - Enable/disable docs MCP proxy (default: `true`) + - `output` - Output format: `json`, `yaml`, or `table` (default: `table`) + - `password_storage` - Password storage method: `keyring`, `pgpass`, or `none` (default: `keyring`) + - `service_id` - Default service ID + - `version_check_interval` - How often the CLI will check for new versions, 0 to disable (default: `24h`) -- `TIGER_ANALYTICS` - Enable/disable analytics -- `TIGER_COLOR` - Enable/disable colored output -- `TIGER_CONFIG_DIR` - Path to configuration directory (default: `~/.config/tiger`) -- `TIGER_DEBUG` - Enable/disable debug logging -- `TIGER_DOCS_MCP` - Enable/disable docs MCP proxy -- `TIGER_OUTPUT` - Output format: `json`, `yaml`, or `table` -- `TIGER_PASSWORD_STORAGE` - Password storage method: `keyring`, `pgpass`, or `none` -- `TIGER_SERVICE_ID` - Default service ID -- `TIGER_VERSION_CHECK_INTERVAL` - How often the CLI will check for new versions, 0 to disable + Additionally, all configuration options can also be provided as environment variables. Environment variables use + the `TIGER_` prefix (for example, `TIGER_ANALYTICS`), and take precendence over configuration file values. -### Global Flags +- **Global Flags** -These flags are available on all commands and take precedence over both environment variables and configuration file values: + These flags are available on all commands and take precedence over both environment variables and configuration file values: -- `--analytics` - Enable/disable analytics -- `--color` - Enable/disable colored output -- `--config-dir ` - Path to configuration directory (default: `~/.config/tiger`) -- `--debug` - Enable/disable debug logging -- `--password-storage ` - Password storage method: `keyring`, `pgpass`, or `none` -- `--service-id ` - Specify service ID -- `--skip-update-check` - Skip checking for updates on startup (default: `false`) -- `-h, --help` - Show help information + -### Authentication parameters +- **Authentication parameters** - To authenticate without using the interactive login, either: + To authenticate without using the interactive login, either: - Set the following parameters with your [client credentials][rest-api-credentials], then `login`: ```shell - TIGER_PUBLIC_KEY= TIGER_SECRET_KEY= TIGER_PROJECT_ID=\ + TIGER_PUBLIC_KEY= TIGER_SECRET_KEY= TIGER_PROJECT_ID=\ tiger auth login ``` - - Add your [client credentials][rest-api-credentials] to the `login` command: + - Add your [client credentials][rest-api-credentials] to the `login` command: ```shell tiger auth login --public-key= --secret-key= --project-id= ``` From cebf347b9cbe9bd4caa554c2f0997dfd0050af06 Mon Sep 17 00:00:00 2001 From: Nathan Cochran Date: Thu, 30 Oct 2025 17:48:33 -0400 Subject: [PATCH 7/9] MCP tools, not commands --- ai/mcp-server.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ai/mcp-server.md b/ai/mcp-server.md index 9e82771484..078cd598e8 100644 --- a/ai/mcp-server.md +++ b/ai/mcp-server.md @@ -207,7 +207,7 @@ start $MCP_LONG: } ``` -## $MCP_LONG commands +## $MCP_LONG tools @@ -230,4 +230,4 @@ You can use the following $CLI_LONG global flags when you run $MCP_SHORT: [cloud-regions]: /use-timescale/:currentVersion:/regions/ [readreplica]: /use-timescale/:currentVersion:/ha-replicas/read-scaling/ [manual-config]: /ai/:currentVersion:/mcp-server/#manually-configure-the-tiger-mcp-server - \ No newline at end of file + From c7792b3148002484eed2e0d9bd33720ec2cc3a7e Mon Sep 17 00:00:00 2001 From: Nathan Cochran Date: Thu, 30 Oct 2025 17:49:24 -0400 Subject: [PATCH 8/9] Add new service_fork MCP tool --- _partials/_devops-mcp-commands.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/_partials/_devops-mcp-commands.md b/_partials/_devops-mcp-commands.md index 0b91f74756..89fc7e5e67 100644 --- a/_partials/_devops-mcp-commands.md +++ b/_partials/_devops-mcp-commands.md @@ -17,6 +17,16 @@ $MCP_LONG exposes the following MCP tools to your AI Assistant: | | `timeout_minutes` | - | Set the timeout in minutes to wait for $SERVICE_SHORT to be ready. Only used when `wait=true`. Default: 30 minutes | | | `set_default` | - | By default, the new $SERVICE_SHORT is the default for following commands in $CLI_SHORT. Set to `false` to keep the previous $SERVICE_SHORT as the default. | | | `with_password` | - | Set to `true` to include the password for this $SERVICE_SHORT in response and connection string.
**WARNING**: never set to `true` unless user explicitly requests the password. | +| `service_fork` | - | - | Fork an existing $SERVICE_SHORT to create a new independent copy.
**WARNING**: creates billable resources. | +| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT to fork (10-character alphanumeric string). | +| | `fork_strategy` | ✓ | Fork strategy:
  • `NOW`: Fork at current database state
  • `LAST_SNAPSHOT`: Fork at last existing snapshot (faster)
  • `PITR`: Point-in-time recovery to specific timestamp (requires `target_time`)
| +| | `target_time` | - | Target timestamp for point-in-time recovery (RFC3339 format, e.g., `2025-01-15T10:30:00Z`). Only used when `fork_strategy` is `PITR`. | +| | `name` | - | Set the human-readable name for the forked $SERVICE_SHORT. Defaults to `{source-service-name}-fork`. | +| | `cpu_memory` | - | CPU and memory allocation combination. Inherits from source $SERVICE_SHORT if not specified.
Available configurations are:
  • shared/shared
  • 0.5 CPU/2 GB
  • 1 CPU/4 GB
  • 2 CPU/8 GB
  • 4 CPU/16 GB
  • 8 CPU/32 GB
  • 16 CPU/64 GB
  • 32 CPU/128 GB
| +| | `wait` | - | Set to `true` to wait for forked $SERVICE_SHORT to be fully ready before returning. Default: `false`. | +| | `timeout_minutes` | - | Set the timeout in minutes to wait for forked $SERVICE_SHORT to be ready. Only used when `wait=true`. Default: 30 minutes | +| | `set_default` | - | By default, the forked $SERVICE_SHORT is set as the default for following commands in $CLI_SHORT. Set to `false` to keep the previous $SERVICE_SHORT as the default. | +| | `with_password` | - | Set to `true` to include the password for the forked $SERVICE_SHORT in response and connection string.
**WARNING**: never set to `true` unless user explicitly requests the password. | | `service_update_password` | - | - | Update the password for the `tsdbadmin` for this $SERVICE_SHORT. The password change takes effect immediately and may terminate existing connections. | | | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT you want to update the password for. | | | `password` | ✓ | The new password for the `tsdbadmin` user. | From 60c6da7caaa440a0cecb61b461e2a100094a3134 Mon Sep 17 00:00:00 2001 From: billy-the-fish Date: Fri, 31 Oct 2025 13:59:38 +0100 Subject: [PATCH 9/9] chore: update on review. --- _partials/_devops-cli-config-options.md | 15 +++++ _partials/_devops-cli-reference.md | 75 +++++++++++-------------- _partials/_devops-mcp-commands.md | 70 +++++++++++------------ 3 files changed, 83 insertions(+), 77 deletions(-) create mode 100644 _partials/_devops-cli-config-options.md diff --git a/_partials/_devops-cli-config-options.md b/_partials/_devops-cli-config-options.md new file mode 100644 index 0000000000..962e25b6f6 --- /dev/null +++ b/_partials/_devops-cli-config-options.md @@ -0,0 +1,15 @@ + +| 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 | +| `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 | + +You can also set these configuration options as environment variables. Environment variables: +* Take precedence over configuration parameters values. +* Are in upper case and use the `TIGER_` prefix. For example, `TIGER_ANALYTICS` \ No newline at end of file diff --git a/_partials/_devops-cli-reference.md b/_partials/_devops-cli-reference.md index de4c50ea6c..4fe8151ff6 100644 --- a/_partials/_devops-cli-reference.md +++ b/_partials/_devops-cli-reference.md @@ -1,40 +1,41 @@ import GLOBALFLAGS from "versionContent/_partials/_devops-cli-global-flags.mdx"; +import CONFIGOPTIONS from "versionContent/_partials/_devops-cli-config-options.mdx"; ## Commands You can use the following commands with $CLI_LONG. For more information on each command, use the `-h` flag. For example: `tiger auth login -h` -| Command | Subcommand | Description | -|---------|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| auth | | Manage authentication and credentials for your $ACCOUNT_LONG | -| | login | Create an authenticated connection to your $ACCOUNT_LONG | -| | logout | Remove the credentials used to create authenticated connections to $CLOUD_LONG | -| | status | Show your current authentication status and project ID | -| version | | Show information about the currently installed version of $CLI_LONG | -| config | | Manage your $CLI_LONG configuration | -| | show | Show the current configuration | -| | set `` `` | Set a specific value in your configuration. For example, `tiger config set debug true` | -| | unset `` | Clear the value of a configuration parameter. For example, `tiger config unset debug` | -| | reset | Reset the configuration to the defaults. This also logs you out from the current $PROJECT_LONG | -| service | | Manage the $SERVICE_LONGs in this $PROJECT_SHORT | -| | create | Create a new $SERVICE_SHORT in this $PROJECT_SHORT. Possible flags are:
  • `--name`: service name (auto-generated if not provided)
  • `--addons`: addons to enable (time-series, ai, or none for PostgreSQL-only)
  • `--region`: region code where the service will be deployed
  • `--cpu`: CPU allocation in millicores or 'shared'
  • `--memory`: memory allocation in gigabytes or 'shared'
  • `--replicas`: number of high-availability replicas
  • `--no-wait`: don't wait for the operation to complete
  • `--wait-timeout`: wait timeout duration (for example, 30m, 1h30m, 90s)
  • `--no-set-default`: don't set this service as the default service
  • `--with-password`: include password in output
  • `--output, -o`: output format (`json`, `yaml`, `table`)

Allowed CPU/memory configurations are:
  • shared / shared
  • 0.5 CPU (500m) / 2GB
  • 1 CPU (1000m) / 4GB
  • 2 CPU (2000m) / 8GB
  • 4 CPU (4000m) / 16GB
  • 8 CPU (8000m) / 32GB
  • 16 CPU (16000m) / 64GB
  • 32 CPU (32000m) / 128GB
Note: You can specify both CPU and memory together, or specify only one (the other will be automatically configured). | -| | delete `` | Delete a $SERVICE_SHORT from this $PROJECT_SHORT. This operation is irreversible and requires confirmation by typing the service ID | -| | fork `` | Fork an existing service to create a new independent copy. Key features are:
  • Timing options: `--now`, `--last-snapshot`, `--to-timestamp`
  • Resource configuration: `--cpu` (CPU allocation in millicores), `--memory` (memory allocation in gigabytes). Inherits from source service if not specified
  • Naming: `--name `. Defaults to `{source-service-name}-fork`
  • Wait behavior: `--no-wait`, `--wait-timeout`
  • Default service: `--no-set-default`
| -| | get `` (aliases: describe, show) | Show detailed information about a specific $SERVICE_SHORT in this $PROJECT_SHORT | -| | list | List all the $SERVICE_SHORTs in this $PROJECT_SHORT | -| | update-password `` | Update the master password for a $SERVICE_SHORT | -| db | | Database operations and management | -| | connect `` | Connect to a $SERVICE_SHORT | -| | connection-string `` | Retrieve the connection string for a $SERVICE_SHORT | -| | create role `[service-id]` | Create a new database role with optional read-only enforcement. | -| | save-password `` | Save the password for a service | -| | test-connection `` | Test the connectivity to a $SERVICE_SHORT | -| mcp | | Manage $MCP_LONG for AI Assistant integration | -| | install `[client]` | Install and configure $MCP_LONG for a specific client (`claude-code`, `cursor`, `windsurf`, or other). If no client is specified, you'll be prompted to select one interactively | -| | start | Start $MCP_LONG. This is the same as `tiger mcp start stdio` | -| | start stdio | Start $MCP_LONG with stdio transport (default) | -| | start http | Start $MCP_LONG with HTTP transport. Includes flags: `--port` (default: `8080`), `--host` (default: `localhost`) | +| Command | Subcommand | Description | +|---------|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| auth | | Manage authentication and credentials for your $ACCOUNT_LONG | +| | login | Create an authenticated connection to your $ACCOUNT_LONG | +| | logout | Remove the credentials used to create authenticated connections to $CLOUD_LONG | +| | status | Show your current authentication status and project ID | +| version | | Show information about the currently installed version of $CLI_LONG | +| config | | Manage your $CLI_LONG configuration | +| | show | Show the current configuration | +| | set `` `` | Set a specific value in your configuration. For example, `tiger config set debug true` | +| | unset `` | Clear the value of a configuration parameter. For example, `tiger config unset debug` | +| | reset | Reset the configuration to the defaults. This also logs you out from the current $PROJECT_LONG | +| service | | Manage the $SERVICE_LONGs in this $PROJECT_SHORT | +| | create | Create a new $SERVICE_SHORT in this $PROJECT_SHORT. Possible flags are:
  • `--name`: service name (auto-generated if not provided)
  • `--addons`: addons to enable. Possible values are `time-series`, `ai`. Set to `none` for vanille $PG
  • `--region`: region code where the service will be deployed
  • `--cpu`: CPU allocation in millicores. Set to `shared` to create a free service. See the allowed CPU/memory configurations below.
  • `--memory`: memory allocation in gigabytes. Set to `shared` to create a free service. See the allowed CPU/memory configurations below.
  • `--replicas`: number of high-availability replicas
  • `--no-wait`: don't wait for the operation to complete
  • `--wait-timeout`: wait timeout duration (for example, 30m, 1h30m, 90s)
  • `--no-set-default`: don't set this service as the default service
  • `--with-password`: include password in output
  • `--output, -o`: set the output format to `json`, `yaml`, or `table`

Allowed CPU/memory configurations are:
  • shared / shared
  • 0.5 CPU (500m) / 2GB
  • 1 CPU (1000m) / 4GB
  • 2 CPU (2000m) / 8GB
  • 4 CPU (4000m) / 16GB
  • 8 CPU (8000m) / 32GB
  • 16 CPU (16000m) / 64GB
  • 32 CPU (32000m) / 128GB
Note: You can specify both CPU and memory together, or specify only one (the other will be automatically configured). | +| | delete `` | Delete a $SERVICE_SHORT from this $PROJECT_SHORT. This operation is irreversible and requires confirmation by typing the service ID | +| | fork `` | Fork an existing service to create a new independent copy. Key features are:
  • Timing options:
    • `--now`
    • `--last-snapshot`
    • `--to-timestamp`
  • Resource configuration:
    • `--cpu`: CPU allocation in millicores. Set to `shared` to create a free service. See the allowed CPU/memory configurations in the `create` subcommand
    • `--memory`: memory allocation in gigabytes. Set to `shared` to create a free service. If you do not specify this parameter, `--memory` takes the same value as the source service. See the allowed CPU/memory configurations in the `create` subcommand
  • Naming:
    • `--name `: defaults to `{source-service-name}-fork`
  • Wait behavior:
    • `--no-wait`
    • `--wait-timeout`
  • Default service:
    • `--no-set-default`
| +| | get ``
aliases: `describe`, `show` | Show detailed information about a specific $SERVICE_SHORT in this $PROJECT_SHORT | +| | list | List all the $SERVICE_SHORTs in this $PROJECT_SHORT | +| | update-password `` | Update the master password for a $SERVICE_SHORT | +| db | | Database operations and management | +| | connect `` | Connect to a $SERVICE_SHORT | +| | connection-string `` | Retrieve the connection string for a $SERVICE_SHORT | +| | create role `` | Create a new database role. Possible flags are:
  • `--name` (required): the name for the role you are creating
  • `--read-only`: enable permanent read-only enforcement for `--name` using `tsdb_admin.read_only_role`
  • `--from`: inherit grants from one or more roles. For example, `--from app_role`, `--from readonly_role`, `--from app_role,readonly_role`
  • `--statement-timeout`: set the statement timeout for `--name`. For example, `30s`, `5m`
  • `--password`: set the password for `--name`. If not provided, the CLI checks the `TIGER_NEW_PASSWORD` environment variable. If you have not defined `TIGER_NEW_PASSWORD` the CLI auto-generates a secure random password.
  • `-o, --output`: set the output format to `json`, `yaml`, or `table`
| +| | save-password `` | Save the password for a service | +| | test-connection `` | Test the connectivity to a $SERVICE_SHORT | +| mcp | | Manage $MCP_LONG for AI Assistant integration | +| | install `[client]` | Install and configure $MCP_LONG for a specific client (`claude-code`, `cursor`, `windsurf`, or other). If no client is specified, you'll be prompted to select one interactively | +| | start | Start $MCP_LONG. This is the same as `tiger mcp start stdio` | +| | start stdio | Start $MCP_LONG with stdio transport (default) | +| | start http | Start $MCP_LONG with HTTP transport. Includes flags: `--port` (default: `8080`), `--host` (default: `localhost`) | @@ -45,19 +46,9 @@ directory can be adjusted via the `--config-dir` flag or the `TIGER_CONFIG_DIR` - **Configuration options** - All configuration options can be set via `tiger config set `: + You set the following configuration options using `tiger config set `: - - `analytics` - Enable/disable analytics (default: `true`) - - `color` - Enable/disable colored output (default: `true`) - - `debug` - Enable/disable debug logging (default: `false`) - - `docs_mcp` - Enable/disable docs MCP proxy (default: `true`) - - `output` - Output format: `json`, `yaml`, or `table` (default: `table`) - - `password_storage` - Password storage method: `keyring`, `pgpass`, or `none` (default: `keyring`) - - `service_id` - Default service ID - - `version_check_interval` - How often the CLI will check for new versions, 0 to disable (default: `24h`) - - Additionally, all configuration options can also be provided as environment variables. Environment variables use - the `TIGER_` prefix (for example, `TIGER_ANALYTICS`), and take precendence over configuration file values. + - **Global Flags** diff --git a/_partials/_devops-mcp-commands.md b/_partials/_devops-mcp-commands.md index 89fc7e5e67..f2acb7481a 100644 --- a/_partials/_devops-mcp-commands.md +++ b/_partials/_devops-mcp-commands.md @@ -1,42 +1,42 @@ $MCP_LONG exposes the following MCP tools to your AI Assistant: -| Command | Parameter | Required | Description | -|--------------------------|---------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `service_list` | - | - | Returns a list of the $SERVICE_SHORTs in the current $PROJECT_SHORT. | -| `service_get` | - | - | Returns detailed information about a $SERVICE_SHORT. | -| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT (10-character alphanumeric string). | -| | `with_password` | - | Set to `true` to include the password in the response and connection string.
**WARNING**: never do this unless the user explicitly requests the password. | -| `service_create` | - | - | Create a new $SERVICE_SHORT in $CLOUD_LONG.
**WARNING**: creates billable resources. | -| | `name` | - | Set the human-readable name of up to 128 characters for this $SERVICE_SHORT. | -| | `addons` | - | Set the array of [addons][create-service] to enable for the $SERVICE_SHORT. Options:
  • `time-series`: enables $TIMESCALE_DB
  • `ai`: enables the AI and vector extensions
Set an empty array for $PG-only. | -| | `region` | - | Set the [AWS region][cloud-regions] to deploy this $SERVICE_SHORT in. | -| | `cpu_memory` | - | CPU and memory allocation combination.
Available configurations are:
  • shared/shared
  • 0.5 CPU/2 GB
  • 1 CPU/4 GB
  • 2 CPU/8 GB
  • 4 CPU/16 GB
  • 8 CPU/32 GB
  • 16 CPU/64 GB
  • 32 CPU/128 GB
| -| | `replicas` | - | Set the number of [high-availability replicas][readreplica] for fault tolerance. | -| | `wait` | - | Set to `true` to wait for $SERVICE_SHORT to be fully ready before returning. | -| | `timeout_minutes` | - | Set the timeout in minutes to wait for $SERVICE_SHORT to be ready. Only used when `wait=true`. Default: 30 minutes | -| | `set_default` | - | By default, the new $SERVICE_SHORT is the default for following commands in $CLI_SHORT. Set to `false` to keep the previous $SERVICE_SHORT as the default. | -| | `with_password` | - | Set to `true` to include the password for this $SERVICE_SHORT in response and connection string.
**WARNING**: never set to `true` unless user explicitly requests the password. | -| `service_fork` | - | - | Fork an existing $SERVICE_SHORT to create a new independent copy.
**WARNING**: creates billable resources. | -| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT to fork (10-character alphanumeric string). | -| | `fork_strategy` | ✓ | Fork strategy:
  • `NOW`: Fork at current database state
  • `LAST_SNAPSHOT`: Fork at last existing snapshot (faster)
  • `PITR`: Point-in-time recovery to specific timestamp (requires `target_time`)
| -| | `target_time` | - | Target timestamp for point-in-time recovery (RFC3339 format, e.g., `2025-01-15T10:30:00Z`). Only used when `fork_strategy` is `PITR`. | -| | `name` | - | Set the human-readable name for the forked $SERVICE_SHORT. Defaults to `{source-service-name}-fork`. | +| Command | Parameter | Required | Description | +|--------------------------|---------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `service_list` | - | - | Returns a list of the $SERVICE_SHORTs in the current $PROJECT_SHORT. | +| `service_get` | - | - | Returns detailed information about a $SERVICE_SHORT. | +| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT (10-character alphanumeric string). | +| | `with_password` | - | Set to `true` to include the password in the response and connection string.
**WARNING**: never do this unless the user explicitly requests the password. | +| `service_create` | - | - | Create a new $SERVICE_SHORT in $CLOUD_LONG.
**WARNING**: creates billable resources. | +| | `name` | - | Set the human-readable name of up to 128 characters for this $SERVICE_SHORT. | +| | `addons` | - | Set the array of [addons][create-service] to enable for the $SERVICE_SHORT. Options:
  • `time-series`: enables $TIMESCALE_DB
  • `ai`: enables the AI and vector extensions
Set an empty array for $PG-only. | +| | `region` | - | Set the [AWS region][cloud-regions] to deploy this $SERVICE_SHORT in. | +| | `cpu_memory` | - | CPU and memory allocation combination.
Available configurations are:
  • shared/shared
  • 0.5 CPU/2 GB
  • 1 CPU/4 GB
  • 2 CPU/8 GB
  • 4 CPU/16 GB
  • 8 CPU/32 GB
  • 16 CPU/64 GB
  • 32 CPU/128 GB
| +| | `replicas` | - | Set the number of [high-availability replicas][readreplica] for fault tolerance. | +| | `wait` | - | Set to `true` to wait for the $SERVICE_SHORT to be fully ready before returning. | +| | `timeout_minutes` | - | Set the timeout in minutes to wait for $SERVICE_SHORT to be ready. Only used when `wait=true`. Default: 30 minutes | +| | `set_default` | - | By default, the new $SERVICE_SHORT is the default for following commands in $CLI_SHORT. Set to `false` to keep the previous $SERVICE_SHORT as the default. | +| | `with_password` | - | Set to `true` to include the password for this $SERVICE_SHORT in response and connection string.
**WARNING**: never set to `true` unless user explicitly requests the password. | +| `service_fork` | - | - | Fork an existing $SERVICE_SHORT to create a new independent copy.
**WARNING**: creates billable resources. | +| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT to fork (10-character alphanumeric string). | +| | `fork_strategy` | ✓ | Fork strategy:
  • `NOW`: fork at the current database state
  • `LAST_SNAPSHOT`:fork at last existing snapshot. This is the faster option
  • `PITR`: create a point-in-time recovery. You must also set the `target_time` parameter for PITR forks.
| +| | `target_time` | - | Set the target time for a `PIRT` `fork_strategy` in RFC3339 format. For example `2025-01-15T10:30:00Z`). | +| | `name` | - | Set the human-readable name for the forked $SERVICE_SHORT. Defaults to `{source-service-name}-fork`. | | | `cpu_memory` | - | CPU and memory allocation combination. Inherits from source $SERVICE_SHORT if not specified.
Available configurations are:
  • shared/shared
  • 0.5 CPU/2 GB
  • 1 CPU/4 GB
  • 2 CPU/8 GB
  • 4 CPU/16 GB
  • 8 CPU/32 GB
  • 16 CPU/64 GB
  • 32 CPU/128 GB
| -| | `wait` | - | Set to `true` to wait for forked $SERVICE_SHORT to be fully ready before returning. Default: `false`. | -| | `timeout_minutes` | - | Set the timeout in minutes to wait for forked $SERVICE_SHORT to be ready. Only used when `wait=true`. Default: 30 minutes | -| | `set_default` | - | By default, the forked $SERVICE_SHORT is set as the default for following commands in $CLI_SHORT. Set to `false` to keep the previous $SERVICE_SHORT as the default. | -| | `with_password` | - | Set to `true` to include the password for the forked $SERVICE_SHORT in response and connection string.
**WARNING**: never set to `true` unless user explicitly requests the password. | -| `service_update_password` | - | - | Update the password for the `tsdbadmin` for this $SERVICE_SHORT. The password change takes effect immediately and may terminate existing connections. | -| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT you want to update the password for. | -| | `password` | ✓ | The new password for the `tsdbadmin` user. | -| `db_execute_query` | - | - | Execute a single SQL query against a $SERVICE_SHORT. This command returns column metadata, result rows, affected row count, and execution time. Multi-statement queries are not supported.
**WARNING**: can execute destructive SQL including INSERT, UPDATE, DELETE, and DDL commands. | -| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT. Use `tiger_service_list` to find $SERVICE_SHORT IDs. | -| | `query` | ✓ | The SQL query to execute. Single statement queries are supported. | -| | `parameters` | - | Query parameters for parameterized queries. Values are substituted for the `$n` placeholders in the query. | -| | `timeout_seconds` | - | The query timeout in seconds. Default: `30`. | -| | `role` | - | The $SERVICE_SHORT role/username to connect as. Default: `tsdbadmin`. | -| | `pooled` | - | Use [connection pooling][Connection pooling]. This is only available if you have already enabled it for the $SERVICE_SHORT. Default: `false`. | +| | `wait` | - | Set to `true` to wait for the forked $SERVICE_SHORT to be fully ready before returning. Default: `false`. | +| | `timeout_minutes` | - | Set the timeout in minutes to wait for forked $SERVICE_SHORT to be ready. Only used when `wait=true`. Default: 30 minutes | +| | `set_default` | - | By default, the forked $SERVICE_SHORT is set as the default for following commands in $CLI_SHORT. Set to `false` to keep the previous $SERVICE_SHORT as the default. | +| | `with_password` | - | Set to `true` to include the password for the forked $SERVICE_SHORT in response and connection string.
**WARNING**: never set to `true` unless user explicitly requests the password. | +| `service_update_password` | - | - | Update the password for the `tsdbadmin` for this $SERVICE_SHORT. The password change takes effect immediately and may terminate existing connections. | +| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT you want to update the password for. | +| | `password` | ✓ | The new password for the `tsdbadmin` user. | +| `db_execute_query` | - | - | Execute a single SQL query against a $SERVICE_SHORT. This command returns column metadata, result rows, affected row count, and execution time. Multi-statement queries are not supported.
**WARNING**: can execute destructive SQL including INSERT, UPDATE, DELETE, and DDL commands. | +| | `service_id` | ✓ | The unique identifier of the $SERVICE_SHORT. Use `tiger_service_list` to find $SERVICE_SHORT IDs. | +| | `query` | ✓ | The SQL query to execute. Single statement queries are supported. | +| | `parameters` | - | Query parameters for parameterized queries. Values are substituted for the `$n` placeholders in the query. | +| | `timeout_seconds` | - | The query timeout in seconds. Default: `30`. | +| | `role` | - | The $SERVICE_SHORT role/username to connect as. Default: `tsdbadmin`. | +| | `pooled` | - | Use [connection pooling][Connection pooling]. This is only available if you have already enabled it for the $SERVICE_SHORT. Default: `false`. | [cloud-regions]: /use-timescale/:currentVersion:/regions/ [create-service]: /getting-started/:currentVersion:/services/