drizzle-docs-generator

drizzle-docs-generator

CLI tool to generate DBML and Markdown documentation from Drizzle ORM schemas. Extracts JSDoc comments and outputs them as Note clauses.

Features:

• Directory Import Support: Import all schema files from a directory
• No File Extension Required: Works with extensionless imports (e.g., import { users } from './users')
• JSDoc Comments: Automatically extracts and converts to DBML Notes
• Relations Support: Generate refs from relations() or defineRelations()
• Watch Mode: Auto-regenerate on file changes
• Multiple Output Formats: Markdown (default) and DBML with ER diagrams

日本語版READMEはこちら

Install

Local Install (recommended)

# As a dev dependency
npm install --save-dev drizzle-docs-generator
# or
pnpm add -D drizzle-docs-generator

# Then use with npx
npx drizzle-docs generate ./src/db/schema.ts -d postgresql

Global Install

npm install -g drizzle-docs-generator
# or
pnpm add -g drizzle-docs-generator

drizzle-docs generate ./src/db/schema.ts -d postgresql

Usage

Basic Usage

# Markdown output (default)
drizzle-docs generate ./src/db/schema.ts -d postgresql -o ./docs

# DBML output
drizzle-docs generate ./src/db/schema.ts -d postgresql -f dbml -o schema.dbml

Output Format Options

#### Markdown Format (Default)

The default output format is Markdown, which generates multiple files with an ER diagram.

Options specific to Markdown format:

| Option | Description | | ----------------- | ------------------------------------------- | | --single-file | Output as a single file instead of multiple | | --no-er-diagram | Exclude ER diagram from output |