/mermerd-docker

Create Mermaid ERD diagrams from database schemas.

Primary LanguageDockerfileMIT LicenseMIT

mermerd-docker

Create Mermaid ERD diagrams from database schemas.

Setup

Create an output file

touch output.mmd

(Optional) Create a mermerd configuration file

See examples/mermerd-config.yaml

Usage

Run the mermerd command-line interface

This example command connects to a MySQL server running on localhost port 3306. Replace root: with your username:password combination.

docker run --pull always --rm -it --name mermerd \
    --net host \
    --mount type=bind,source="${PWD}"/output.mmd,target=/root/result.mmd \
    --mount type=bind,source="${PWD}"/mermerd-config.yaml,target=/root/.mermerd \ # optional
    ghcr.io/nedix/mermerd-docker \
    --connectionString "mysql://root:@tcp(host.docker.internal:3306)/mysql"

Attribution

Powered by mermerd.