api | | --help, --org string, --database string, --branch string, --field key=value, --header stringArray, --input string, --method string, --query key=value | Vitess, Postgres | Performs authenticated calls against the PlanetScale API and prints the response to stdout. |
audit-log | list | --help, --org string | Vitess, Postgres | List all audit logs |
auth | login, logout | --help | Vitess, Postgres | Authenticate via console |
backup | create, delete, list, restore, show | --help, --org string | Vitess, Postgres | Manage branch backups |
branch | create, delete, diff, keyspaces, list, promote, refresh-schema, schema, show, switch, vschema | --help, --org string | Vitess, Postgres | Manage branches |
completion | bash, zsh, fish, powershell | --help | Vitess, Postgres | Generate completion script for specified shell |
connect | <database_name> <branch_name> | --execute string, --execute-env-url string, --execute-protocol string, --help, --host string, --org string, --port string, --remote-addr string, --role string | Vitess | Create a secure connection to the given database and branch |
database | create, delete, dump, list, restore-dump, show | --help | Vitess, Postgres | Manage databases |
deploy-request | apply, cancel, close, create, deploy, diff, edit, list, revert, review, show, skip-revert | --help | Vitess | Manage deploy requests including gated deployments |
help | audit-log, auth, backup, branch, completion, connect, data-import, database, deploy-request, help, mcp, org, password, ping, region, role, service-token, shell, signup, size, workflow | --help | Vitess, Postgres | View help for any command |
org | list, show, switch | --help | Vitess, Postgres | Manage and switch organizations |
mcp | install, server | --target string, --help | Vitess, Postgres | Install and start an MCP server |
password | create, delete, list | --help, --org string | Vitess | Manage branch credentials |
ping | | --help, --count, -n int, --concurrency int, --provider, -p string --timeout duration | Vitess, Postgres | Check latency between your machine and PlanetScale’s public regions |
region | list | --org string | Vitess, Postgres | 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 | Postgres | Manage Postgres roles |
service-token | add-access, create, delete, delete-access, list, show-access | --help, --org string | Vitess, Postgres | Manage access of service tokens |
size | cluster list | --help, --org string, --region string, --metal | Vitess, Postgres | View available cluster sizes |
shell | <database_name> <branch_name> | --help, --local-addr string, --org string, --remote-addr string | Vitess, Postgres | Open a MySQL shell instance to the specified database and branch |
signup | | --help | Vitess, Postgres | Sign up for a new PlanetScale account |
workflow | cancel, complete, create, cutover, list, retry, reverse-cutover, reverse-traffic, show, switch-traffic, verify-data | --help, --org string | Vitess | Manage the workflows for PlanetScale databases |