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 to 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:
  -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  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.

  --help                Show this message and exit.