Skip to content

CLI Help Documentation

erdantic --help
Usage: erdantic [OPTIONS] MODELS...

  Draw entity relationship diagrams (ERDs) for Python data model classes.
  Diagrams are rendered using the Graphviz library. Currently supported data
  modeling frameworks are Pydantic and standard library dataclasses.

Arguments:
  MODELS...  One or more full dotted paths for data model classes to include
             in diagram, e.g., 'erdantic.examples.pydantic.Party'. Only the
             root models of composition trees are needed; erdantic will
             traverse the composition tree to find component classes.
             [required]

Options:
  -t, --terminus TEXT             Full dotted paths for data model classes to
                                  set as terminal nodes in the diagram.
                                  erdantic will stop searching for component
                                  classes when it reaches these models. Repeat
                                  this option if more than one.
  -o, --out PATH                  Output filename.  [required]
  -d, --dot                       Print out Graphviz DOT language
                                  representation for generated graph to
                                  console instead of rendering an image. The
                                  --out option will be ignored.
  --no-overwrite                  Prevent overwriting an existing file.
  --version                       Show erdantic version and exit.
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.
Back to top