SkillsAdd

planetscale/skills · Official

planetscale-pscale-cli-automation

>- Use the PlanetScale CLI (pscale) from automated agents with --format json, auth check, pscale sql, and per-command --force. Run before other PlanetScale skills when driving pscale directly. Use when the user asks to automate pscale, run CLI commands headless, or verify pscale auth from an agent.

All-time #9411 Trending #5123 First seen Jul 6, 2026
8-week activity · all time api

Installation

$ npx skills add planetscale/skills --skill planetscale-pscale-cli-automation
View on skills.sh ↗ GitHub repository ↗

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

planetscale Similar name
bagelhole/devops-security-agent-skills

Operate MySQL-compatible databases on PlanetScale with branching workflows, safe migrations, an…

212 installs
planetscale-ui-skills Similar name
ihlamury/design-skills

Planetscale's UI design system. Use when building interfaces inspired by Planetscale's aestheti…

203 installs

Also in this package

Other skills from planetscale/skills · top by installs.

npx skills add planetscale/skills
planetscale-query-insights-and-tags 1.1K planetscale-postgres-safety-review 1.2K planetscale-best-practices-matrix 1.2K planetscale-mcp-agent-operating-model 1.2K planetscale-schema-recommendations-agent-loop 1.1K planetscale-safe-orchestrator 1.1K planetscale-autonomous-execution-mode 1.1K planetscale-traffic-control-recommendations 12 planetscale-vitess-safety-review 12 planetscale-readonly-inventory 12

Browse all from planetscale/skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 126
License LICENSE
Default branch main
Open issues 1
Status Active

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 3,538 B
  • docs SUMMARY.md 337 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1,100 installs

SKILL.md

PlanetScale CLI automation

Purpose

Teach agents how to invoke pscale non-interactively. This skill covers CLI conventions only. Operational workflows (inventory, safety review, schema recommendations) use the other skills in this repo — start with ../planetscale-safe-orchestrator/SKILL.md for a full assessment.

Two AGENTS.md files (do not confuse them)

Document Where Purpose
CLI agent guide Shipped with pscale (AGENTS.md in the CLI repo, or pscale agent-guide) How to call pscale: auth, --format json, flag placement, pscale sql
Project agent guide Your application repository's AGENTS.md Which org, database, branch, engine, prod branch, MCP scope, approval rules

Do not edit project AGENTS.md without operator approval (see ../planetscale-mcp-agent-operating-model/SKILL.md).

Bootstrap (always start here)

pscale agent-guide --format json
pscale auth check --format json

If auth check returns "status": "actionrequired", follow issues and nextsteps in the JSON. For login, the human may need to approve in the browser; use pscale auth login --format json.

Conventions

  • Always pass --format json for automation.
  • Put --org <org> on resource subcommands (database, branch, sql,

api, …) — not on root pscale.

  • Put positional arguments before flags (pscale sql mydb main --org bb …).
  • Use pscale sql, not pscale shell (shell requires a TTY).
  • Default SQL role is reader; pass --role admin (or writer/readwriter) for

writes. Match pscale shell semantics for --role and --replica.

  • --force is per subcommand only (e.g. database delete … --force, `pscale

sql … --force). There is no global --force or PSCALE_FORCE`.

  • --format json alone never skips confirmations — add --force on the

destructive subcommand after explicit user approval.

Typical workflow

pscale auth check --format json
pscale org list --format json
pscale database list --org <org> --format json
pscale branch list <database> --org <org> --format json
pscale sql <database> <branch> --org <org> --format json --query "SELECT 1"

MySQL uses @primary by default (same as pscale shell); pass --keyspace only for multi-keyspace databases.

MCP vs CLI

  • MCP clients — use the hosted PlanetScale MCP server (see `pscale agent-guide

--format json` for the current URL).

  • Shell scripts and coding agents — use pscale with --format json as above.

When this skill is not enough

Install the full PlanetScale skills pack (if not already):

git clone https://github.com/planetscale/skills.git && cd skills && script/setup
# or: npx skills add planetscale/skills -g -y

Then run sub-skills or ../planetscale-safe-orchestrator/SKILL.md for database operations beyond basic CLI invocation.

Current conventions source of truth

Prefer live output over memorized flag syntax:

pscale agent-guide --format json

The embedded guide field contains the full CLI agent guide shipped with your pscale binary.