Skip to content

PlanetScale CLI commands - region

Use the PlanetScale CLI to create development branches, open deploy requests, and make non-blocking schema changes directly from your terminal.

Getting Started

Make sure to first set up your PlanetScale developer environment. Once you've installed the pscale CLI, you can interact with PlanetScale and manage your databases straight from the command line.

The region command

This command lists all available PlanetScale regions.

Usage:

Copied
pscale region <SUB-COMMAND> <FLAG>

Available sub-commands

Sub-commandDescription
listList all regions

Available flags

FlagDescription
-h, --helpView help for region command

Global flags

CommandDescription
--api-token <TOKEN>The API token to use for authenticating against the PlanetScale API.
--api-url <URL>The base URL for the PlanetScale API. Default is https://api.planetscale.com/.
--config <CONFIG_FILE>Config file. Default is $HOME/.config/planetscale/pscale.yml.
--debugEnable debug mode.
-f, --format <FORMAT>Show output in a specific format. Possible values: human (default), json, csv.
--no-colorDisable color output.
--service-token <TOKEN>The service token for authenticating.
--service-token-id <TOKEN_ID>The service token ID for authenticating.

Examples

The region command with list sub-command

Command:

Copied
pscale region list

Output:

Copied
NAME (9) SLUG ENABLED
----------------------------------- -------------------- ---------
AWS us-east-1 (Northern Virginia) us-east Yes
AWS us-west-2 (Oregon) us-west Yes
AWS eu-west-1 (Dublin) eu-west Yes
AWS ap-south-1 (Mumbai) ap-south Yes
AWS ap-southeast-1 (Singapore) ap-southeast Yes
AWS ap-northeast-1 (Tokyo) ap-northeast Yes
AWS eu-central-1 (Frankfurt) eu-central Yes
AWS ap-southeast-2 (Sydney) aws-ap-southeast-2 Yes
AWS sa-east-1 (Sao Paulo) aws-sa-east-1 Yes

Need help?

Get help from the PlanetScale support team, or join our GitHub Discussion board to see how others are using PlanetScale.

Was this page useful?
Last updated on August 1, 2022
Help us improve this page
PrivacyTerms© 2022 PlanetScale Inc.