Prisma CLI
Prismaコマンドラインインターフェース（CLI）は、コマンドラインからPrismaプロジェクトとやり取りする主要な方法です。新しいプロジェクトアセットの初期化、Prisma Clientの生成、既存のデータベース構造のイントロスペクションによる分析を行い、アプリケーションモデルを自動的に作成できます。
コマンドリファレンス
コマンドの完全なリストについては、Prisma CLIコマンドリファレンスを参照してください。
インストール
Prisma CLIは通常、**開発依存関係**としてローカルにインストールされます。そのため、以下のコマンドでは--save-dev（npm）と--dev（Yarn）オプションが使用されます。
npm
Install with npmでインストール
npm install prisma --save-dev
Yarn
Install with yarnでインストール
yarn add prisma --dev
pnpm
Install with pnpmでインストール
pnpm install prisma --save-dev
Bun
Install with Bunでインストール
bun add prisma
使用方法
Prismaを開発依存関係としてインストールした場合、prismaコマンドの前にパッケージランナーを付ける必要があります。
npm
npx prisma
Yarn
yarn prisma
pnpm
pnpm dlx prisma
Bun
bunx prisma
概要
prismaコマンドは、インストール後にコマンドラインから呼び出すことができます。引数なしで呼び出された場合、コマンドの使用法とヘルプドキュメントが表示されます。
prisma
$ npx prisma
◭ Prisma is a modern DB toolkit to query, migrate and model your database (https://prisma.dokyumento.jp)
Usage
$ prisma [command]
Commands
init Set up Prisma for your app
generate Generate artifacts (e.g. Prisma Client)
db Manage your database schema and lifecycle
migrate Migrate your database
studio Browse your data with Prisma Studio
validate Validate your Prisma schema
format Format your Prisma schema
version Displays Prisma version info
debug Displays Prisma debug info
mcp Starts an MCP server to use with AI development tools
Flags
--preview-feature Run Preview Prisma commands
--help, -h Show additional information about a command
Examples
Set up a new Prisma project
$ prisma init
Generate artifacts (e.g. Prisma Client)
$ prisma generate
Browse your data
$ prisma studio
Create migrations from your Prisma schema, apply them to the database, generate artifacts (e.g. Prisma Client)
$ prisma migrate dev
Pull the schema from an existing database, updating the Prisma schema
$ prisma db pull
Push the Prisma schema state to the database
$ prisma db push
Validate your Prisma schema
$ prisma validate
Format your Prisma schema
$ prisma format
Display Prisma version info
$ prisma version
Display Prisma debug info
$ prisma debug
prismaコマンドのいずれかについて追加のヘルプを得るには、コマンドの後に--helpフラグを追加します。
終了コード
すべてのprisma CLIコマンドは、終了時に以下のコードを返します。
- コマンドが正常に実行された場合は終了コード0
- コマンドでエラーが発生した場合は終了コード1
- CLIがシグナル割り込み（SIGINT）メッセージを受信した場合、またはユーザーがプロンプトをキャンセルした場合は終了コード130。この終了コードはPrisma ORMバージョン4.3.0以降で利用可能です。
テレメトリー
**テレメトリー**という用語は、*ソフトウェアの品質向上*に役立つ特定の利用データを収集することを指します。Prismaは2つのコンテキストでテレメトリーを使用します。
- CLI利用データを収集する場合
- CLIエラーレポートを送信する場合
このページでは、Prismaの全体的なテレメトリーアプローチ、どのようなデータが収集されるか、およびデータ収集をオプトアウトする方法について説明します。
Prismaはなぜメトリクスを収集するのですか？
テレメトリーは、*どれくらいのユーザー*が私たちの製品を使用しているか、そして*どのくらいの頻度で*使用しているかをよりよく理解するのに役立ちます。多くのテレメトリーサービスとは異なり、私たちのテレメトリー実装は意図的に範囲が限定されており、開発者にとって実際に役立ちます。
- **範囲が限定されている**: 私たちはテレメトリーを使用して、1つの質問に答えます。Prisma CLIを使用している月間アクティブ開発者の数はどれくらいですか？
- **価値を提供**: 私たちのテレメトリーサービスは、バージョンアップデートの確認やセキュリティ通知も提供します。
データはいつ収集されますか？
データは、以下に説明する2つのシナリオで収集されます。
利用データ
prisma CLIの呼び出しやStudioの一般的な利用により、https://checkpoint.prisma.ioのテレメトリーサーバーにデータが送信されます。以下の点にご注意ください。
- データには、スキーマやデータベース内のデータは**含まれません**。
- Prismaは、CLIコマンドを実行した後にのみ情報を送信します。
以下は、送信されるデータの概要です。
| フィールド | 属性 | 説明 |
|---|---|---|
product | string | 製品名（例: prisma） |
version | string | 現在インストールされている製品のバージョン（例: 1.0.0-rc0） |
arch | string | クライアントのオペレーティングシステムアーキテクチャ（例: amd64）。 |
os | string | クライアントのオペレーティングシステム（例: darwin）。 |
node_version | string | クライアントのNodeバージョン（例: v12.12.0）。 |
signature | string | ランダムで識別不可能な署名UUID（例: 91b014df3-9dda-4a27-a8a7-15474fd899f8） |
user_agent | string | チェックポイントクライアントのユーザーエージェント（例: prisma/js-checkpoint） |
timestamp | string | RFC3339形式でのリクエスト日時（例: 2019-12-12T17:45:56Z） |
この動作をオプトアウトするには、CHECKPOINT_DISABLE環境変数を1に設定します（例）。
export CHECKPOINT_DISABLE=1
エラー報告
Prismaは、CLIでクラッシュが発生した場合にエラーデータを収集する可能性があります。
エラーレポートが送信される前には、常にエラーレポートの送信を確認または拒否するプロンプトが表示されます！エラーレポートは、お客様の明示的な同意なしに送信されることはありません！
データ収集をオプトアウトする方法は？
利用データ
利用データの収集をオプトアウトするには、CHECKPOINT_DISABLE環境変数を1に設定します（例）。
export CHECKPOINT_DISABLE=1
エラー報告
データ収集をオプトアウトするには、インタラクティブプロンプトに「いいえ」と応答します。