Skip to Content
DocumentationGet Started

Get Started

Install the package into your dbt environment

uv add dbt-colibri

You can verify your installation by running:

colibri --version

And you should see:

Compile your dbt project

dbt compile & dbt docs generate
Note

Colibri expects a target/manifest.json with compiled sql code, and a target/catalog.json for materialized column metadata. If you want to run in colibri against your production data, you need to compile and generate docs with --target your_prod_target.

Generate Colibri documentation

colibri generate

This will generate a dist/index.html file with your documentation. You can open this file in your browser to view your documentation. The colibri-manifest.json file contains the metadata generated by colibri.

Colibri Output

Tip

You can use the--debug flag to get more information about the documentation generation process.

colibri generate --debug
Last updated on
IntroductionBasic Features