--- slug: "planetscale-cli-skills-x-6" source_type: "clawhub" source_url: "https://clawhub.ai/skills/planetscale-cli-skills" repo: "" source_file: "description" --- --- name: planetscale-cli-skills description: Comprehensive PlanetScale CLI (pscale) command reference and workflows for database management via terminal. Use when user mentions PlanetScale CLI, pscale commands, database branches, deploy requests, schema migrations, SQL queries, Cloudflare D1 imports, or any PlanetScale terminal operations. Routes to specialized sub-skills for auth, branches, deploy requests, SQL, D1 imports, databases, backups, and other pscale commands. Triggers on pscale, PlanetScale CLI, database branch, deploy request, schema migration, pscale sql, pscale import d1, Cloudflare D1 migration, PlanetScale automation. requirements: binaries: - pscale - jq env_optional: - PLANETSCALE_SERVICE_TOKEN_ID - PLANETSCALE_SERVICE_TOKEN notes: | Requires PlanetScale CLI authentication via 'pscale auth login' (stores token in ~/.config/planetscale/). Automation scripts use jq for structure-aware parsing of pscale JSON output. metadata: openclaw: purpose: > Provide command reference and automation for PlanetScale CLI (pscale) operations only. Scope is limited to: database and branch management, deploy requests, non-interactive SQL queries, Cloudflare D1 imports, backups, passwords, service tokens, and organization management via the pscale CLI tool. capabilities: - Run pscale CLI commands to manage PlanetScale databases, branches, deploy requests, D1 imports, and non-interactive SQL queries - Execute bundled automation scripts (create-branch-for-mr.sh, deploy-schema-change.sh, sync-branch-with-main.sh) - Read PlanetScale CLI output and help users interpret results install_mechanism: > Skill files are loaded into agent context when a matching PlanetScale/pscale task is detected. Automation scripts are executed directly via shell (bash). No network access beyond pscale CLI calls. Scripts do not use eval or dynamic code execution; all pscale arguments are passed as discrete tokens. requires: credentials: - name: PLANETSCALE_SERVICE_TOKEN_ID description: > PlanetScale service token ID for CI/CD authentication. Optional — interactive login via 'pscale auth login' can be used instead. Token stored in environment variable only; this skill does not read, store, or transmit credentials beyond passing them to pscale CLI. required: false - name: PLANETSCALE_SERVICE_TOKEN description: > PlanetScale service token secret for CI/CD authentication. Optional — interactive login via 'pscale auth login' can be used instead. Token stored in environment variable only; this skill does not read, store, or transmit credentials beyond passing them to pscale CLI. required: false --- # PlanetScale CLI Skills Comprehensive `pscale` command reference and workflows for managing PlanetScale databases via terminal. ## Overview The PlanetScale CLI brings database branches, deploy requests, and schema migrations to your fingertips. This skill provides command references, automation scripts, and decision trees for all `pscale` operations. ## Sub-Skills | Command | Skill | Use When | |---------|-------|----------| | **auth** | `pscale-auth` | Login, logout, service tokens, authentication management | | **branch** | `pscale-branch` | Create, delete, promote, diff, list branches, inspect branch infra, manage Postgres size/replicas/parameters, download/query-stream query pattern reports, manage Vitess MoveTables workflows | | **deploy-request** | `pscale-deploy-request` | Create, review, deploy, revert schema changes | | **database** | `pscale-database` | Create, list, show, delete databases | | **sql** | `pscale-sql` | Run non-interactive SQL queries with JSON output and ephemeral credentials | | **import d1** | `pscale-import-d1` | Import Cloudflare D1 SQLite exports into PlanetScale Postgres | | **backup** | `pscale-backup` | Create, list, show, delete branch backups | | **password** | `pscale-password` | Create, list, delete connection passwords | | **org** | `pscale-org` | List, show, switch organizations | | **service-token** | `pscale-service-token` | Create, manage CI/CD service tokens | ## Decision Trees ### Should I use a branch or deploy request? ``` What's your goal? ├─ Experimenting with schema changes → Create branch (pscale-branch) ├─ Testing schema in isolation → Create branch (pscale-branch) ├─ Ready to deploy schema to production → Create deploy request (pscale-deploy-request) └─ Reviewing schema changes before production → Review deploy request (pscale-deploy-request) ``` ### Service token vs password? ``` What's your use case? ├─ CI/CD pipeline → Service token (pscale-service-token) ├─ Local development → Password (pscale-password) ├─ Production application → Service token (rotatable, secure) └─ One-off admin task → Password (temporary) ``` ### Direct promotion vs deploy request? ``` Production readiness? ├─ Immediate promotion (dangerous) → pscale branch promote (pscale-branch) ├─ Review + approval workflow → pscale deploy-request create (pscale-deploy-request) └─ Safe production deployment → Always use deploy requests ``` ## Common Workflows ### Schema Migration Workflow Complete workflow from branch creation to production deployment: ```bash # 1. Create development branch pscale branch create # 2. Make schema changes (via shell, ORM, or direct SQL) pscale shell # 3. View schema diff pscale branch diff # 4. Create deploy request pscale deploy-request create # 5. Review and deploy pscale deploy-request deploy # 6. Verify deployment pscale deploy-request show ``` See `scripts/` directory for automation. ### Branch Development Workflow ```bash # Create branch from main pscale branch create --from main # Work on schema changes pscale shell # Check diff before deploying pscale branch diff # Create deploy request when ready pscale deploy-request create ``` ### CI/CD Integration ```bash # Create service token for CI/CD pscale service-token create --org # Use in CI/CD pipelines (GitHub Actions, GitLab CI, etc.) export PLANETSCALE_SERVICE_TOKEN_ID= export PLANETSCALE_SERVICE_TOKEN= # Create and deploy via CI/CD after review/approval gates pass pscale deploy-request create --format json pscale deploy-request deploy ``` ### Cloudflare D1 to PlanetScale Postgres import ```bash # Lint and dry-run first; review the JSON migration ID and warnings pscale import d1 lint --input ./d1-export.sql --format json pscale import d1 start --input ./d1-export.sql --dry-run --format json # After explicit confirmation, run and verify the import pscale import d1 start --input ./d1-export.sql --migration-id --format json pscale import d1 verify --migration-id --input ./d1-export.sql --format json ``` ## Quick Reference ### Most Common Commands ```bash # Authentication pscale auth login pscale auth logout # Branch management pscale branch create [--from ] pscale branch list pscale branch delete pscale branch parameters list --format json pscale branch resize status --format json # Deploy requests pscale deploy-request create pscale deploy-request list pscale deploy-request deploy # Database operations pscale database create --org pscale database list pscale shell # Non-interactive read query for agents/scripts pscale sql --org --format json --query "SELECT 1" # Cloudflare D1 import dry-run pscale import d1 start --input ./d1-export.sql --dry-run --format json ``` ## Related Skills - **drizzle-kit** - ORM schema management and migrations - **gitlab-cli-skills** - GitLab MR workflow integration - **github** - GitHub PR and CI/CD integration ## Automation Scripts See `scripts/` directory for token-efficient automation: - `create-branch-for-mr.sh` - Create PlanetScale branch matching your MR/PR branch name - `deploy-schema-change.sh` - Complete schema migration workflow - `sync-branch-with-main.sh` - Create a replacement branch from main/base for conflict resolution Scripts execute without loading into context (~90% token savings). ## Resources - Official docs: https://planetscale.com/docs/reference/planetscale-cli - GitHub: https://github.com/planetscale/cli - Community: https://github.com/planetscale/discussion