drizzle-kit studio

drizzle-kit studio command spins up a server for Drizzle Studio hosted on local.drizzle.studio. It requires you to specify database connection credentials via drizzle.config.ts config file.

By default it will start a Drizzle Studio server on 127.0.0.1:4983

// drizzle.config.ts
import { defineConfig } from "drizzle-kit";

export default defineConfig({
  dialect: "cockroach",
  dbCredentials: {
    url: "postgresql://user:password@host:port/dbname"
  },
});

npx drizzle-kit studio

Configuring host and port

By default Drizzle Studio server starts on 127.0.0.1:4983, you can config host and port via CLI options

npx drizzle-kit studio --port=3000
npx drizzle-kit studio --host=0.0.0.0
npx drizzle-kit studio --host=0.0.0.0 --port=3000

yarn drizzle-kit studio --port=3000
yarn drizzle-kit studio --host=0.0.0.0
yarn drizzle-kit studio --host=0.0.0.0 --port=3000

pnpm drizzle-kit studio --port=3000
pnpm drizzle-kit studio --host=0.0.0.0
pnpm drizzle-kit studio --host=0.0.0.0 --port=3000

bunx drizzle-kit studio --port=3000
bunx drizzle-kit studio --host=0.0.0.0
bunx drizzle-kit studio --host=0.0.0.0 --port=3000

Logging

You can enable logging of every SQL statement by providing verbose flag

npx drizzle-kit studio --verbose

yarn drizzle-kit studio --verbose

pnpm drizzle-kit studio --verbose

bunx drizzle-kit studio --verbose

Safari and Brave support

Safari and Brave block access to localhost by default. You need to install mkcert and generate self-signed certificate:

1. Follow the mkcert installation steps
2. Run mkcert -install
3. Restart your drizzle-kit studio

Other flavours of Drizzle Studio

Apart from drizzle-kit studio for local development, Drizzle Studio also comes as a self-hosted Drizzle Gateway, a Chrome extension for serverless database vendors and an embeddable component for your own product — check out the Drizzle Studio overview.

Limitations

Our hosted version Drizzle Studio is meant to be used for local development and not meant to be used on remote (VPS, etc).

If you want to deploy Drizzle Studio to your VPS — that’s what Drizzle Gateway is for.

Is it open source?

No. Drizzle ORM and Drizzle Kit are fully open sourced, while Studio is not.

Drizzle Studio for local development is free to use forever to enrich Drizzle ecosystem, open sourcing one would’ve break our ability to provide B2B offerings and monetise it, unfortunately.