PlanetScale CLI commands - password
Use the PlanetScale CLI to create development branches, open deploy requests, and make non-blocking schema changes directly from your terminal.
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.
This command allows you to create, list, and delete branch passwords/credentials.
pscale password <SUB-COMMAND> <FLAG>
|Create new credentials to access a branch's data|
|Delete the specified branch credentials|
|List all credentials of a database|
<PASSWORD_ID> represents the ID number of the set of credentials. To find all available credentials and their IDs, run
pscale list <DATABASE_NAME> <BRANCH_NAME>.
Some of the sub-commands have additional flags unique to the sub-command. This section covers what each of those does. See the above table for which context.
|Sub-command flag||Description||Applicable sub-commands|
|Add a role to a password|
|Delete a password without confirmation.|
|Perform the action in your web browser|
Available roles for the
--role flag are:
|View help for |
|The organization for the current user|
|The API token to use for authenticating against the PlanetScale API.|
|The base URL for the PlanetScale API. Default is |
|Config file. Default is |
|Enable debug mode.|
|Show output in a specific format. Possible values: |
|Disable color output.|
|The service token for authenticating.|
|The service token ID for authenticating.|
pscale password delete <DATABASE_NAME> <BRANCH_NAME> <PASSWORD_ID>
? Please type <DATABASE_NAME>/<BRANCH_NAME>/<PASSWORD_ID> to confirm: Password <PASSWORD_ID> was successfully deleted from <BRANCH_NAME>.