How djlemkes/dbt-diagrams works
dbt-diagrams is a Python CLI that turns dbt manifest and optional catalog artifacts into Mermaid ERDs, embeds diagrams and general Mermaid blocks in dbt docs, and can export diagrams as Markdown, Mermaid, or SVG. The main workflow is artifact validation, model/relationship construction, Mermaid generation, then file output or docs integration and serving. The graph reflects the sampled CLI, domain, validation, Mermaid, and writer code; README-described capabilities are included, while the REST API is omitted because its implementation is commented out.
Main entry points: cli.py CLI commands · mermaid.py ERD construction · output_writers.py File output writers · input_validators.py Artifact validation
Components 15
CLI workflow
- CLI commands
dbt_diagrams/cli.py - dbt docs command
- dbt artifacts
ERD generation
- Artifact validation
dbt_diagrams/input_validators.py - ERD domain models
dbt_diagrams/domain.py - ERD construction
dbt_diagrams/mermaid.py
dbt docs integration
- Docs Mermaid insertion
dbt_diagrams/mermaid.py - Mermaid HTML integration
dbt_diagrams/mermaid.py - Generated dbt docs
- Docs server
dbt_diagrams/cli.py
Output rendering
- Mermaid diagram text
dbt_diagrams/mermaid.py - File output writers
dbt_diagrams/output_writers.py - SVG browser rendering
dbt_diagrams/output_writers.py - Exported diagram files
Other components
- dbt project user
Connections 19
- dbt project user → CLI commands: runs
README.md - dbt docs command → dbt artifacts: generates
README.md - dbt project user → dbt artifacts: provides
README.md - CLI commands → dbt docs command: invokes
dbt_diagrams/cli.py - CLI commands → Artifact validation: validates
dbt_diagrams/cli.py - CLI commands → ERD construction: requests ERDs
dbt_diagrams/cli.py - ERD construction → Artifact validation: reads artifacts
dbt_diagrams/mermaid.py - ERD construction → ERD domain models: builds models
dbt_diagrams/mermaid.py - ERD construction → Mermaid diagram text: generates
dbt_diagrams/mermaid.py - CLI commands → File output writers: selects format
dbt_diagrams/cli.py - File output writers → SVG browser rendering: renders SVG
dbt_diagrams/output_writers.py - File output writers → Exported diagram files: writes
dbt_diagrams/output_writers.py - CLI commands → Docs Mermaid insertion: embeds ERDs
dbt_diagrams/cli.py - Docs Mermaid insertion → ERD construction: uses generated ERDs
dbt_diagrams/cli.py - CLI commands → Mermaid HTML integration: adds Mermaid library
dbt_diagrams/cli.py - Docs Mermaid insertion → Generated dbt docs: updates manifest
- Mermaid HTML integration → Generated dbt docs: updates HTML
dbt_diagrams/mermaid.py - dbt project user → Docs server: serves docs
README.md - Docs server → Generated dbt docs: serves existing files
dbt_diagrams/cli.py