tbls

Auto document databases.

Visit website ↗

Profile updated

Console’s review

· Reviewed by David Mytton

What we like

Single binary outputs Markdown documentation of your whole database (PG, MySQL, MariaDB, SQLite, BigQuery, & others) with one command. Configurable output format (Markdown, DOT, Mermaid, JSON, even Excel). Can diagram relationships. Includes linting function e.g. require comments. Can diff actual vs documented.

Tradeoffs

It’s a documentation tool, not for migrations or actually creating the tables from scratch from the docs. Limited support for stored procedures and functions.

Is tbls a fit?

Based on Console’s review published on 2023-02-16. Summary updated .

Who it’s for

Database developers should consider this tool for documentation tasks

Why consider it

It can output Markdown documentation of a whole database with one command

Keep in mind

It has limited support for stored procedures and functions

Console is a free weekly newsletter with short reviews of developer tools, covering strengths and tradeoffs. This review reflects Console’s assessment at publication on 2023-02-16. Features and limitations may have changed since the review date. Read our selection criteria and learn about Console.

Tech stack

Integrates with
  • Docker
  • PostgreSQL
Written in
  • Go

Checked

Source and notes

Database documentation tool is written in Go, documents PostgreSQL and distributes Docker images.

View research source ↗

Coverage may be incomplete. “Written in” describes implementation, not supported project languages.

Discover your next favorite tool

Independent devtool reviews and the latest betas, in your inbox every Thursday. Free.