Documentation Index
Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
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 auth command
This command allows you to login, logout, and refresh your authentication. Auth tokens generated by pscale are valid for one month.
Usage:
pscale auth <SUB-COMMAND> <FLAG>
Available sub-commands
| Sub-Command | Description | Product |
|---|
login | Authenticate with the PlanetScale API | Postgres, Vitess |
logout | Log out of the PlanetScale API | Postgres, Vitess |
check | Check if you are authenticated | Postgres, Vitess |
Available flags
| Flag | Description |
|---|
-h, --help | View help for auth command |
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 login sub-command
Command:
Output:
A new browser tab will open and ask you to sign in via browser if you’re not already signed in. Next, you’ll be asked to confirm the Device confirmation code displayed in your terminal:
Confirmation Code: XXXXXXX
The logout sub-command
Command:
Output:
Press Enter to log out of the PlanetScale API.
The check sub-command
Command:
Output:
If you are not authenticated, exit code 1 will be returned.
Need help?
Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.
