All apps/PlanetScale CLI

PlanetScale CLI

pscale

The pscale command line tool brings branches, deploy requests, and other PlanetScale concepts to your fingertips.

Runs as pscale|macOS, Linux, Windows|github.com

Command form

ai-draft · 3 tasks · 17 fields

Use the subcommand tabs to create databases and branches or open a local connection. Other commands and authentication options are left out.

Opens the form; the finished command lands at your prompt, unrun
otty gui pscale

pscale database create

Create a database
Create a databaseExample values, fixed in this page — nothing here reaches a terminal
Basic
Database name*
string
Region
string
Notes
string
TasksEach one presets the form for one job
Create database
databaseregionnotes
ParametersOnly these flags are editable in the form
Database name
string · positional 0
Region
Region for the database.
string
--region
Notes
string
--notes
Open in browser
boolean
--web
Output format
string
--format-fhumanjsoncsv

pscale branch create

Create a branch
Create a branchExample values, fixed in this page — nothing here reaches a terminal
Basic
Source database*
string
New branch*
string
From branch
string
TasksEach one presets the form for one job
Create branch
databasebranchfrom
ParametersOnly these flags are editable in the form
Source database
string · positional 0
New branch
string · positional 1
From branch
Branch to be created from.
string
--from
Region
string
--region
Backup to restore
string
--restore
Open in browser
boolean
--web-w

pscale connect

Connect locally

Open a secure local proxy to a database branch.

Connect locallyExample values, fixed in this page — nothing here reaches a terminal
Basic
Database*
string
Branch*
string
Local port
string
TasksEach one presets the form for one job
Open proxy
databasebranchport
ParametersOnly these flags are editable in the form
Database
string · positional 0
Branch
string · positional 1
Local port
string
--port
Local host
string
--host
Organization
string
--org
Command to run after connecting
string
--execute
SourcesEvery flag above is checked against these
fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

fig
completion

github.com

Before it fills your prompt, Otty checks the installed pscale against its version. A form that does not match your version is not offered.