An alternative dbt docs site — catalog + ERD + column-level lineage + versioned deploys, all in one CLI.
Turn your dbt artifacts into a self-contained docs site: a browsable catalog, an entity-relationship diagram, an interactive lineage DAG, and column-level lineage traced from your compiled SQL — all in one dbdocs generate. Serve it with dbdocs serve, or deploy versioned builds anywhere a static host will take them.
| Catalog | Model page | Lineage DAG | Health Check |
|---|---|---|---|
 |
 |
 |
 |
Why dbdocs?
dbt's built-in docs stop short of telling you which upstream column fed this downstream column, which tables relate to each other, or what changed between builds. dbdocs fills those gaps — no documentation framework or separate ERD tool to install.
- ERD + column-level lineage — table relationships (dbterd) and column lineage from compiled SQL (sqlglot).
- Column impact analysis — downstream dependents for any column.
- Deep-link URLs for every node, column, and DAG view.
- Any sqlglot dialect, auto-detected from your manifest.
- Scales to 1 000s of models without freezing the browser.
- Fail-soft — an unparseable model is skipped, not fatal.
- Project Health Check across the six dbt-project-evaluator dimensions.
- Versioned deploys with a built-in version switcher, no plugins.
- Full-text search across names, columns, descriptions, tags, and SQL at the client-side, no backend.
- Static REST API (
api/v1/) — addressable JSON for every node, lineage, and health, for headless / agent consumption. - Dark / light theme.
Install
pip install dbdocs --upgrade
Requires Python 3.10+.
Quickstart
dbt docs generate # writes target/manifest.json + target/catalog.json
dbdocs generate # builds ./site/ with index.html + dbdocs-data.json.gz
dbdocs serve # static http server on http://127.0.0.1:8000
The site must be served over HTTP (not opened as a local file) because it fetches the data payload at load time. dbdocs serve handles that locally; any static host works for deployment.
Full walkthrough, configuration, and architecture live in the documentation.
Contributing
Contributions are welcome — bugs, features, docs, typos. See the Contributing Guide.
If dbdocs saves you some clicks, consider buying me a coffee.
License
MIT © Dat Nguyen
1 maintainer
Metadata
1 maintainer
Release files for dbdocs 1.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| dbdocs-1.7.0.tar.gz | 246.6 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dbdocs-1.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 513.5 kB
Release files / dbdocs-1.7.0.tar.gz
| Download URL | dbdocs-1.7.0.tar.gz |
|---|---|
| Size | 246.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
50fb2a8e42ccc5d07fa4f407856b5478e34e5916f72b804ce7e719b42b6a9997
|
|
BLAKE2b-256 checksum How to use checksums |
ce1af8f2ac7f59e33033507d038afac67cb45483ae776d479ba8969d3c5c5e5b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 4, 2026.
Transparency logRelease files / dbdocs-1.7.0-py3-none-any.whl
| Download URL | dbdocs-1.7.0-py3-none-any.whl |
|---|---|
| Size | 266.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8689855b9ef77acb74c2d5747b0b3d21c80995dfad134730f444d50cd4931b83
|
|
BLAKE2b-256 checksum How to use checksums |
19caf7f5d00fa03135dc2683c34ee42b8305d1f5fc241bdfaf3245c6acf88597
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 4, 2026.
Transparency logSecurity for dbdocs 1.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for dbdocs-1.7.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 4, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
