Sync dbt schema YAML and inherited column metadata before docs drift accumulates with dbt-osmosis
Keep dbt schema YAML and column documentation aligned with the project so stale metadata does not pile up between model changes.
Prerequisites
Python, dbt Core with a compatible adapter, dbt-osmosis installation, and access to the target dbt project repository
Installation
Use the upstream install or setup path that matches your environment:
- uv tool install --with="dbt-" dbt-osmosis
- pip install "dbt-osmosis" "dbt-"
- npm --prefix docs run start
- npm --prefix docs run build
Requirements and caveats from upstream:
- dbt-osmosis is a Python CLI and package for dbt development workflows.
- Python 3.10-3.13
- Docs-site commands use the Node toolchain under docs/:
Basic usage or getting-started notes:
ad-hoc SQL compile/run helpers
With uv:
bash
Extracted from upstream docs: https://raw.githubusercontent.com/z3z1ma/dbt-osmosis/HEAD/README.md