Installation¶

erdify can be installed with your Python package manager of choice, or run on demand without installing.

Requirements¶

erdify supports Python 3.11 – 3.15 and has no runtime dependencies. Every supported version is tested in CI on Linux; the oldest and newest are also tested on macOS and Windows.

Using pip¶

pip install erdify

Using uv¶

uv add erdify

Using pipx (recommended for CLI usage)¶

pipx install erdify

Using uvx (no installation needed)¶

# Run directly without installing
uvx erdify ./src/database -o erd.puml

SQL support (optional)¶

Parsing SQL DDL (.sql) files requires the sql extra, which pulls in sqlglot. The core install stays dependency-free; only this extra adds a runtime dependency.

pip install 'erdify[sql]'
# or: uv add 'erdify[sql]'
# or: pipx install 'erdify[sql]'

# Run on demand without installing:
uvx --from 'erdify[sql]' erdify schema.sql

See SQL DDL for usage and the supported statements.