Skip to content

CLI Help Documentation

erdantic --help
 Usage: erdantic [OPTIONS] MODELS_OR_MODULES...                                 
 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_or_modules      MODELS_OR_MODULES...  One or more full dotted    โ”‚
โ”‚                                                   paths for data model       โ”‚
โ”‚                                                   classes, or modules        โ”‚
โ”‚                                                   containing data model      โ”‚
โ”‚                                                   classes, to include in     โ”‚
โ”‚                                                   diagram, e.g.,             โ”‚
โ”‚                                                   'erdantic.examples.pydantโ€ฆ โ”‚
โ”‚                                                   Only the root models of    โ”‚
โ”‚                                                   composition trees are      โ”‚
โ”‚                                                   needed; erdantic will      โ”‚
โ”‚                                                   traverse the composition   โ”‚
โ”‚                                                   tree to find component     โ”‚
โ”‚                                                   classes.                   โ”‚
โ”‚                                                   [default: None]            โ”‚
โ”‚                                                   [required]                 โ”‚
โ•ญโ”€ Options โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚    --terminus            -t      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.                  โ”‚
โ”‚                                                        [default: None]       โ”‚
โ”‚    --limit-search-modeโ€ฆ  -m      [pydantic|dataclasse  Identifiers of model  โ”‚
โ”‚                                  s]                    classes that erdantic โ”‚
โ”‚                                                        supports. If any are  โ”‚
โ”‚                                                        specified, when       โ”‚
โ”‚                                                        searching a module,   โ”‚
โ”‚                                                        limit data model      โ”‚
โ”‚                                                        classes to those      โ”‚
โ”‚                                                        ones. Repeat this     โ”‚
โ”‚                                                        option if more than   โ”‚
โ”‚                                                        one.Defaults to None  โ”‚
โ”‚                                                        which will find all   โ”‚
โ”‚                                                        data model classes    โ”‚
โ”‚                                                        supported by          โ”‚
โ”‚                                                        erdantic.             โ”‚
โ”‚                                                        [default: None]       โ”‚
โ”‚ *  --out                 -o      PATH                  Output filename.      โ”‚
โ”‚                                                        [default: None]       โ”‚
โ”‚                                                        [required]            โ”‚
โ”‚    --dot                 -d                            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|power  Install completion    โ”‚
โ”‚                                  shell|pwsh]           for the specified     โ”‚
โ”‚                                                        shell.                โ”‚
โ”‚                                                        [default: None]       โ”‚
โ”‚    --show-completion             [bash|zsh|fish|power  Show completion for   โ”‚
โ”‚                                  shell|pwsh]           the specified shell,  โ”‚
โ”‚                                                        to copy it or         โ”‚
โ”‚                                                        customize the         โ”‚
โ”‚                                                        installation.         โ”‚
โ”‚                                                        [default: None]       โ”‚
โ”‚    --help                                              Show this message and โ”‚
โ”‚                                                        exit.                 โ”‚