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 service-token command
This command allows you to create, list, and manage access for service tokens.
Usage:
Terminal
Copied
pscale service-token <SUB-COMMAND> <FLAG>
Available sub-commands
| Sub-command | Sub-command flags | Description |
|---|---|---|
add-access <TOKEN_ID> <PERMISSION> <PERMISSION> | --database <DATABASE_NAME> | Add individual permissions to the specified service token in the organization |
create | Create a service token for the organization | |
delete <TOKEN_ID> | Delete an entire service token in an organization | |
delete-access <TOKEN_ID> <PERMISSION> <PERMISSION> | --database <DATABASE_NAME> | Delete individual permissions granted to a service token in the organization |
list | List the IDs of an organization's service tokens | |
show-access | Fetch a service token and its accesses |
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 flag | Description | Applicable sub-commands |
|---|---|---|
--database <DATABASE_NAME> | The database this project is using. | add-access, delete-access |
Available flags
| Flag | Description |
|---|---|
-h, --help | View help for service-token command |
--org <ORGANIZATION_NAME> | The organization for the current user |
Global flags
| Command | Description |
|---|---|
--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. |
--debug | Enable debug mode. |
-f, --format <FORMAT> | Show output in a specific format. Possible values: human (default), json, csv. |
--no-color | Disable color output. |
--service-token <TOKEN> | The service token for authenticating. |
--service-token-id <TOKEN_ID> | The service token ID for authenticating. |
Examples
The service-token command with add-access sub-command and --database flag
Command:
Terminal
Copied
pscale service-token add-access <TOKEN_ID> read_branch delete_branch create_branch --database <DATABASE_NAME_2>
This will add the following permissions to the specified access token: read_branch, delete_branch, create_branch. The output will show the updated permissions on all databases.
You can find a list of all permissions in our Access control doc.
Output:
| DATABASE | ACCESSES |
|---|---|
| DATABASE_NAME | approve_deploy_request, connect_branch, connect_production_branch, create_branch, create_comment, create_deploy_request, delete_branch, read_branch, read_comment, read_deploy_request |
| DATABASE_NAME_2 | read_branch, delete_branch, create_branch |