Skip to main content

​
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 agent-guide command

Shows guidance for AI agents and automation using pscale. Use --format json for a machine-readable bootstrap response with conventions, hosted MCP details, skills install commands, and suggested next steps. Use --skill to print the same guide as an installable skill file. pscale --skill on the root command prints that skill file and exits.
Requires pscale 0.292.0 or later. Install or upgrade with brew install pscale or brew upgrade pscale.
For a copy-paste agent setup prompt, see Agent setup prompt (Markdown export). Usage:

​
JSON response fields

--skill writes a YAML-frontmatter skill file to stdout and skips this JSON object. Use pscale agent-guide --skill or pscale --skill when you need the installable skill rather than the bootstrap response.

​
Available flags

​
Examples

Human-readable output (default):
Installable skill file:

​
Need help?

Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.