tbls is a documentation tool that automatically generates database schema documentation from live database connections.
The tool solves the problem of keeping database documentation synchronized with actual schema changes. It connects directly to databases, extracts schema information, and generates documentation in multiple formats including Markdown, PlantUML diagrams, Mermaid diagrams, and Excel spreadsheets. The approach works by reading the current state of a database and rendering that information into human-readable documentation, making it suitable for continuous integration pipelines where documentation can be regenerated automatically whenever the schema changes.
The tool supports a wide range of database systems including PostgreSQL, MySQL, MariaDB, SQLite, SQL Server, BigQuery, DynamoDB, Snowflake, Redshift, and Cloud Spanner. It is particularly well-suited for teams that want to maintain up-to-date schema documentation without manual effort, and for projects where documentation needs to stay in sync with schema migrations. The multi-format output means documentation can be embedded in repositories as Markdown, included in presentations via diagram formats, or shared in spreadsheet form depending on audience needs.
Development activity shows consistent engagement with the codebase through regular commits addressing both features and maintenance. The project maintains responsiveness to issues and pull requests, indicating active stewardship. Documentation is kept current and examples are provided to help users get started quickly. The tool receives updates that expand database support and improve diagram generation capabilities.
