# Run with npx (no installation needed)
npx hviz

# Or with bunx
bunx hviz

That's it! hviz will guide you through the rest with interactive prompts.

Install globally for quick access:

# npm
npm install -g hviz

# bun
bun install -g hviz

Or add to your project as a dev dependency:

# npm
npm install -D hviz

# bun
bun install -D hviz

Simply run hviz and follow the prompts:

hviz

The CLI will ask you:

1. Which ORM you're using (Prisma, Drizzle, or TypeORM)
2. Path to your schema file (with smart suggestions)

Then it will:

• Parse your schema
• Generate an interactive ERD
• Start a local server
• Open the visualization in your browser

Specify all options directly:

# Prisma
hviz --type prisma --schema prisma/schema.prisma

# Drizzle
hviz --type drizzle --schema drizzle/schema.ts

# TypeORM
hviz --type typeorm --schema typeorm/schema.ts

# Custom port
hviz --type prisma --schema prisma/schema.prisma --port 4000

Please read our Contributing Guidelines for detailed information about

MIT

• Website: hviz.tech
• Author: @husamql3