prisma

Prisma CLI

Quickstart • Commands • Beta notes • Documentation • Support

prisma is the public beta of the new CLI for the Prisma Developer Platform.

It is one binary for the ORM, Composer, and the Prisma Developer Platform: projects, branches, services, service versions, environment variables, and the Prisma ORM schema and migration workflow.

Quickstart

Install the beta package locally:

npm install --save-dev prisma@next

Run the binary exposed by this package:

npx prisma --help
npx prisma auth login
npx prisma project create my-app
npx prisma git connect [e-mail]:owner/repo.git

Deployments start from pushing the connected repository, the Console, or prisma deploy.

With pnpm:

pnpm add -D prisma@next
pnpm prisma auth login
pnpm prisma git connect

Useful next commands:

npx prisma service list
npx prisma service logs
npx prisma project env add DATABASE_URL=postgresql://example --role preview
npx prisma project env add --file .env --role preview
npx prisma project env list
npx prisma project env list --role preview

Commands

Group	What it does
auth	Log in, log out, and inspect the active Prisma account.
project	List, create, link, and manage projects and their environment variables.
git	Connect or disconnect a project from a GitHub repository; pushes deploy.
branch	List Prisma branches for the resolved project.
postgres	Create, inspect, back up, restore, and delete Prisma Postgres databases and their connections.
bucket	Create, list, and delete object-store buckets and their access keys.
service	Inspect services: versions, logs, domains, promote, roll back, delete.
dev, deploy	Run a Composer app locally; deploy it to the platform.
contract, db, migration, orm init, lsp	The Prisma ORM workflow.

Common examples:

npx prisma --version
npx prisma auth whoami
npx prisma project show
npx prisma branch list
npx prisma service list
npx prisma service version promote VERSION_ID

Built for humans, CI, and agents

• Human-readable output by default.
• --json for structured output.
• --no-interactive and --yes for automation.
• PRISMA_SERVICE_TOKEN for headless authenticated commands.
• Stable command groups, flags, and error codes for scripts and agents.
• Environment variable values are not printed back to the terminal.

Beta notes

• Requires Node.js 22.18 or newer.
• This is a release-candidate package and may change quickly.
• The 8.0.0 release candidates publish as prisma on the next dist-tag.
• The package binary is prisma.
• Local project context is cached in .prisma/local.json, which is gitignored and not a declarative repo config file.

Documentation

• CLI docs index
• Command principles
• Output conventions
• Error conventions

Support

Issues and feedback are welcome while the CLI is in public beta. Please use GitHub issues for bug reports and feature requests.

Security reports should follow Prisma's security policy and should not be filed as public issues.

License

Apache-2.0

Similar packages

Other packages similar to prisma

sequelize

Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite, and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication, and more. Compared to Prisma, Sequelize has been around for longer and has a more traditional API, but it might not offer the same level of type safety and simplicity in schema management.

typeorm

TypeORM is an ORM that can run in Node.js, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, and Electron platforms and can be used with TypeScript and JavaScript. TypeORM is highly influenced by other ORMs, such as Hibernate, Doctrine, and Entity Framework. It provides a similar level of type safety as Prisma but with a different approach to defining models and running migrations.

knex

Knex.js is a SQL query builder for Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle, and Amazon Redshift, designed to be flexible, portable, and fun to use. It does not include an ORM by default, but it can be paired with objection.js for ORM functionality. Knex is more of a query builder than a full-fledged ORM and lacks the type safety and model generation features of Prisma.