A CLI tool for generating ERD diagrams from DuckDB databases.

• Node.js (v18.19.0 or later)

To install the CLI tool, run:

npm install -g duckerd

duckerd [options]

Generate an ERD diagram of the database schemas.

• -d, --database <path>: Path to the database file
• -t, --theme [theme]: Theme of the chart (choices: default, forest, dark, neutral, default: default)
• -o, --output <path>: Path to the output file
• -w, --width [width]: Width of the page (default: 1024)
• -H, --height [height]: Height of the page (default: 768)
• -f, --outputFormat [format]: Output format for the generated image (choices: svg, png, pdf, default: png)

duckerd -d ./mydb.duckdb -o ./erd.png -f png -t neutral -w 1600

It's possible that you need to re-run the command after the first execution, because the DuckERD CLI automatically installs the @mermaid-js/mermaid-cli package globally when it's missing on your system.

For this example we use the AWS IAM database from the AWS IAM Data project.

curl -LO https://raw.githubusercontent.com/tobilg/aws-iam-data/main/data/db/iam.duckdb

Then, we can generate the ERD as PNG with the neutral theme and otherwise default settings:

duckerd -d ./iam.duckdb -f png -t neutral