drizzle-docs-generator

Spec sheet

Purpose

The CLI generates Markdown documentation and DBML table definitions from Drizzle ORM schemas.Read 9 Oct 2026 · zenn.dev

Audience

The maker recommends it for Drizzle users who want to keep schema definitions and documentation in sync.Read 9 Oct 2026 · zenn.dev

License

The GitHub repository lists the project under the MIT license.Read 9 Oct 2026 · github.com

CI/CD use

The maker describes incorporating the tool into CI/CD to update documentation when schemas change.Read 9 Oct 2026 · zenn.dev

Database dialects

The documented dialect options are PostgreSQL, MySQL, and SQLite.Read 4 Oct 2026 · github.com

DBML output

The generated DBML can be imported into dbdiagram.io to view ER diagrams and table definitions.Read 9 Oct 2026 · zenn.dev

Installation

The maker documents installation through npm or pnpm, as a development dependency or globally.Read 9 Oct 2026 · zenn.dev

JSDoc comments

JSDoc comments on table and column definitions are included in the generated documentation.Read 9 Oct 2026 · zenn.dev

JSDoc extraction

It extracts JSDoc comments and converts them to DBML notes.Read 4 Oct 2026 · github.com

Markdown output

Markdown output can include a table list, Mermaid ER diagram, and separate documentation for each table.Read 9 Oct 2026 · zenn.dev

Output formats

It generates Markdown by default or DBML, with Markdown output supporting multiple files or a single file and an optional ER diagram.Read 4 Oct 2026 · github.com

Output options

Markdown can be generated as a single file, and its ER diagram can be excluded with an option.Read 9 Oct 2026 · zenn.dev

Relations

The maker says the tool supports both Drizzle relation definition styles, including v0 and v1.Read 9 Oct 2026 · zenn.dev

Schema dialects

The tool supports MySQL, PostgreSQL, and SQLite schema definitions.Read 9 Oct 2026 · zenn.dev

Schema imports

It supports schemas split across multiple files by accepting a schema directory as input.Read 9 Oct 2026 · zenn.dev

Watch mode

Its watch option regenerates documentation when schema files change.Read 4 Oct 2026 · github.com

Where Specifiction places it

• Database Documentation Tools#24 of 276.6