Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 48 KB

File metadata and controls

79 lines (63 loc) · 48 KB

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 <key> <value> Set a specific value in your configuration. For example, tiger config set debug true
unset <key> 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 <service-id> Delete a $SERVICE_SHORT from this $PROJECT_SHORT. This operation is irreversible and requires confirmation by typing the service ID
fork <service-id> 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 <name>: defaults to {source-service-name}-fork
  • Wait behavior:
    • --no-wait
    • --wait-timeout
  • Default service:
    • --no-set-default
get <service-id>
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 <service-id> Update the master password for a $SERVICE_SHORT
start <service-id> Start a $SERVICE_SHORT that is currently inactive. Possible flags are:
  • --no-wait: don't wait for the operation to complete
  • --wait-timeout: set the maximum wait time for this operation to complete. For example, 10m (default), 30m, 1h30m, 90s
stop <service-id> Stop a $SERVICE_SHORT that is currently active. After you run this command <service-id> no longer accepts connections. Possible flags are:
  • --no-wait: don't wait for the operation to complete
  • --wait-timeout: set the maximum wait time for this operation to complete. For example, 10m (default), 30m, 1h30m, 90s
db Database operations and management
connect <service-id> Connect to a $SERVICE_SHORT
connection-string <service-id> Retrieve the connection string for a $SERVICE_SHORT
create role <service-id> 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 <service-id> Save the password for a service
test-connection <service-id> 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)

Configuration parameters

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.

  • Configuration options

    You set the following configuration options using tiger config set <key> <value>:

  • Global Flags

    These flags are available on all commands and take precedence over both environment variables and configuration file values:

  • Authentication parameters

    To authenticate without using the interactive login, either:

    • Set the following parameters with your client credentials, then login:
      TIGER_PUBLIC_KEY=<public_key> TIGER_SECRET_KEY=<secret_key> TIGER_PROJECT_ID=<project_id>\
      tiger auth login
    • Add your client credentials to the login command:
      tiger auth login --public-key=<public_key> --secret-key=<secret-key> --project-id=<project_id>