mcpField
P
PlanetScale CLI

PlanetScale CLI

官方
planetscale.com数据库与数据671pscale今天更新
代码仓库访问官网

关于 PlanetScale CLI

pscale 是 PlanetScale 的官方命令行工具，用于管理 MySQL 兼容数据库。支持数据库分支、部署请求工作流、安全的本地连接、角色和密码管理。通过 Git 风格的分支管理，可在开发中安全地测试数据库变更。

主要功能

  1. 01创建、列举和管理数据库分支及部署请求
  2. 02设置安全的本地连接和 shell 会话
  3. 03创建和轮换数据库角色密码
  4. 04预览分支变更并与主分支进行 diff

适用场景

  1. 01使用部署请求工作流在 MySQL 数据库中测试 schema 变更
  2. 02在本地开发环境建立安全的数据库连接，无需密码暴露
  3. 03管理多个环境的数据库角色和访问凭证

安装

选择你的系统或包管理器，复制命令到终端运行。

$
brew install planetscale/tap/pscale

安装完成后运行pscale --version确认安装成功。

命令示例

常用命令按使用顺序排列。

01
pscale auth login
02
pscale database list
03
pscale connect my-db main

详细介绍

PlanetScale CLI 构建状态

PlanetScale 不仅仅是一个数据库，我们的 CLI 也不只是一堆命令。pscale 命令行工具让你轻松使用分支、部署请求和其他 PlanetScale 概念。

PlanetScale CLI

安装

macOS

pscale 可通过 Homebrew Tap 安装，也可以从发布页面下载二进制文件：

brew install planetscale/tap/pscale

可选：某些命令需要在 PATH 中安装 MySQL 8 Client 才能运行 pscale。你可以运行以下命令安装：

brew install [email protected]

若要升级到最新版本：

brew upgrade pscale
Linux

pscale 可从发布页面下载二进制文件。从发布页面下载 .deb 或 .rpm 文件，然后分别使用 sudo dpkg -i 和 sudo rpm -i 安装。

Arch：pscale-cli-bin

Windows

pscale 可通过 scoop 安装，也可以从发布页面下载二进制文件：

scoop bucket add pscale https://github.com/planetscale/scoop-bucket.git
scoop install pscale mysql

若要升级到最新版本：

scoop update pscale
手动安装

从发布页面下载预编译的二进制文件，并复制到所需位置。

也可以安装 bin，它适用于所有 macOS、Windows 和 Linux 平台：

bin install https://github.com/planetscale/cli

若要升级到最新版本

bin upgrade pscale
容器镜像

我们提供开箱即用的 Docker 容器镜像。拉取最新镜像：

docker pull planetscale/pscale:latest

拉取指定版本：

docker pull planetscale/pscale:v0.63.0

如果你想创建一个 shell 别名，让你每次输入 pscale 时都通过 docker 运行最新版本的 pscale：

mkdir -p $HOME/.config/planetscale
alias pscale="docker run -e HOME=/tmp -v $HOME/.config/planetscale:/tmp/.config/planetscale --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp planetscale/pscale:latest"

如果你需要更高级的示例，能够使用服务令牌，并区分需要伪终端或非交互模式的命令，请参阅此 shell 函数。

MCP 服务集成

使用托管的 PlanetScale MCP 服务：https://planetscale.com/docs/connect/mcp

GitHub Actions 用法

使用 setup-pscale-action 在 GitHub Actions 中安装并使用 pscale。

- 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

本地开发

运行命令：

go run cmd/pscale/main.go <command>

或者，你可以构建 pscale：

go build cmd/pscale/main.go

然后使用在 cmd/pscale/ 中构建的 pscale 二进制文件进行测试：

./cmd/pscale/pscale <command>

API 客户端位于 internal/planetscale/；此仓库不再依赖 planetscale-go。修改面向 API 的代码前，请阅读 doc/api-client.md。

文档

请查看我们的文档页面：planetscale.com/docs

对于 AI Agent 和自动化任务，运行 pscale agent-guide（或运行 pscale --skill 获取可安装的技能文件）——请参阅 AGENTS.md。 对于运维工作流（清单、安全审查、架构建议），请安装 planetscale/skills。

评论

支持 Markdown