Getting Started

Installation

DB Studio is distributed as an npm package and can be run directly with npx or bunx, no installation required.

npx db-studio

Quick Start

The easiest way is to use your existing .env file:

# .env (or .env.local, .env.development, etc.)
DATABASE_URL=postgresql://user:password@localhost:5432/mydatabase

Then simply run:

npx db-studio

DB Studio will automatically:

1. Load DATABASE_URL from .env
2. Start server on port 3333 (or custom port)
3. Open browser → http://localhost:3333

Useful CLI Options

# Custom port
npx db-studio --port 4000

# Custom .env file
npx db-studio --env .env.local

# Direct connection (no .env needed)
npx db-studio --database-url postgresql://user:pass@localhost:5432/mydb

# Custom env variable name
npx db-studio --var-name PROD_DATABASE_URL

# Just check connection
npx db-studio --status

Migration Guide

From Prisma Studio & Drizzle Studio

"scripts": {
  ...
  "studio": "npx prisma studio"
  "studio": "npx drizzle-kit studio"
  "studio": "npx db-studio"
}

That's it!
DB Studio automatically uses the same DATABASE_URL from your .env file that Drizzle & Prisma uses without any additional configuration, no drizzle.config.ts or prisma.config.ts needed.