PlanetScale CLI is a command-line tool for working with PlanetScale databases, including their branches and deploy requests. It is used by developers and database operators managing PlanetScale projects. The catalogue instruction helps coding agents operate PlanetScale through the CLI.
Borrowing it
Nothing to install: this file belongs to planetscale/cli. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/planetscale/cli/main/AGENTS.mdgit clone --depth 1 https://github.com/planetscale/cliWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/instructions/planetscale/cli/agents-md)<a href="https://agentmods.dev/instructions/planetscale/cli/agents-md"><img src="https://agentmods.dev/badge/instructions/planetscale/cli/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/planetscale/cli/agents-md"><img src="https://agentmods.dev/badge/instructions/planetscale/cli/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.19506 | $0.19506 |
| Opus 5.5 | $0.07802 | $0.07802 |
| Sonnet 5.5 | $0.03901 | $0.03901 |
| Haiku 4.5 | $0.01951 | $0.01951 |
Grade A, and why
cli AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 1,104 lines — stays where its author put it; the contents beside it link to each section on GitHub.
PlanetScale CLI — agent guide
For any automated agent or script using pscale. Always pass --format json. Substitute placeholders from the user's request or from prior command output (org list, database list, branch list).
If you only have the installed pscale binary and this guide is not already in your context, load it and check auth:
pscale --skill
pscale auth check --format json
Use direct CLI automation for shell commands and scripts. Use the hosted PlanetScale MCP server for MCP clients.
This file documents how to invoke pscale. For database assessment, safety review, and operational workflows, install the PlanetScale skills pack (planetscale-pscale-cli-automation covers CLI automation; planetscale-safe-orchestrator runs the full review). In application repositories, add a separate project AGENTS.md with org, database, branch, and approval rules (see skill planetscale-mcp-agent-operating-model in that repo).
Public repository safety
This repository is public. Do not include internal or sensitive information in commits, commit messages, pull request titles, or pull request descriptions. Do not name or link private repositories, internal issues or pull requests, Slack conversations, customer details, credentials, or private infrastructure. Include references only when the referenced resource is public.
Concepts
PlanetScale is a serverless database platform for MySQL (via Vitess), PostgreSQL, and Neki (sharded Postgres). Resources are namespaced: an organization (org) owns databases, and each database contains branches — isolated copies of schema (and, for Postgres and Neki, data) that work like git branches. The default branch is typically main (production). Most commands target a database + branch and take --org to say which organization they belong to. Throughout this guide, <org>, <database>, and <branch> are placeholders for those names — pick a branch with "ready": true from branch list.
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 8d ago Changed · +45 lines · +1,015 tokens per session 9230d8ace0ea
- 9d ago Changed · +11 lines · +146 tokens per session 4c3ed2de772e
- 18d ago Changed · +3 lines · +157 tokens per session 189d995dbdc1
- 25d ago Changed · +5 lines · +310 tokens per session 8b0b6d283e1b
- 28d ago Changed · +6 lines · +73 tokens per session 138bc1947a31
- 1mo ago Changed · +14 lines · +275 tokens per session 292195af4c76
- 1mo ago Changed · +8 lines · +164 tokens per session 7995e4510742
- 1mo ago Changed · +16 lines · +416 tokens per session 0c841e47d4f6
- 1mo ago Changed · +37 tokens per session 1854fb69e994
- 1mo ago First seen · 996 lines · 16,913 tokens per session scan A b213886c2f9e
cli AGENTS.md is an instructions file published in the GitHub repository planetscale/cli (671 stars, last pushed yesterday), licensed Apache-2.0. It adds 19,506 tokens to every session, about $0.0780 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.
cli AGENTS.md compared with instructions from other repositories
| Mod | Type | Stars | Last push | Licence | Scan | Tokens | Works with |
|---|---|---|---|---|---|---|---|
| cli AGENTS.mdplanetscale/cli | Instructions file | 671 | yesterday | Apache-2.0 | A | 19,506 | Codex, OpenCode |
| vscode buildNext.instructions.mdmicrosoft/vscode | Instructions file | 195k | yesterday | MIT | A | 9,719 | GitHub Copilot |
| next.js AGENTS.mdvercel/next.js | Instructions file | 143k | yesterday | MIT | A | 7,461 | Codex, OpenCode |
| langchain AGENTS.mdlangchain-ai/langchain | Instructions file | 149k | yesterday | MIT | A | 4,680 | Codex, OpenCode |
| vscode oss-third-party-notices.instructions.mdmicrosoft/vscode | Instructions file | 195k | yesterday | MIT | A | 5,516 | GitHub Copilot |
| vscode copilot-instructions.mdmicrosoft/vscode | Instructions file | 195k | yesterday | MIT | A | 3,093 | GitHub Copilot |
| deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness | Instructions file | 274k | 2d ago | MIT | A | 4,313 | Codex, OpenCode |