Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 2.26 KB

README.md

File metadata and controls

88 lines (63 loc) · 2.26 KB
Raw

ERDiagram CLI

This application is the CLI version of the ERDiagram library.

Please, refer to the library docs for further information about ERDiagram features.

Table of contents

Installation

Global installation:

npm install -g @nestorrente/erdiagram-cli

You can also install it for a single project:

npm install --save-dev @nestorrente/erdiagram-cli

Usage

erdiagram <command> [options]

Commands:

  • erdiagram generate <input>: 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.

Generate command

The generate command generates the output code from an input entity-relationship diagram written using the ERDiagram language.

Usage:

erdiagram generate -f <format> <input>

Required options:

  • --format <format>, -f <format>: output format. See below the full list of supported formats.

Additional options:

  • --config <file>, -c <file>: config file path. If not specified, uses erdiagram.config.json (if exists).
  • --output <file>, -o <file>: output file path. Prints to standard output if not specified.

Supported output formats:

  • Database creation script:
    • mysql
    • oracle
    • postgresql, postgres
    • sqlite
    • sqlserver, mssql, mssqlserver
  • OOP classes/interfaces:
    • java
    • typescript, ts
  • Diagram:
    • nomnoml
    • plantuml

Create config command

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.

erdiagram create-config

Additional:

  • --config <file>, -c <file>: 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.