# k1LoW/tbls

tbls is a CI-Friendly tool to document a database, written in Go.

Repository: https://github.com/k1LoW/tbls
Canonical: https://ross.abutalabs.com/products/tbls
Language: Go
License: MIT
License Family: permissive
Topics: database-schema, mysql, database-document, documentation-tool, postgresql, sqlite, bigquery, spanner, redshift, sqlserver, dynamodb, continuous-integration, markdown, plantuml, excel, er-diagram, mariadb, snowflake, hacktoberfest, mermaid
Last push: 2026-08-26T01:59:24+00:00

## Health v2 (maintenance only)
Score: 97/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 92, longevity 100
- inputs: {"age_days": 3030, "days_push": 8, "days_rel": 53, "gap_med": 9.5, "n_releases_24m": 41}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 4329, forks 209 (observed 2026-08-28T04:08:42.082466+00:00)

## What it is
tbls is a CI-friendly command-line tool written in Go that automatically generates database documentation in GFM/Markdown and other formats, including ER diagrams. It supports many databases (PostgreSQL, MySQL, SQLite, BigQuery, Spanner, DynamoDB, and more) and can also lint database schemas and diff documentation against the live database.

## Use cases
- generate database schema documentation automatically
- document a postgres database as markdown
- create ER diagrams from a database schema
- lint database schema in CI
- diff database schema against documentation
- keep database docs up to date in continuous integration
- generate schema docs for mysql or bigquery

## When to choose
- you want automated, always-fresh database documentation generated in CI
- you need ER diagrams and schema docs across many database engines
- you prefer a single-binary tool with no runtime dependencies

## When to avoid
- you need a hosted or GUI-based data catalog solution
- your database is not among the supported data sources
- you want hand-authored, richly formatted documentation rather than generated output

## Facets
- artifact type: cli-tool
- maturity: active
- function: documentation, database, linter, cli, markdown, developer-tools
- domain: databases, documentation, developer-tools
- platform: windows, cli, go
- tags: database-schema, er-diagram, ci-friendly, schema-documentation, database-linting, single-binary, devops, linux, macos, docker

## Member repositories
- k1LoW/tbls (main) score 97

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:42.082466+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:21:41.067946+00:00, confidence not recorded.
  - readme: https://github.com/k1LoW/tbls (fetched 2026-08-28T04:08:42.082466+00:00, sha 311c378b2882)
- Data as of 2026-08-30T08:39:29.467469+00:00.