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

Open form in Otty otty.toml

Autocomplete

Fig spec, with what the manifest adds · 58 subcommands · 10 options

Published once and never changed; check the digest before caching

sha256

d7c95907a14da7246de9205de09a132add519e46299022e09f0d59deb53ad28c

Size

164546 bytes

Subcommands58 subcommands

pscale audit-log

List audit logs

pscale audit-log list

List all audit logs of an organization

pscale auth

Login and logout via the PlanetScale API

pscale auth login

Authenticate with the PlanetScale API

pscale auth logout

Log out of the PlanetScale API

pscale backup

Create, list, show, and delete branch backups

pscale backup create

Backup a branch's data and schema

pscale backup delete

Delete a branch backup

pscale backup list

List all backups of a branch

pscale backup restore

Restore a backup to a new branch

pscale backup show

Show a specific backup of a branch

pscale branch

Create, delete, diff, and manage branches

pscale branch create

Create a new branch from a database

pscale branch delete

Delete a branch from a database

pscale branch diff

Show the diff of a branch

pscale branch list

List all branches of a database

pscale branch promote

Promote a new branch from a database

pscale branch refresh-schema

Refresh the schema for a database branch

pscale branch schema

Show the schema of a branch

pscale branch show

Show a specific branch of a database

pscale branch switch

Switches the current project to use the specified branch

pscale completion

Generate completion script for your shell

pscale connect

Create a secure connection to a database and branch for a local client

pscale database

Create, read, delete, and dump/restore databases

pscale database create

Create a database instance

pscale database delete

Delete a database instance

pscale database dump

Backup and dump your database

pscale database list

List databases

pscale database restore-dump

Restore your database from a local dump directory

pscale database show

Retrieve information about a database

pscale deploy-request

Create, review, diff, and manage deploy requests

pscale deploy-request close

Close a deploy request

pscale deploy-request create

Create a deploy request from a branch

pscale deploy-request deploy

Deploy a specific deploy request

pscale deploy-request diff

Show the diff of a deploy request

pscale deploy-request list

List all deploy requests for a database

pscale deploy-request review

Review a deploy request (approve, comment, etc...)

pscale deploy-request show

Show a specific deploy request

pscale help

Help about any command

pscale org

List, show, and switch organizations

pscale org list

List the currently active organizations

pscale org show

Display the currently active organization

pscale org switch

Switch the currently active organization

pscale password

Create, list, and delete branch passwords

pscale password create

Create password to access a branch's data

pscale password delete

Delete a branch password

pscale password list

List all passwords of a database

pscale region

List regions

pscale region list

List regions

pscale service-token

Create, list, and manage access for service tokens

pscale service-token add-access

Ddd access to a service token in the organization

pscale service-token create

Create a service token for the organization

pscale service-token delete

Delete an entire service token in an organization

pscale service-token delete-access

Delete access granted to a service token in the organization

pscale service-token list

List service tokens for the organization

pscale service-token show-access

Fetch a service token and it's accesses

pscale shell

Open a MySQL shell instance to a database and branch

pscale signup

Signup for a new PlanetScale account

OptionsOn pscale itself

--help-h

Show help

--api-token

The API token to use for authenticating against the PlanetScale API <string>

--api-url

The base URL for the PlanetScale API. (default "https://api.planetscale.com/") <string>

--config

Config file (default is $HOME/.config/planetscale/pscale.yml) <string>

--debug

Enable debug mode

--format-f

Show output in a specific format. Possible values: [human, json, csv] (default "human") <string>

--no-color

Disable color output

--service-token

Service Token for authenticating <string>

--service-token-name

The Service Token name for authenticating <string>

--version

Show pscale version