跳到主內容

Prisma CLI

Prisma 命令列介面 (CLI) 是從命令列與 Prisma 專案互動的主要方式。它能夠初始化新的專案資產、生成 Prisma Client,並透過內省分析現有資料庫結構,從而自動建立您的應用程式模型。

命令參考

參見 Prisma CLI 命令參考 以獲取完整的命令列表。

安裝

Prisma CLI 通常作為 開發依賴項 在本地安裝,這就是為什麼在以下命令中使用 --save-dev (npm) 和 --dev (Yarn) 選項的原因。

npm

使用 npm 安裝

npm install prisma --save-dev

Yarn

使用 yarn 安裝

yarn add prisma --dev

pnpm

使用 pnpm 安裝

pnpm install prisma --save-dev

Bun

使用 Bun 安裝

bun add prisma

使用方法

如果您將 Prisma 作為開發依賴項安裝,則需要在 prisma 命令前加上您的包執行器。

npm

npx prisma

Yarn

yarn prisma

pnpm

pnpm dlx prisma

Bun

bunx prisma

概要

一旦安裝,prisma 命令就可以從命令列呼叫。在不帶引數呼叫時,它將顯示其命令用法和幫助文件

prisma
顯示CLI結果
$ npx prisma

◭ Prisma is a modern DB toolkit to query, migrate and model your database (https://prisma.tw)

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

您可以透過在命令後新增 --help 標誌來獲取任何 prisma 命令的額外幫助。

退出程式碼

所有 prisma CLI 命令在退出時返回以下程式碼

  • 命令成功執行時返回退出程式碼 0
  • 命令出錯時返回退出程式碼 1
  • 當 CLI 接收到訊號中斷 (SIGINT) 訊息或使用者取消提示時,返回退出程式碼 130。此退出程式碼在 Prisma ORM 4.3.0 及更高版本中可用。

遙測

術語 遙測 指的是收集某些使用資料,以幫助 提高軟體質量。Prisma 在兩種情況下使用遙測

  • 當它收集 CLI 使用資料時
  • 當它提交 CLI 錯誤報告時

本頁描述了 Prisma 的整體遙測方法、收集的資料型別以及如何選擇退出資料收集。

Prisma 為何收集指標?

遙測幫助我們更好地瞭解 有多少使用者 正在使用我們的產品以及他們 使用我們產品的頻率。與許多遙測服務不同,我們的遙測實現在範圍上是故意受限的,並且實際上對開發者很有用

  • 範圍有限:我們使用遙測來回答一個問題:有多少月活躍開發者正在使用 Prisma CLI?
  • 提供價值:我們的遙測服務還會檢查版本更新並提供安全通知。

何時收集資料?

資料在以下兩種情況下收集。

使用資料

呼叫 prisma CLI 和 Studio 的一般使用會導致資料傳送到遙測伺服器 https://checkpoint.prisma.io。請注意

  • 資料 包含您的 Schema 或資料庫中的資料
  • Prisma 僅在您執行 CLI 命令後傳送資訊

以下是正在提交的資料概覽

欄位屬性描述
產品字串產品名稱(例如 prisma
版本字串當前安裝的產品版本(例如 1.0.0-rc0
架構字串客戶端作業系統架構(例如 amd64)。
作業系統字串客戶端作業系統(例如 darwin)。
node_version字串客戶端的 Node.js 版本(例如 v12.12.0)。
簽名字串隨機的、不可識別的簽名 UUID(例如 91b014df3-9dda-4a27-a8a7-15474fd899f8
user_agent字串檢查點客戶端的使用者代理(例如 prisma/js-checkpoint
時間戳字串請求發生的時間,RFC3339 格式(例如 2019-12-12T17:45:56Z

您可以透過將 CHECKPOINT_DISABLE 環境變數設定為 1 來選擇退出此行為,例如

export CHECKPOINT_DISABLE=1

錯誤報告

當 CLI 發生崩潰時,Prisma 可能會收集錯誤資料。

在提交錯誤報告之前,始終會有一個提示詢問您是確認還是拒絕提交錯誤報告!未經您的明確同意,錯誤報告絕不會提交!

如何選擇退出資料收集?

使用資料

您可以透過將 CHECKPOINT_DISABLE 環境變數設定為 1 來選擇退出使用資料收集,例如

export CHECKPOINT_DISABLE=1

錯誤報告

您可以透過對互動式提示回答來選擇退出資料收集。

© . This site is unofficial and not affiliated with Prisma Data, Inc.