Prisma CLI

Beta of the unified Prisma CLI.

This repository contains the unified Prisma command-line experience. The current implementation focuses on app deployment workflows while preserving the long-term command model for Prisma projects, branches, schemas, databases, and apps.

Official beta releases use the primary @prisma/cli package line. The package exposes a prisma-cli binary so it can coexist with the existing prisma executable.

Install

pnpm add -D @prisma/cli
pnpm prisma-cli --help

Example workflow:

pnpm prisma-cli auth login
pnpm prisma-cli app deploy --env DATABASE_URL=postgresql://example
pnpm prisma-cli project env list --role preview

If you want local project scripts that look like the future command shape, add:

{
  "scripts": {
    "prisma": "prisma-cli"
  }
}

Then run:

pnpm prisma app deploy

Local Development

Requirements:

• Node.js 20+
• pnpm 10+

Install dependencies:

pnpm install

Run the source CLI:

pnpm prisma --help

Run tests:

pnpm test

Build the package:

pnpm build:cli

Stage the npm package locally without publishing:

pnpm build:cli
pnpm prepare:cli-publish

Command Model

The CLI groups commands by developer workflow:

• auth
• project
• git
• branch
• app

The canonical command shape is:

prisma <group> <action>

The beta package includes app build, run, deploy, environment-variable, deployment inspection, promotion, rollback, and removal commands. The product model intentionally keeps room for future schema, database, and migration workflows without introducing product-specific namespaces.

Documentation

The public docs start at docs/README.md.

Product behavior is defined in docs/product.

Start here when changing command behavior:

1. docs/product/resource-model.md
2. docs/product/command-principles.md
3. docs/product/command-spec.md
4. docs/product/cli-style-guide.md
5. docs/product/output-conventions.md
6. docs/product/error-conventions.md

See CONTRIBUTING.md for local development and contribution guidance. See ARCHITECTURE.md for the short architecture entrypoint.

The npm package README lives at packages/cli/README.md and is copied into the staged publish artifact.

Community

Issues and feedback are welcome while the CLI is in public beta. Pull requests should be tied to an existing issue or maintainer agreement so product behavior, docs, and tests stay aligned.

Please follow CODE_OF_CONDUCT.md in project spaces. Security reports should use SECURITY.md, not public issues.

Examples

Manual smoke apps live in:

• examples/hello-world
• examples/next-smoke

They are intentionally not part of the root pnpm workspace. Install dependencies inside an example only when you want to run manual end-to-end checks.

Publishing

Publishing happens through the Publish CLI GitHub Actions workflow. Do not publish from a local checkout unless the release owner explicitly asks you to do so.

The committed packages/cli/package.json version is a development placeholder. Release versions are injected by CI when the staged npm package is prepared.

Release channels:

• @prisma/cli / latest: official beta releases. Run Publish CLI manually; it computes the next 3.0.0-beta.N, publishes with the latest dist-tag, and creates cli-v<version>.
• @prisma/cli@dev: latest successful main build. Every push to main publishes a unique 3.0.0-dev.<run_number>.<run_attempt> version with the dev dist-tag. Commit traceability comes from npm provenance and the GitHub Actions run.
• PR preview packages: trusted same-repo pull requests get an installable pkg.pr.new comment for the exact commit. Fork PRs do not publish preview packages automatically. Preview publishing is best-effort and requires the pkg.pr.new GitHub App to be installed for this repository. Once that app is installed, set the repository variable CLI_PR_PREVIEW_REQUIRED=true to make preview publishing failures block CI.

For an official beta release:

1. Run Publish CLI with dry_run: true.
2. Check the computed version and package checks.
3. Run Publish CLI with dry_run: false.

If a release workflow fails after the npm publish step, check npm before rerunning. The package version may already be published even if tag creation failed.