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.
Ready to take these commands for a run on the terminal?
pscale [command] [command] to start up the
pscale CLI in your terminal.
|Performs authenticated calls against the PlanetScale API and prints the response to stdout.|
|List all audit logs|
|Authenticate via console|
|Manage branch backups|
|Generate completion script for specified shell|
|Create a secure connection to the given database and branch|
|Manage deploy requests including gated deployments|
|View help for any command|
|Manage and switch organizations|
|Manage branch credentials|
|View available regions|
|Manage access of service tokens|
|Open a MySQL shell instance to the specified database and branch|
|Sign up for a new PlanetScale account|
You may use the following flags with the PlanetScale CLI commands.
|The API token to use for authenticating against the PlanetScale API|
|The base URL for the PlanetScale API. (default "https://api.planetscale.com/")|
|Config file (default: $HOME/.config/planetscale/pscale.yml)|
|Enable debug mode|
|Show output in specific format. Possible values: [human, json, csv] (default: "human")|
|Get more information about a command|
|Disable color output|
|Service Token for authenticating|
|The Service Token ID for authenticating|
|Show pscale version|
A complete list of access permissions available for use with service tokens can be found in the PlanetScale API documentation.