README.md

erd-go

Translates a plain text description of a relational database schema to a graphical entity-relationship diagram.(convert to dot file)

Install

get binary from releases page.

or

go get github.com/kaishuu0123/erd-go

or (for Mac)

brew tap kaishuu0123/erd-go
brew install erd-go

Usage

Usage:
  erd-go [OPTIONS] PATTERN [PATH]

Application Options:
  -i, --input=  input will be read from the given file.
  -o, --output= output will be written to the given file.

Help Options:
  -h, --help    Show this help message

support input from STDIN.

cat examples/nfldb.er | erd-go

ex.) convert to png from dot (use dot command)

cat examples/nfldb.er | erd-go | dot -Tpng -o nfldb.png

Usage (Used by Docker container)

cat examples/nfldb.er | docker run --rm -i kaishuu0123/erd-go | docker run --rm -i risaacson/graphviz dot -T png > nfldb.png

Example

see examples directory

Build Instruction

1. install glide

   go get github.com/Masterminds/glide

2. install go-bindata

   go get github.com/jteeuwen/go-bindata

3. install peg

   go get github.com/pointlander/peg

4. make

   make

LICENSE

MIT

Credits

This work is based off of several existing projects:

• https://github.com/BurntSushi/erd
• https://github.com/unok/erdm