[1m [0m
[1m [0m[1;33mUsage: [0m[1merdantic [OPTIONS] MODELS_OR_MODULES...[0m[1m [0m[1m [0m
[1m [0m
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.
[2m╭─[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m models_or_modules [1;33mMODELS_OR_MODULES...[0m One or more full dotted [2m│[0m
[2m│[0m paths for data model [2m│[0m
[2m│[0m classes, or modules [2m│[0m
[2m│[0m containing data model [2m│[0m
[2m│[0m classes, to include in [2m│[0m
[2m│[0m diagram, e.g., [2m│[0m
[2m│[0m 'erdantic.examples.pydant… [2m│[0m
[2m│[0m Only the root models of [2m│[0m
[2m│[0m composition trees are [2m│[0m
[2m│[0m needed; erdantic will [2m│[0m
[2m│[0m traverse the composition [2m│[0m
[2m│[0m tree to find component [2m│[0m
[2m│[0m classes. [2m│[0m
[2m│[0m [2m[default: None] [0m [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2m╭─[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-terminus[0m [1;32m-t[0m [1;33mTEXT [0m Full dotted paths for [2m│[0m
[2m│[0m data model classes to [2m│[0m
[2m│[0m set as terminal nodes [2m│[0m
[2m│[0m in the diagram. [2m│[0m
[2m│[0m erdantic will stop [2m│[0m
[2m│[0m searching for [2m│[0m
[2m│[0m component classes [2m│[0m
[2m│[0m when it reaches these [2m│[0m
[2m│[0m models. Repeat this [2m│[0m
[2m│[0m option if more than [2m│[0m
[2m│[0m one. [2m│[0m
[2m│[0m [2m[default: None] [0m [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-limit[0m[1;36m-search-mode…[0m [1;32m-m[0m [1;2;33m[[0m[1;33mpydantic[0m[1;2;33m|[0m[1;33mdataclasse[0m Identifiers of model [2m│[0m
[2m│[0m [1;33ms[0m[1;2;33m][0m[1;33m [0m classes that erdantic [2m│[0m
[2m│[0m supports. If any are [2m│[0m
[2m│[0m specified, when [2m│[0m
[2m│[0m searching a module, [2m│[0m
[2m│[0m limit data model [2m│[0m
[2m│[0m classes to those [2m│[0m
[2m│[0m ones. Repeat this [2m│[0m
[2m│[0m option if more than [2m│[0m
[2m│[0m one.Defaults to None [2m│[0m
[2m│[0m which will find all [2m│[0m
[2m│[0m data model classes [2m│[0m
[2m│[0m supported by [2m│[0m
[2m│[0m erdantic. [2m│[0m
[2m│[0m [2m[default: None] [0m [2m│[0m
[2m│[0m [31m*[0m [1;36m-[0m[1;36m-out[0m [1;32m-o[0m [1;33mPATH [0m Output filename. [2m│[0m
[2m│[0m [2m[default: None] [0m [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-dot[0m [1;32m-d[0m [1;33m [0m Print out Graphviz [2m│[0m
[2m│[0m DOT language [2m│[0m
[2m│[0m representation for [2m│[0m
[2m│[0m generated graph to [2m│[0m
[2m│[0m console instead of [2m│[0m
[2m│[0m rendering an image. [2m│[0m
[2m│[0m The [1;36m-[0m[1;36m-out[0m option will [2m│[0m
[2m│[0m be ignored. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-no[0m[1;36m-overwrite[0m [1;33m [0m Prevent overwriting [2m│[0m
[2m│[0m an existing file. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-version[0m [1;33m [0m Show erdantic version [2m│[0m
[2m│[0m and exit. [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-install[0m[1;36m-completion[0m [1;2;33m[[0m[1;33mbash[0m[1;2;33m|[0m[1;33mzsh[0m[1;2;33m|[0m[1;33mfish[0m[1;2;33m|[0m[1;33mpower[0m Install completion [2m│[0m
[2m│[0m [1;33mshell[0m[1;2;33m|[0m[1;33mpwsh[0m[1;2;33m][0m[1;33m [0m for the specified [2m│[0m
[2m│[0m shell. [2m│[0m
[2m│[0m [2m[default: None] [0m [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-show[0m[1;36m-completion[0m [1;2;33m[[0m[1;33mbash[0m[1;2;33m|[0m[1;33mzsh[0m[1;2;33m|[0m[1;33mfish[0m[1;2;33m|[0m[1;33mpower[0m Show completion for [2m│[0m
[2m│[0m [1;33mshell[0m[1;2;33m|[0m[1;33mpwsh[0m[1;2;33m][0m[1;33m [0m the specified shell, [2m│[0m
[2m│[0m to copy it or [2m│[0m
[2m│[0m customize the [2m│[0m
[2m│[0m installation. [2m│[0m
[2m│[0m [2m[default: None] [0m [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and [2m│[0m
[2m│[0m exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m