Skip to content

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.

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 password command

This command allows you to create, list, and delete branch passwords/credentials.

Usage:

Terminal
Copied
pscale password <SUB-COMMAND> <FLAG>

Available sub-commands

Sub-commandSub-command flagsDescription
create <DATABASE_NAME> <BRANCH_NAME> <PASSWORD_NAME>Create new credentials to access a branch's data
delete <DATABASE_NAME> <BRANCH_NAME> <PASSWORD_ID>--forceDelete the specified branch credentials
list <DATABASE_NAME> <BRANCH_NAME>--webList all credentials of a database

The value <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>.

Sub-command flag descriptions

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 flagDescriptionApplicable sub-commands
--role <ROLE>Add a role to a passwordcreate
--forceDelete a password without confirmation.delete
--webPerform the action in your web browserlist

Available roles for the --role flag are:

  • reader
  • writer
  • readwriter
  • admin

Available flags

FlagDescription
-h, --helpView help for password command
--org <ORGANIZATION_NAME>The organization for the current user

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 password command with delete sub-command

Command:

Terminal
Copied
pscale password delete <DATABASE_NAME> <BRANCH_NAME> <PASSWORD_ID>

Output:

Terminal
Copied
? Please type <DATABASE_NAME>/<BRANCH_NAME>/<PASSWORD_ID> to confirm:
Password <PASSWORD_ID> was successfully deleted from <BRANCH_NAME>.

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
© 2022 PlanetScale Inc.