https://github.com/prisma/prisma-cli
https://github.com/prisma/prisma-cli
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/prisma/prisma-cli
- Owner: prisma
- License: apache-2.0
- Created: 2026-05-05T09:01:08.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-28T08:14:14.000Z (about 1 month ago)
- Last Synced: 2026-05-28T09:24:53.578Z (about 1 month ago)
- Language: TypeScript
- Size: 519 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# 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
```bash
pnpm add -D @prisma/cli
pnpm prisma-cli --help
```
Example workflow:
```bash
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:
```json
{
"scripts": {
"prisma": "prisma-cli"
}
}
```
Then run:
```bash
pnpm prisma app deploy
```
## Local Development
Requirements:
- Node.js 20+
- pnpm 10+
Install dependencies:
```bash
pnpm install
```
Run the source CLI:
```bash
pnpm prisma --help
```
Run tests:
```bash
pnpm test
pnpm lint:skills
pnpm test:skills
```
`pnpm install` also wires the local skill cluster into supported agent
runtimes, including `.agents/skills/` and `.claude/skills/`.
Build the package:
```bash
pnpm build:cli
```
Stage the npm package locally without publishing:
```bash
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:
```text
prisma
```
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`.
Agent skills for guided Next.js deploys live in `skills/`. Install the cluster
into an app project with:
```bash
pnpm dlx skills@latest add prisma/prisma-cli/skills#cli-v --all
```
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`.
- `@prisma/cli@dev`: latest successful `main` build. Every push to `main`
publishes a unique `3.0.0-dev..` 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.