Skip to main content
Prisma Documentation Docs

Search documentation

Type to search this documentation.

On this pageOverview

Choose a Prisma ORM setup path

Start with a quickstart if you want Prisma ORM to create the app. Use the existing-project path if you already have an app and database.

Coming from an earlier version? Coming from Prisma ORM 7 maps every Prisma ORM 7 API to its Prisma ORM 8 form, and Release status says where Prisma ORM 8 stands today.

bun create prisma@latest
Bash
pnpm create prisma@latest
Bash
yarn create prisma@latest
Bash
npm create prisma@latest

The create-prisma reference lists every template and flag.

  • Deploy the full Prisma stack: The whole journey in one sitting: scaffold, Prisma Postgres, first query, and a Prisma Compute deploy.
  • Quickstart with PostgreSQL: Create the app, run it against a local Prisma Postgres from Composer or your own PostgreSQL, and run the first query.
  • Quickstart with MongoDB: Create the app, connect a MongoDB deployment, apply the first migration, and run the first query.
text
Create a new [framework] application with Prisma ORM, seed it, and run it locally.

If I have not told you which framework, stop and ask before scaffolding. Valid --template values: minimal (the default), next, hono, nuxt, astro, nest, svelte, tanstack-start, elysia.

1. Scaffold the app: `npm create prisma@latest -- my-app --template [framework] --provider postgres --yes`.
2. Get a database connection string: use the one I give you, or create a Prisma Postgres database with `npx create-db@latest` and show me the claim URL it prints. Export it as `DATABASE_URL` in the shell; the generated scripts read the environment variable, not `.env`.
3. From the project directory, apply the starter contract: `npm run db:init`. Sample users are seeded automatically on the app's first query; there is no separate seed script.
4. Edit the starter contract under `src/prisma/` into a small schema for my use case, then run `npm run contract:emit` and plan and apply the migration: `npx prisma migration plan`, then `npx prisma db migrate --yes`. Migration planning diffs the emitted contract, so the emit step is required.
5. Update the seed script under `src/prisma/` and the app routes to query the new schema, start `npm run dev` in the background (with `DATABASE_URL` exported), and verify with a request against the running app. For the `nest` template, if routes return 500s with `reading 'findAll'` in the logs, add explicit `@Inject()` tokens as shown in https://www.prisma.io/docs/guides/frameworks/nestjs.md.

Use the installed Prisma ORM skills and the current Prisma docs: https://www.prisma.io/docs/llms.txt (append `.md` to any docs URL for a markdown version).

The create-prisma reference lists every template and flag.

Deploy the full Prisma stack The whole journey in one sitting: scaffold, Prisma Postgres, first query, and a Prisma Compute deploy.Quickstart with PostgreSQL Create the app, run it against a local Prisma Postgres from Composer or your own PostgreSQL, and run the first query.Quickstart with MongoDB Create the app, connect a MongoDB deployment, apply the first migration, and run the first query.

with
Create a new [framework] application with Prisma ORM, seed it, and run it locally.

If I have not told you which framework, stop and ask before scaffolding. Valid --template values: minimal (the default), next, hono, nuxt, astro, nest, svelte, tanstack-start, elysia.

1. Scaffold the app: `npm create prisma@latest -- my-app --template [framework] --provider postgres --yes`.

2. Get a database connection string: use the one I give you, or create a Prisma Postgres database with `npx create-db@latest` and show me the claim URL it prints. Export it as `DATABASE_URL` in the shell; the generated scripts read the environment variable, not `.env`.

3. From the project directory, apply the starter contract: `npm run db:init`. Sample users are seeded automatically on the app's first query; there is no separate seed script.

4. Edit the starter contract under `src/prisma/` into a small schema for my use case, then run `npm run contract:emit` and plan and apply the migration: `npx prisma migration plan`, then `npx prisma db migrate --yes`. Migration planning diffs the emitted contract, so the emit step is required.

5. Update the seed script under `src/prisma/` and the app routes to query the new schema, start `npm run dev` in the background (with `DATABASE_URL` exported), and verify with a request against the running app. For the `nest` template, if routes return 500s with `reading 'findAll'` in the logs, add explicit `@Inject()` tokens as shown in https://www.prisma.io/docs/guides/frameworks/nestjs.md.

Use the installed Prisma ORM skills and the current Prisma docs: https://www.prisma.io/docs/llms.txt (append `.md` to any docs URL for a markdown version).
bunx prisma@latest orm init
Bash
pnpm dlx prisma@latest orm init
Bash
yarn dlx prisma@latest orm init
Bash
npx prisma@latest orm init
  • Add to PostgreSQL: Add Prisma ORM to an existing PostgreSQL app and infer a starter contract from the live schema.
  • Add to MongoDB: Add Prisma ORM to an existing MongoDB app and model the collections you want to query first.
text
Add Prisma ORM to this existing project.

This flow is for PostgreSQL. If the project uses MongoDB, follow https://www.prisma.io/docs/prisma-orm/add-to-existing-project/mongodb.md instead; for other databases, stop and tell me.

1. Run `npx prisma@latest orm init --yes --target postgres --authoring psl` (the flags are required when the CLI cannot prompt). It writes `prisma.config.ts`, a starter contract and `db.ts` under `src/prisma/`, and installs dependencies. Then run `npx prisma skills sync` to install the Prisma ORM skills.
2. Set `DATABASE_URL` in `.env` to my database. If I did not give you one, create a Prisma Postgres database with `npx create-db@latest`, put its connection string in `.env`, and show me the claim URL it prints so I can keep the database.
3. If the database already has tables, infer the contract from it: `npx prisma contract infer`, then `npx prisma contract emit`, then sign it with `npx prisma db sign`. If the database is empty, keep the starter contract and run `npx prisma db init`.
4. Write one query with the generated `db` client in an existing code path, run it, and show me the returned rows.

Follow https://www.prisma.io/docs/prisma-orm/add-to-existing-project/postgresql.md and the installed Prisma ORM skills.

Add to PostgreSQL Add Prisma ORM to an existing PostgreSQL app and infer a starter contract from the live schema.Add to MongoDB Add Prisma ORM to an existing MongoDB app and model the collections you want to query first.

with
Add Prisma ORM to this existing project.

This flow is for PostgreSQL. If the project uses MongoDB, follow https://www.prisma.io/docs/prisma-orm/add-to-existing-project/mongodb.md instead; for other databases, stop and tell me.

1. Run `npx prisma@latest orm init --yes --target postgres --authoring psl` (the flags are required when the CLI cannot prompt). It writes `prisma.config.ts`, a starter contract and `db.ts` under `src/prisma/`, and installs dependencies. Then run `npx prisma skills sync` to install the Prisma ORM skills.

2. Set `DATABASE_URL` in `.env` to my database. If I did not give you one, create a Prisma Postgres database with `npx create-db@latest`, put its connection string in `.env`, and show me the claim URL it prints so I can keep the database.

3. If the database already has tables, infer the contract from it: `npx prisma contract infer`, then `npx prisma contract emit`, then sign it with `npx prisma db sign`. If the database is empty, keep the starter contract and run `npx prisma db init`.

4. Write one query with the generated `db` client in an existing code path, run it, and show me the returned rows.

Follow https://www.prisma.io/docs/prisma-orm/add-to-existing-project/postgresql.md and the installed Prisma ORM skills.
  • Use the generated app scripts for the first run.
  • Open prisma-8.md or the installed Prisma ORM skills when you want agent-ready guidance inside the project.
  • Change the starter contract when you are ready to model your own data.
  • Open the Prisma ORM overview when you want the concepts behind the setup.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu