跳到主内容

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

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

字段属性描述
产品字符串产品名称（例如 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

错误报告​

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

© . All rights reserved.