cli  by planetscale

CLI tool for PlanetScale database management

created 4 years ago
625 stars

Top 53.7% on sourcepulse

GitHubView on GitHub
Project Summary

The PlanetScale CLI (pscale) provides command-line access to PlanetScale's database management features, including branches and deploy requests. It targets developers and DevOps engineers working with PlanetScale databases, enabling streamlined workflows and integration with AI tools.

How It Works

The CLI is a Go-based application that interacts with the PlanetScale API. A key feature is its Model Context Protocol (MCP) server integration, which allows AI coding assistants like Claude Desktop and Cursor to directly access and query PlanetScale databases. This enables AI to understand database schemas, list tables, and execute SQL queries within the AI's context, enhancing developer productivity.

Quick Start & Requirements

  • Installation: Available via Homebrew (brew install planetscale/tap/pscale), scoop (scoop install pscale), Docker (docker pull planetscale/pscale:latest), or pre-compiled binaries.
  • Prerequisites: macOS and Windows users may need mysql-client@8.4 or mysql respectively.
  • Documentation: planetscale.com/docs

Highlighted Details

  • Integrates with AI tools (Claude Desktop, Cursor) via an MCP server for database context.
  • Supports GitHub Actions via setup-pscale-action@v1.
  • Provides local development commands using go run or compiled binaries.
  • Offers Docker images for easy deployment and execution.

Maintenance & Community

The project is actively maintained by PlanetScale. Community interaction channels are not explicitly listed in the README.

Licensing & Compatibility

The README does not specify a license. Compatibility for commercial use or closed-source linking is not detailed.

Limitations & Caveats

The README does not detail any specific limitations or known bugs. The license is not specified, which may impact commercial adoption.

Health Check
Last commit

1 day ago

Responsiveness

1 day

Pull Requests (30d)
19
Issues (30d)
1
Star History
14 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.