BurntSushi / erd

Translates a plain text description of a relational database schema to a graphical entity-relationship diagram.
The Unlicense
1.8k stars 154 forks source link

correct the information about the docker usage #84

Closed christian-heusel closed 3 years ago

christian-heusel commented 3 years ago

When running the docker container as given in the readme

erdtag="0.2.1.0"; cd erd && docker build -t erd:$erdtag . && docker run -it erd:$erdtag "erd -h"

The following error occurs as the container only seems to expect the arguments for erd and not the full command there:

chris@pioneer shared_projects/erd (master %) » sudo docker run -i erd:latest "erd -h"
[sudo] password for chris:
erd does not have any positional arguments. <--

Usage: erd [flags]
  -c[FILE]  --config[=FILE]  Configuration file.
  -i FILE   --input=FILE     When set, input will be read from the given file.
                             Otherwise, stdin will be used.
  -o FILE   --output=FILE    When set, output will be written to the given file.
                             Otherwise, stdout will be used.
                             If given and if --fmt is omitted, then the format will be
                             guessed from the file extension.
  -h        --help           Show this usage message.
  -f FMT    --fmt=FMT        Force the output format to one of:
                             bmp, dot, eps, gif, jpg, pdf, plain, png, ps, ps2, svg, tiff
  -e EDGE   --edge=EDGE      Select one type of edge:
                             compound, noedge, ortho, poly, spline
  -d        --dot-entity     When set, output will consist of regular dot tables instead of HTML tables.
                             Formatting will be disabled. Use only for further manual configuration.
  -v        --version        Shows version of application and revision code..
mmzx commented 3 years ago

All LGTM. Thanks for the PR and for the nice extra example!