drizzle-docs-generator
drizzle-docs-generator is a free, MIT-licensed command-line tool for producing database documentation from Drizzle ORM schemas.
What drizzle-docs-generator is
drizzle-docs-generator is a free, MIT-licensed command-line tool for producing database documentation from Drizzle ORM schemas. It generates Markdown by default or DBML, with Markdown available as one file or multiple files and an optional ER diagram. JSDoc comments on tables and columns become documentation notes. The tool imports schema files from directories, including extensionless imports, and recognizes relations declared with defineRelations() or relations(). If those declarations are unavailable, it can use foreign-key constraints. Watch mode regenerates documentation when schema files change, supporting workflows that keep generated material current. Documented dialects are PostgreSQL, MySQL, and SQLite, covering relational databases. Markdown can include a table list, Mermaid ER diagram, and separate table pages. DBML output can be imported into dbdiagram.io for diagrams and table definitions. The README recommends local installation as a development dependency and also documents global npm or pnpm installation. The project is self-hosted and includes data-dictionary support, making it a focused option for Drizzle users maintaining schema documentation.
Good
- Free and open source under the MIT license
- Generates Markdown or DBML documentation
- Extracts JSDoc comments into documentation
- Detects relations and falls back to foreign keys
- Watch mode refreshes output after schema changes
Watch out
- Focused on Drizzle ORM schemas
- Documented dialects are limited to three databases
- Requires self-hosted installation
Who it suits
This tool suits Drizzle ORM users who want generated documentation and a data dictionary tied to schema definitions. It fits teams that prefer a self-hosted CLI and may use CI/CD or watch mode.
Verdict
drizzle-docs-generator offers a direct CLI workflow for keeping Drizzle schemas documented. Its Markdown, DBML, relation detection, and watch options cover common relational documentation needs without a paid plan.
The facts
Each one read from drizzle-docs-generator's own pages, with the date it was checked.
What it does
- Audience
- The maker recommends it for Drizzle users who want to keep schema definitions and documentation in sync.checked 9 Oct 2026
- CI/CD use
- The maker describes incorporating the tool into CI/CD to update documentation when schemas change.checked 9 Oct 2026
- Database dialects
- The documented dialect options are PostgreSQL, MySQL, and SQLite.checked 4 Oct 2026
- DBML output
- The generated DBML can be imported into dbdiagram.io to view ER diagrams and table definitions.checked 9 Oct 2026
- Installation
- The maker documents installation through npm or pnpm, as a development dependency or globally.checked 9 Oct 2026
- JSDoc comments
- JSDoc comments on table and column definitions are included in the generated documentation.checked 9 Oct 2026
- JSDoc extraction
- It extracts JSDoc comments and converts them to DBML notes.checked 4 Oct 2026
- License
- The GitHub repository lists the project under the MIT license.checked 9 Oct 2026
- Markdown output
- Markdown output can include a table list, Mermaid ER diagram, and separate documentation for each table.checked 9 Oct 2026
- Output formats
- It generates Markdown by default or DBML, with Markdown output supporting multiple files or a single file and an optional ER diagram.checked 4 Oct 2026
- Output options
- Markdown can be generated as a single file, and its ER diagram can be excluded with an option.checked 9 Oct 2026
- Purpose
- The CLI generates Markdown documentation and DBML table definitions from Drizzle ORM schemas.checked 9 Oct 2026
- Relations
- The maker says the tool supports both Drizzle relation definition styles, including v0 and v1.checked 9 Oct 2026
- Schema dialects
- The tool supports MySQL, PostgreSQL, and SQLite schema definitions.checked 9 Oct 2026
- Schema imports
- It supports schemas split across multiple files by accepting a schema directory as input.checked 9 Oct 2026
- Watch mode
- Its watch option regenerates documentation when schema files change.checked 4 Oct 2026
Alternatives to drizzle-docs-generator
- 1
MySQL
Free planAPILinuxmacOSSelf-hosted7.9Free plan - 2
Azimutt
Free planOpen sourceWebAPIExtensionLinux7.8From €7 a month - 3
DBDock
Free planOpen sourceWebAPILinuxmacOS7.5Free plan - 4
dbt Semantic Layer
Free planWebAPIExtension7.5From $100 a month - 5
DbSchema
Free planLinuxmacOSWindows7.0From $29.40 a month - 6
dbdocs
Free planWebLinuxmacOSWindows6.9From $20 a month