How do I install the Pscale CLI Automation skill?

Run npx skillmds@latest add planetscale/pscale-cli-automation in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Pscale CLI Automation safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Pscale CLI Automation?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Pscale CLI Automation free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Pscale CLI Automation?

planetscale (@planetscale) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Pscale CLI Automation by planetscale

Name: Pscale CLI Automation
Author: 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.

planetscale 068db27 3.4 KB Updated Sep 17, 2026

File contents

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 ../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 ../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": "action_required", follow issues and next_steps 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 ../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.

---name: pscale-cli-automationdescription: 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.---# PlanetScale CLI automation## PurposeTeach agents how to invoke `pscale` non-interactively. This skill covers **CLIconventions only**. Operational workflows (inventory, safety review, schemarecommendations) use the other skills in this repo — start with`../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`../mcp-agent-operating-model/SKILL.md`).## Bootstrap (always start here)```bashpscale agent-guide --format jsonpscale auth check --format json```If `auth check` returns `"status": "action_required"`, follow `issues` and`next_steps` in the JSON. For login, the human may need to approve in thebrowser; 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```bashpscale auth check --format jsonpscale org list --format jsonpscale database list --org <org> --format jsonpscale branch list <database> --org <org> --format jsonpscale sql <database> <branch> --org <org> --format json --query "SELECT 1"```MySQL uses `@primary` by default (same as `pscale shell`); pass `--keyspace` onlyfor 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 enoughInstall the full PlanetScale skills pack (if not already):```shgit clone https://github.com/planetscale/skills.git && cd skills && script/setup# or: npx skills add planetscale/skills -g -y```Then run sub-skills or `../safe-orchestrator/SKILL.md` for database operationsbeyond basic CLI invocation.## Current conventions source of truthPrefer live output over memorized flag syntax:```bashpscale agent-guide --format json```The embedded `guide` field contains the full CLI agent guide shipped with your`pscale` binary.

Frequently asked questions