prisma-cli

Prisma CLI 參考文件

Prisma ORM CLI 指令參考。本技能提供目前 Prisma ORM 版本的指令用法、選項及最佳實務指引。

邊界：Compute

請勿將此技能用於 Prisma Compute 應用程式部署。@prisma/cli app deploy、compute:deploy、create-prisma --deploy、Compute 應用程式、部署、日誌、網域及框架部署就緒狀態，請使用 prisma-compute 技能。

適用時機

在以下情況參考此技能：

• 設定新的 Prisma 專案（prisma init）
• 產生 Prisma Client（prisma generate）
• 執行資料庫遷移（prisma migrate）
• 管理資料庫狀態（prisma db push/pull）
• 使用本機開發資料庫（prisma dev）
• 除錯 Prisma 問題（prisma debug）

依優先順序的規則類別

優先級	類別	影響	前綴
1	設定	高	init
2	產生	高	generate
3	開發	高	dev
4	資料庫	高	db-
5	遷移	關鍵	migrate-
6	工具	中	studio, validate, format, debug, mcp

指令類別

類別	指令	用途
設定	init	啟動新的 Prisma 專案
產生	generate	產生 Prisma Client
驗證	validate, format	Schema 驗證與格式化
開發	dev	本機 Prisma Postgres 開發
資料庫	db pull, db push, db seed, db execute	直接資料庫操作
遷移	migrate dev, migrate deploy, migrate reset, migrate status, migrate diff, migrate resolve	Schema 遷移
工具	studio, mcp, version, debug	開發與 AI 工具

快速參考

專案設定

# 初始化新專案（建立 prisma/ 資料夾與 prisma.config.ts）
prisma init

# 指定資料庫初始化
prisma init --datasource-provider postgresql
prisma init --datasource-provider mysql
prisma init --datasource-provider sqlite

# 使用 Prisma Postgres（雲端）初始化
prisma init --db

# 使用範例模型初始化
prisma init --with-model

Client 產生

# 產生 Prisma Client
prisma generate

# 開發模式監看
prisma generate --watch

# 僅產生特定 generator
prisma generate --generator client

Bun 執行環境

使用 Bun 時，務必加上 --bun 旗標，讓 Prisma 以 Bun 執行環境執行（否則因 CLI shebang 會回退至 Node.js）：

bunx --bun prisma init
bunx --bun prisma generate

本機開發資料庫

# 啟動本機 Prisma Postgres
prisma dev

# 指定名稱啟動
prisma dev --name myproject

# 背景啟動（分離模式）
prisma dev --detach

# 列出所有本機實例
prisma dev ls

# 停止實例
prisma dev stop myproject

# 移除實例資料
prisma dev rm myproject

資料庫操作

# 從現有資料庫拉取 Schema
prisma db pull

# 推送 Schema 至資料庫（不建立遷移）
prisma db push

# 資料庫播種
prisma db seed

# 執行原始 SQL
prisma db execute --file ./script.sql

遷移（開發）

# 建立並套用遷移
prisma migrate dev

# 建立遷移並命名
prisma migrate dev --name add_users_table

# 僅建立遷移不套用
prisma migrate dev --create-only

# 重設資料庫並套用所有遷移
prisma migrate reset

遷移（生產環境）

# 套用待處理遷移（CI/CD）
prisma migrate deploy

# 檢查遷移狀態
prisma migrate status

# 比較 Schema 並產生差異
prisma migrate diff --from-config-datasource --to-schema schema.prisma --script

工具指令

# 開啟 Prisma Studio（資料庫 GUI）
prisma studio

# 啟動 Prisma 的 MCP 伺服器供 AI 工具使用
prisma mcp

# 顯示版本資訊
prisma version
prisma -v

# 除錯資訊
prisma debug

# 驗證 Schema
prisma validate

# 格式化 Schema
prisma format

目前 Prisma CLI 設定

新的設定檔

使用 prisma.config.ts 進行 CLI 設定：

import 'dotenv/config'
import { defineConfig, env } from 'prisma/config'

export default defineConfig({
  schema: 'prisma/schema.prisma',
  migrations: {
    path: 'prisma/migrations',
    seed: 'tsx prisma/seed.ts',
  },
  datasource: {
    url: env('DATABASE_URL'),
  },
})

目前指令行為

• 在 migrate dev、db push 或其他 Schema 同步後，若需要最新的 Client 輸出，請明確執行 prisma generate
• 在 migrate dev 或 migrate reset 後，若需要種子資料，請明確執行 prisma db seed
• 使用 prisma db execute --file ... 執行原始 SQL 腳本

環境變數

在 prisma.config.ts 中明確載入環境變數，通常使用 dotenv：

// prisma.config.ts
import 'dotenv/config'

規則檔案

請參閱個別規則檔案以取得詳細指令文件：

references/init.md           - 專案初始化
references/generate.md       - Client 產生
references/dev.md            - 本機開發資料庫
references/db-pull.md        - 資料庫 introspection
references/db-push.md        - Schema 推送
references/db-seed.md        - 資料庫播種
references/db-execute.md     - 原始 SQL 執行
references/migrate-dev.md    - 開發遷移
references/migrate-deploy.md - 生產遷移
references/migrate-reset.md  - 資料庫重設
references/migrate-status.md - 遷移狀態
references/migrate-resolve.md - 遷移解析
references/migrate-diff.md   - Schema 差異比對
references/studio.md         - 資料庫 GUI
references/mcp.md            - Prisma MCP 伺服器
references/validate.md       - Schema 驗證
references/format.md         - Schema 格式化
references/debug.md          - 除錯資訊

使用方式

使用上述指令類別進行導覽，然後開啟所需的特定指令參考檔案。