hviz logo

hviz

CLI tool for visualizing your database schema

Getting Started

Install hviz and visualize your database schema in seconds

Install

Add hviz to your project as a dev dependency

Install
# npmnpm install -D hviz# yarnyarn add -D hviz# pnpmpnpm install -D hviz# bunbun install -D hviz

Run

Start hviz with interactive prompts or specify options directly

Run
# Run with interactive promptsbunx hviz# Run with non-interactive modebunx hviz --type prisma --schema prisma/schema.prisma# Run with custom portbunx hviz --port 4000# Run with all optionsbunx hviz --type prisma --schema prisma/schema.prisma --port 4000

Add to Scripts

Add hviz to your package.json scripts for quick access

package.json
{  "scripts": {    // prisma    "visualize": "hviz --type prisma --schema prisma/schema.prisma --port 4000",    // drizzle    "visualize": "hviz --type drizzle --schema drizzle/schema.ts --port 4000",    // typeorm    "visualize": "hviz --type typeorm --schema typeorm/schema.ts --port 4000",  }}