Skip to content

PlanetScale CLI commands - auth

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

This command allows you to login, logout, and refresh your authentication.

Usage:

Copied
pscale auth <SUB-COMMAND> <FLAG>

Available sub-commands

Sub-ommandDescription
loginAuthenticate with the PlanetScale API
logoutLog out of the PlanetScale API

Available flags

FlagDescription
-h, --helpView help for auth command

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 login sub-command

Command:

Copied
pscale auth login

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:

Copied
Confirmation Code: XXXXXXX

If they match, click "Confirm code", and you'll be signed in to the CLI.

The logout sub-command

Command:

Copied
pscale auth logout

Output:

Copied
Press Enter to log out of the PlanetScale API.

Need help?

Get help from PlanetScale's support team, or join our GitHub Discussion board to see how others are using PlanetScale.

Was this page useful?
Last updated on May 3, 2022
Help us improve this page
PrivacyTerms© 2022 PlanetScale Inc.