install

Additional install commands

macOS

Homebrewverified · 100%

brew install pscale

local Homebrew formula metadata

Linux

Nixverified · 92%

nix profile install nixpkgs#pscale

nixpkgs package indexes · pkgs/by-name/ps/pscale/package.nix · source: api.github.com

Windows

Windows Package Managerverified · 92%

winget install --id PlanetScale.CLI -e

Windows Package Manager source index · PlanetScale.CLI · source: cdn.winget.microsoft.com

overview

Package summary

CLI for PlanetScale Database

Project links

Commands and aliases

pscale

history

Project history and usage

PlanetScale CLI, invoked as pscale, manages PlanetScale databases and platform resources from interactive terminals, scripts, CI jobs, and agent workflows.

Project history

PlanetScale created pscale as the command-line interface to its managed database platform. The tool grew beyond basic connection commands to cover organizations, databases, branches, deploy requests, backups, workflows, webhooks, service tokens, Postgres roles and passwords, and Vitess-specific operations.

The project later added container distribution, structured output, service-token automation, GitHub Actions integration, and guidance for non-interactive agents.

Adoption history

PlanetScale distributes the CLI as release binaries and packages for macOS, Linux, and Windows, as well as an official container image. Homebrew and Nix coverage is recorded in source_facts.package-manager.

The CLI is also designed for automation: official guidance documents service-token environment variables, machine-readable output, GitHub Actions usage, and agent-oriented commands.

How it is used

Users authenticate interactively with pscale auth login or supply PLANETSCALE_SERVICE_TOKEN_ID and PLANETSCALE_SERVICE_TOKEN for automation. Commands manage databases, branches, deploy requests, organizations, backups, passwords, roles, webhooks, and workflows.

The CLI opens database shells and connections, and pscale sql supports non-interactive queries. The global --config option defaults to $HOME/.config/planetscale/pscale.yml.

Why package nerds care

pscale packages a hosted database control plane into a scriptable Unix-style interface. It is especially notable for exposing PlanetScale's branching and deploy-request concepts alongside conventional database shells and SQL execution, making infrastructure workflows reproducible from terminals and CI systems.

Timeline

2021: Official project discussions documented an available pscale container image.
Later releases: Structured JSON and CSV output, service-token automation, Postgres command families, and agent guidance expanded non-interactive use.
Current direction: The CLI-hosted MCP server is deprecated in favor of the dedicated PlanetScale MCP server.

Related projects

PlanetScale: The managed database service controlled by the CLI.
Vitess: One of the database technologies supported by PlanetScale commands.
PostgreSQL: Supported by current command families alongside Vitess.
MySQL client: Required for certain interactive database commands.
PlanetScale MCP server: The documented successor to the deprecated CLI-hosted MCP mode.

Sources

Input package coverage: source_facts.package-manager
Official CLI documentation: https://planetscale.com/docs/cli
Official CLI repository README: https://github.com/planetscale/cli

security posture

No protected-tool coverage found yet

No matching local secret-handling manifest was found for pscale. Package metadata is still published here so future coverage has a stable package URL.

Install behavior

No Homebrew post-install hook is recorded in formula metadata.
Homebrew bottle metadata is available for 5 platform targets.
Build metadata lists 1 build dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

local files

Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.

Configuration files

Config paths the tool may read or write during local use.

Unix: ~/.config/planetscale/pscale.yml

Credential files

Credential-bearing paths to review before unattended agent runs.

Unix: ~/.config/planetscale/access-token
Windows: ~\.config\planetscale\access-token

executables

Installed executables

Command	Kind	Exposure	Note
`pscale`	cli	global executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-09-19

manager version0.335.0

manager updated2026-09-19

local dataok

upstreamcurrent

latest detectedv0.328.0

https://github.com/planetscale/cli

okNo freshness warnings were generated.

install metadata

Package metadata

Package key	brew:pscale
Version	0.335.0
Package manager	Homebrew
Package manager page	https://formulae.brew.sh/formula/pscale
Homepage	https://www.planetscale.com/
Repository	https://github.com/planetscale/cli
Upstream docs	https://www.planetscale.com/
License	Apache-2.0
Source archive	https://github.com/planetscale/cli/archive/refs/tags/v0.328.0.tar.gz
Last updated	2026-09-19T01:46:45+02:00
Pulse	updated
Build dependencies	go
Bottle	available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, x86_64_linux)
Homebrew post-install	not defined
Service	none declared

registry facts

Source database details

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	pscale
Version Scheme	0
Revision	0
Head Version	HEAD
Bottle Stable Root URL	https://ghcr.io/v2/homebrew/core
Deprecated	no
Disabled	no
Keg Only	no
URL Keys	head stable

source database matches

Other package-manager records

Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.

Nix95%

pscale

nix profile install nixpkgs#pscale

normalized package name match
Matched by: Pscale

nixpkgs package indexes · api.github.com · nixpkgs package indexes: pkgs/by-name/ps/pscale/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

winget95%

PlanetScale.CLI

winget install --id PlanetScale.CLI -e

normalized package name match
Matched by: Pscale

Windows Package Manager source index · cdn.winget.microsoft.com · Windows Package Manager source index: PlanetScale.CLI from https://cdn.winget.microsoft.com/cache/source.msix

package graph

Links come from deterministic package relationships, av.db category and tag curation, ecosystem matches, and package hub membership.

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Combined YAML source

View the package source record on GitHub.

combined/pscale.yml

Used sources

Geiger risk classifier
cross-ecosystem install command graph
curated configuration and credential file locations
curated package history
external package-manager database matches
package relationship graph
package version freshness
package-page enrichment
pkg.so package database
pkgdb category and tag curation

Install pscale with Homebrew, Nix, winget