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.org.cn)

    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 命令后发送信息

以下是正在提交的数据概述

字段	属性	描述
产品	string	产品名称（例如prisma）
版本	string	产品当前安装的版本（例如1.0.0-rc0）
架构	string	客户端操作系统的架构（例如amd64）。
操作系统	string	客户端操作系统（例如darwin）。
node_version	string	客户端的 Node 版本（例如v12.12.0）。
签名	string	随机的、不可识别的签名 UUID（例如91b014df3-9dda-4a27-a8a7-15474fd899f8）
user_agent	string	检查点客户端的用户代理（例如prisma/js-checkpoint）
时间戳	string	请求发生的时间，RFC3339 格式（例如2019-12-12T17:45:56Z）

你可以通过将CHECKPOINT_DISABLE环境变量设置为1来选择退出此行为，例如：

export CHECKPOINT_DISABLE=1

错误报告

当 CLI 崩溃时，Prisma 可能会收集错误数据。

在提交错误报告之前，总是会有一个提示要求你确认或拒绝提交错误报告！未经你的明确同意，绝不会提交错误报告！

如何选择退出数据收集？

使用数据

你可以通过将CHECKPOINT_DISABLE环境变量设置为1来选择退出使用数据收集，例如：

export CHECKPOINT_DISABLE=1

错误报告

你可以通过在交互式提示中回答否来选择退出数据收集。