TiloBox
Back to directory
tbls project preview

tbls

CI-friendly tool for generating comprehensive database documentation and ER diagrams.

LicenseMIT
GitHub stars3.8k
Last commit1 weeks ago
Tags5 topics
Ci Schema Doc GeneratorDatabase Documentation ToolTbls DatabaseDeveloper ToolsEr Diagram Generator
Overview

Why consider tbls?

tbls is an open-source database documentation generator written in Go by Ken’ichirō Oyama (k1LoW). tbls inspects PostgreSQL, MySQL, SQLite, BigQuery, and ClickHouse schemas, compiling searchable Markdown documentation and PlantUML/Mermaid entity-relationship diagrams for CI/CD pipelines.

Guided learning

Learn tbls by building

Practical setup notes, real use cases, and copy-ready examples in one focused guide.

1 min read 2 sections
In this guide2 sections

Overview of tbls

tbls generates automated Markdown documentation and ER visual diagrams from live database schemas.

Quickstart

bash
1go install github.com/k1LoW/tbls@latest
2tbls doc postgres://user:password@localhost:5432/dbname schema_docs/

tbls is licensed under the permissive MIT License.

Related tools

More options with a similar category or technology profile.

tbls FAQs

tbls is listed as a Developer Tools tool on TiloBox. Review the overview, features, and official documentation on this page to decide whether it solves your specific workflow.

Start with the project's GitHub repository for supported installation and deployment instructions. Test the setup with representative data or a small project before rolling it out more widely.

tbls is listed under the MIT license. Read the complete license text and the project's notices before using, modifying, or distributing the software.

Production readiness depends on your requirements. Review maintenance activity, security practices, documentation, backup and upgrade procedures, and compatibility with your stack; then validate it in a non-production environment.

tbls is listed as an alternative to SchemaSpy. Compare the core workflow, deployment model, integrations, and licensing against your must-have requirements before switching.