# Install tbls with Homebrew, MacPorts, Nix

CI-Friendly tool to document a database. Version 1.95.0 via Homebrew; verified 2026-07-26. Also installable with nix: nix profile install nixpkgs#tbls.

## Install

```sh
sudo av install brew:tbls
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install tbls
```

  Evidence: local Homebrew formula metadata

- MacPorts (94%):

```sh
sudo port install tbls
```

  Evidence: MacPorts ports tree: databases/tbls/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1

### Linux

- Nix (92%):

```sh
nix profile install nixpkgs#tbls
```

  Evidence: nixpkgs package indexes: pkgs/by-name/tb/tbls/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

## Package facts

- **Package key:** brew:tbls
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/tbls>
- **Version:** 1.95.0
- **Source summary:** CI-Friendly tool to document a database
- **Homepage:** <https://github.com/k1LoW/tbls>
- **Repository:** <https://github.com/k1LoW/tbls>
- **License:** MIT
- **Source archive:** <https://github.com/k1LoW/tbls/archive/refs/tags/v1.95.0.tar.gz>
- **Last updated:** 2026-07-26T00:50:33+02:00
- **Generated:** 2026-08-04T22:13:35+00:00

## Executables

- tbls (cli)
- tbls (alias)

## Build dependencies

- go

## Install behavior

- Post-install hook: not defined
- Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## Freshness

- Page generated: 2026-08-04
- Package-manager version: 1.95.0
- Package-manager updated: 2026-07-26
- Local data: ok
- Upstream repository: https://github.com/k1LoW/tbls
- Upstream latest detected: v1.95.0 (current)
## Project history and usage

tbls is a Go command-line tool for generating, linting, and diffing database documentation in CI-friendly workflows.

### Project history

The official repository was created in 2018 and describes tbls as a CI-Friendly tool to document a database. Its README highlights automatic GitHub Flavored Markdown output, multiple output formats, many supported databases, single-binary distribution, and use as a database linter.

The project grew around a repository-centered documentation workflow: add .tbls.yml or tbls.yml, run tbls doc, commit the generated schema docs, and let CI check documentation drift.

### Adoption history

By 2026, official GitHub metadata showed several thousand stars and more than two hundred forks. The input package metadata lists Homebrew, MacPorts, and Nix packages, and the README documents additional installation routes including deb, RPM, Go install, Docker, aqua, and GitHub Actions.

### How it is used

A typical user points tbls at a database DSN, generates Markdown documentation, and commits both the config and generated docs. The README also documents tbls diff for schema/document drift and linting rules for database quality checks.

### Why package nerds care

tbls is interesting to package nerds because it treats database documentation as a reproducible CLI artifact. Its single-binary Go distribution, package-manager availability, and GitHub Actions setup make it easy to pin in CI and run alongside migrations or schema review.

### Timeline

- 2018: GitHub repository created.
- 2021: GitHub release metadata shows the 1.53 and 1.54 series.
- 2026: GitHub release metadata lists the 1.94 series.

### Related projects

- tbls integrates with many database backends through DSNs, including PostgreSQL, MySQL, MariaDB, SQLite, BigQuery, Cloud Spanner, Redshift, SQL Server, DynamoDB, Snowflake, MongoDB, ClickHouse, Databricks, JSON, HTTP, and GitHub-backed schema sources.

### Sources

- <https://api.github.com/repos/k1LoW/tbls>
- <https://api.github.com/repos/k1LoW/tbls/releases>
- <https://github.com/k1LoW/tbls#readme>
- input.source_facts.package-manager


## Security Notes

broad file, network, media, or database tool signal.

- **Geiger risk:** blue / medium
- broad file, network, media, or database tool signal


## Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.


## Configuration files

- Unix: .tbls.yml, tbls.yml

## Credential files

- Unix: .tbls.yml, tbls.yml
## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** tbls
- **Version Scheme:** 0
- **Revision:** 0
- **Head Version:** HEAD
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** head, stable

## Other Package-Manager Records

- Nix - tbls: normalized package name match | nixpkgs package indexes: pkgs/by-name/tb/tbls/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
- MacPorts - tbls: normalized package name match | MacPorts ports tree: databases/tbls/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1


## Related links

- [Source-control packages](https://pkg.so/source-control-tools/) - Belongs to a source-control command family.
- [Secret-risk packages](https://pkg.so/secret-risk-packages/) - Has protected-tool coverage, approval-gate, or non-low Geiger security signals.
- [Terminal utility packages](https://pkg.so/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://pkg.so/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [go](https://pkg.so/brew/go/) - Build dependency declared by Homebrew.
- [bee](https://pkg.so/brew/bee/) - Shares pkgdb curated category or tags: cli, data, database, schema.
- [sqlite](https://pkg.so/brew/sqlite/) - Shares pkgdb curated category or tags: cli, data, database.
- [protobuf](https://pkg.so/brew/protobuf/) - Shares pkgdb curated category or tags: cli, data, schema.
- [redis](https://pkg.so/brew/redis/) - Shares pkgdb curated category or tags: cli, data, database.
- [gdbm](https://pkg.so/brew/gdbm/) - Shares pkgdb curated category or tags: cli, data, database.
- [mysql](https://pkg.so/brew/mysql/) - Shares pkgdb curated category or tags: cli, data, database.
- [postgresql@14](https://pkg.so/brew/postgresql-14/) - Shares pkgdb curated category or tags: cli, data, database.
- [postgresql@16](https://pkg.so/brew/postgresql-16/) - Shares pkgdb curated category or tags: cli, data, database.
- [schemalint](https://pkg.so/npm/schemalint/) - Local metadata places this package in an adjacent workflow. Shared terms: cli, data, database, schema.
- [gh-ost](https://pkg.so/brew/gh-ost/) - Local metadata places this package in an adjacent workflow. Shared terms: cli, data, database, schema.

## Combined YAML source

View the package source record on GitHub. [combined/tbls.yml](https://github.com/mxcl/pkgdb/blob/main/combined/tbls.yml)


## Sources

- pkg.so package database
- Geiger risk classifier
- package-page enrichment
- curated configuration and credential file locations
- curated package history
- package version freshness
- pkgdb category and tag curation
- package relationship graph
- external package-manager database matches
- cross-ecosystem install command graph