https://github.com/tobilg/duckerd
CLI to create an ER Diagram from DuckDB database files
https://github.com/tobilg/duckerd
cli database-diagram duckdb erd erdiagram
Last synced: 19 days ago
JSON representation
CLI to create an ER Diagram from DuckDB database files
- Host: GitHub
- URL: https://github.com/tobilg/duckerd
- Owner: tobilg
- Created: 2024-09-13T09:14:20.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T05:52:20.000Z (about 1 month ago)
- Last Synced: 2025-03-30T12:06:37.906Z (26 days ago)
- Topics: cli, database-diagram, duckdb, erd, erdiagram
- Language: TypeScript
- Homepage:
- Size: 204 KB
- Stars: 117
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-duckdb - DuckERD CLI
README
# DuckERD CLI
A CLI tool for generating ERD diagrams from DuckDB databases.
## Prerequisites
- Node.js (v18.19.0 or later)
## Installation
To install the CLI tool, run:
```
npm install -g duckerd
```
## Usage
```
duckerd [options]
```
Generate an ERD diagram of the database schemas.
#### Options:
- `-d, --database `: Path to the database file
- `-t, --theme [theme]`: Theme of the chart (choices: `default`, `forest`, `dark`, `neutral`, default: `default`)
- `-o, --output `: 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`)
#### Example:
```bash
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.**
## Usage example
### Download the example database
For this example we use the [AWS IAM database](https://raw.githubusercontent.com/tobilg/aws-iam-data/main/data/db/iam.duckdb) from the [AWS IAM Data](https://github.com/tobilg/aws-iam-data) project.
```bash
curl -LO https://raw.githubusercontent.com/tobilg/aws-iam-data/main/data/db/iam.duckdb
```
### Generate the ERD
Then, we can generate the ERD as PNG with the `neutral` theme and otherwise default settings:
```bash
duckerd -d ./iam.duckdb -f png -t neutral
```
### Result
