Builderoom

September 28, 2026

Install

通过命令行管理 PlanetScale 数据库的分支、部署请求等操作

Apache-2.0
安装命令(说明)bash
macOS 下通过 Homebrew 安装:
```bash
brew install planetscale/tap/pscale
```
最小用法bash
在 GitHub Actions 中列出部署请求:
```yaml
- name: Setup pscale
  uses: planetscale/setup-pscale-action@v1
- name: Use pscale
  env:
    PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
    PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
  run: |
    pscale deploy-request list my-db --org my-org
```

Product facts

Type
CLI / Terminal
Category
Development & Engineering › Databases and Backend
Pricing
Open source
License
Apache-2.0
Launched
Sep 28, 2026
Listed
Sep 28, 2026
Website
github.com

Overview

GitHubGitHub

PlanetScale CLI(命令为 `pscale`)是 PlanetScale 官方提供的命令行工具,使用 Go 语言编写。它将 PlanetScale 数据库的核心概念——如分支(branches)、部署请求(deploy requests)等——以命令行的形式提供给开发者。 ### 安装方式 该工具支持多种操作系统和安装途径: - **macOS**:通过 Homebrew Tap 安装(`brew install planetscale/tap/pscale`),部分命令需要 PATH 中存在 MySQL 8 Client,可通过 `brew install mysql-client@8.4` 安装。 - **Linux**:从 releases 页面下载 `.deb` 或 `.rpm` 包安装;Arch Linux 用户可使用 AUR 包 `pscale-cli-bin`。 - **Windows**:通过 scoop 安装,需先添加 bucket 再执行 `scoop install pscale mysql`。 - **手动安装**:直接下载预编译二进制文件,或使用跨平台工具 `bin` 安装。 - **容器镜像**:提供 Docker 镜像,可拉取 `planetscale/pscale:latest` 或指定版本,并配置 shell alias 使用。 ### 集成与自动化 - **MCP Server**:支持接入托管的 PlanetScale MCP server。 - **GitHub Actions**:官方提供 `setup-pscale-action`,可在 CI 流程中安装并使用 `pscale`,通过环境变量传入 Service Token 进行认证。 - **AI Agent 支持**:运行 `pscale agent-guide` 或 `pscale --skill` 可获取供 AI agent 和自动化工具使用的技能文件;运维工作流可安装 `planetscale/skills`。 ### 本地开发 仓库内 API client 已 vendor 至 `internal/planetscale/`,不再依赖外部 `planetscale-go` 库。开发者可直接使用 `go run` 或 `go build` 构建和测试。

Key features

  • 分支管理:在命令行中创建和管理 PlanetScale 数据库分支
  • 部署请求:通过 CLI 发起和处理数据库 schema 的部署请求
  • 多平台安装:支持 macOS、Linux、Windows 及 Docker 容器等多种安装方式
  • GitHub Actions 集成:提供 setup-pscale-action 用于 CI/CD 流水线
  • MCP Server 支持:可连接 PlanetScale 托管的 MCP server
  • AI Agent 指南:通过 agent-guide 命令输出供 AI 代理使用的技能文件

Releases

Notify me

Initial · PlanetScale CLI

Q&A

pscale 需要什么前置依赖?AI-generated
在 macOS 上,某些命令要求系统 PATH 中存在 MySQL 8 Client,可通过 brew install mysql-client@8.4 安装。
如何在 GitHub Actions 中使用 pscale?AI-generated
使用官方的 planetscale/setup-pscale-action@v1 安装,并通过 PLANETSCALE_SERVICE_TOKEN_ID 和 PLANETSCALE_SERVICE_TOKEN 环境变量进行认证。
如何为 AI agent 生成指导文件?AI-generated
运行 pscale agent-guide 命令,或使用 pscale --skill 生成可安装的 skill 文件。
Install
Bookmark

This product has no owner yet

It was listed by the platform or its author left. If it is your work, prove your relationship to become the owner.

Claim this product

Alternatives