Reports & Diagnostics

HTML Reports

dbsprout report renders a self-contained HTML report from recorded generation runs — no regeneration needed:

# Most recent run → ./seeds/report.html
dbsprout report

# A specific historical run, to a custom path
dbsprout report --run-id 7 --output ./report.html

The report includes an embedded Mermaid ERD, numeric distribution histograms, a correlation heatmap, categorical value-frequency charts, data-preview tables, and a classified quality-metrics table. Generation runs are recorded automatically in the local state store under .dbsprout/.

You can also produce a report inline while generating:

dbsprout generate --report

Environment Diagnostics

dbsprout doctor checks the local environment for common problems before you hit them mid-run:

dbsprout doctor --db postgresql://localhost/myapp

Checks cover the Python version, database connectivity, optional extras, embedded model availability, disk space, plugin health, training-accelerator availability, and a secret scan of the config file (--config, default dbsprout.toml).

Plugins

DBSprout is extensible via Python entry points — custom schema parsers, generators, output writers, and LLM providers:

# List discovered plugins, grouped by entry-point group
dbsprout plugins list

# Validate that a plugin loads and conforms to its Protocol
dbsprout plugins check parsers:yaml

See the project’s examples/plugin-yaml-parser/ for a working reference plugin.