Skip to content

Create Mermaid ERD diagrams from live databases.

License

Notifications You must be signed in to change notification settings

nedix/mermerd-container

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Create Mermaid ERD diagrams from live databases.

Usage

1. Create an output file

touch output.mmd

2. (Optional) Create a mermerd configuration file

See documentation and examples/mermerd-config.yaml .

3. 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
    nedix/mermerd \
    --connectionString "mysql://root:@tcp(host.docker.internal:3306)/mysql"

Attribution

Powered by mermerd.