Installation

To use the generator, you need to install the package along with its peer dependencies: @mermaid-js/mermaid-cli (for generating the diagrams) and puppeteer (used by mermaid-cli).

1. Install Dependencies

Using npm:

npm i -D prisma-erd-generator @mermaid-js/mermaid-cli puppeteer

Using yarn:

yarn add -D prisma-erd-generator @mermaid-js/mermaid-cli puppeteer

Using pnpm:

pnpm add -D prisma-erd-generator @mermaid-js/mermaid-cli puppeteer

2. Add to Prisma Schema

Add the generator block to your prisma/schema.prisma file:

generator erd {
  provider = "prisma-erd-generator"
}

3. Generate

Run the Prisma generate command to create your first diagram:

npx prisma generate

By default, this will create an ERD.svg file in your prisma directory.

Version Compatibility

Ensure you are using the correct version of the generator for your Prisma version:

  • Prisma >= 5: Use prisma-erd-generator version 2.x.x
  • Prisma = 4: Use prisma-erd-generator version 1.x.x
  • Prisma < 4: Use prisma-erd-generator version 0.11.x