mcpField
P
PlanetScale CLI

PlanetScale CLI

公式
planetscale.comデータベース・データ671pscale今日更新
リポジトリ公式サイト

PlanetScale CLI について

pscale は PlanetScale の公式 CLI で、MySQL 互換データベースを管理します。ブランチの作成と管理、デプロイリクエストワークフロー、セキュアなローカル接続、ロールとパスワード管理に対応しています。Git スタイルのブランチ機能により、開発中のデータベーススキーマ変更を安全にテストできます。

主な機能

  1. 01データベースブランチとデプロイリクエストの作成、一覧表示、管理
  2. 02セキュアなローカル接続と対話型シェルセッションのセットアップ
  3. 03データベースロールのパスワード作成とローテーション
  4. 04ブランチ変更をプレビューしてメインとの差分を確認

活用シーン

  1. 01MySQL でデプロイリクエストワークフローを使用してスキーマ変更をテスト
  2. 02認証情報を公開することなく、セキュアなローカルデータベース接続を確立
  3. 03複数環境にわたるデータベースロールとアクセス認証情報を管理

インストール

OS またはパッケージマネージャーを選び、コマンドをターミナルで実行します。

$
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

任意：一部のコマンドを使用するには、pscale の PATH に MySQL 8 Client が必要です。次のコマンドを実行してインストールできます。

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
手動インストール

リリースページからコンパイル済みバイナリをダウンロードし、任意の場所にコピーしてください。

または、macOS、Windows、Linux のすべてのプラットフォームで動作する bin をインストールできます。

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

最新バージョンにアップグレードするには、次のコマンドを実行します。

bin upgrade pscale
コンテナイメージ

すぐに使える Docker コンテナイメージを提供しています。最新のイメージを取得するには、次のコマンドを実行します。

docker pull planetscale/pscale:latest

特定のバージョンを取得するには、次のコマンドを実行します。

docker pull planetscale/pscale:v0.63.0

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"

サービストークンを使用し、疑似端末が必要なコマンドと非対話モードで実行するコマンドを区別できる、より高度な例が必要な場合は、このシェル関数をご覧ください。

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 エージェントや自動化で使用する場合は、pscale agent-guide（またはインストール可能なスキルファイルを取得するには pscale --skill）を実行してください。AGENTS.md をご覧ください。 運用ワークフロー（インベントリ、安全性レビュー、スキーマの推奨事項）には、planetscale/skills をインストールしてください。

コメント

Markdown 対応