Entity-Relationship Diagram Code Generator CLI
npm install @nestorrente/erdiagram-cliThis application is the CLI version of the ERDiagram library.
Please, refer to the library docs for further information about _ERDiagram_ features.
* Installation
* Usage
+ Generate command
+ Create config command
``shell`
npm install --global @nestorrente/erdiagram-cli
`shell`
erdiagram
Commands:
* erdiagram generate : generate the code of an entity-relationship model.erdiagram create-config
* : create a config file with the default values.
Options:
* --help, -h: Show help.--version
* , -v Show version number.
The generate command generates the output code from an input entity-relationship diagram written using the _ERDiagram_
language.
Usage:
`shell`
erdiagram generate -f
Options:
* --config, -c: config file path (if not specified, uses erdiagram.config.json if exists).--format
* , -f: output format (see below the full list of supported formats).--output
* , -o: output file path (prints to standard output if not specified).
Supported output formats:
* Database creation script:
* mysqloracle
* postgresql
* , postgressqlite
* sqlserver
* , mssql, mssqlserverjava
* OOP classes/interfaces:
* typescript
* , tsnomnoml
* Diagram:
* plantuml
*
The create-config commands generates a config file with the default values.
By default, if the file already exists, it asks for confirmation, but this behaviour can be customized using the
--override and --preserve options.
`shell`
erdiagram create-config [-c
Options:
* --config, -c: config file path (if not specified, uses erdiagram.config.json if exists).--overwrite
* , -w: overwrite existing config file without asking.--preserve
* , -p`: preserve existing config file without asking.