PlanetScale CLI for Postgres
To interact with PlanetScale for Postgres and manage your databases, you can use the pscale CLI to do the following:
- Create, delete and list your databases and branches
- Open a secure Postgres shell instance
- Manage database roles and permissions
- ...and more!
Note
pscale can use the PostgreSQL command-line client to quickly open an interactive shell for a database branch. Optional instructions for installing the PostgreSQL client can be found for each platform below.
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 Postgres databases straight from the command line.
Available Commands
Warning
The below pscale commands are for PlanetScale for Postgres databases. To see commands for Vitess/MySQL databases, see PlanetScale CLI.
Use pscale [command] [command] to start up the pscale CLI in your terminal.
| Command | Subcommands/Options | Flags | Description |
|---|---|---|---|
api | --help, --org string, --database string, --branch string, --field key=value, --header stringArray, --input string, --method string, --query key=value | Performs authenticated calls against the PlanetScale API and prints the response to stdout. | |
audit-log | list | --help, --org string | List all audit logs |
auth | login, logout | --help | Authenticate via console |
backup | create, delete, list, restore, show | --help, --org string | Manage branch backups |
branch | create, delete, list, show, switch | --help, --org string | Manage branches |
completion | bash, zsh, fish, powershell | --help | Generate completion script for specified shell |
database | create, delete, dump, list, restore-dump, show | --help | Manage databases |
help | api, audit-log, auth, backup, branch, completion, database, help, mcp, org, ping, region, role, service-token, shell, signup, size | --help | View help for any command |
mcp | install, server | --target string, --help | Install and start an MCP server |
org | list, show, switch | --help | Manage and switch organizations |
ping | --help, --count, -n int, --concurrency int, --provider, -p string --timeout duration | Check latency between your machine and PlanetScale's public regions | |
region | list | --org string | View available regions |
role | create, delete, get, list, renew, reset-default, update | --help, --org string, --inherited-roles string, --ttl duration, --force, --successor string, --name string, --web | Manage Postgres roles |
service-token | add-access, create, delete, delete-access, list, show-access | --help, --org string | Manage access of service tokens |
shell | <database_name> <branch_name> | --help, --local-addr string, --org string, --remote-addr string | Open a Postgres shell instance to the specified database and branch |
signup | --help | Sign up for a new PlanetScale account | |
size | cluster list | --help, --org string, --region string, --metal | View available cluster sizes |
Flags
You may use the following flags with the PlanetScale CLI commands.
| Flag | Description |
|---|---|
--api-token string | The API token to use for authenticating against the PlanetScale API |
--api-url string | The base URL for the PlanetScale API. (default "https://api.planetscale.com/") |
--config string | Config file (default: $HOME/.config/planetscale/pscale.yml) |
--debug | Enable debug mode |
-f, --format string | Show output in specific format. Possible values: [human, json, csv] (default: "human") |
-h, --help | Get more information about a command |
--no-color | Disable color output |
--service-token string | Service Token for authenticating |
--service-token-id string | The Service Token ID for authenticating |
--version | Show pscale version |
Service tokens permissions
A complete list of access permissions available for use with service tokens can be found in the PlanetScale API documentation.
Need help?
Get help from the PlanetScale Support team, or join our GitHub discussion board to see how others are using PlanetScale.