{"id":27288151,"url":"https://github.com/nestorrente/erdiagram-cli","last_synced_at":"2026-03-14T11:34:33.302Z","repository":{"id":57129905,"uuid":"335054515","full_name":"nestorrente/erdiagram-cli","owner":"nestorrente","description":"ERDiagram library CLI command","archived":false,"fork":false,"pushed_at":"2023-01-14T00:33:46.000Z","size":7344,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-18T01:38:09.596Z","etag":null,"topics":["diagram","entity","erdiagram","generation","java","javascript","js","mysql","nomnoml","oracle","oracledb","plantuml","postgres","postgresql","relationship","sql","sqlite","sqlserver","ts","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nestorrente.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-01T19:04:02.000Z","updated_at":"2023-01-14T00:33:51.000Z","dependencies_parsed_at":"2023-02-09T18:02:45.008Z","dependency_job_id":null,"html_url":"https://github.com/nestorrente/erdiagram-cli","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestorrente%2Ferdiagram-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestorrente%2Ferdiagram-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestorrente%2Ferdiagram-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestorrente%2Ferdiagram-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nestorrente","download_url":"https://codeload.github.com/nestorrente/erdiagram-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248475350,"owners_count":21110070,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diagram","entity","erdiagram","generation","java","javascript","js","mysql","nomnoml","oracle","oracledb","plantuml","postgres","postgresql","relationship","sql","sqlite","sqlserver","ts","typescript"],"created_at":"2025-04-11T20:28:14.439Z","updated_at":"2026-03-14T11:34:33.245Z","avatar_url":"https://github.com/nestorrente.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ERDiagram CLI\n\nThis application is the CLI version of the [ERDiagram library](https://github.com/nestorrente/erdiagram).\n\nPlease, refer to the library docs for further information about _ERDiagram_ features.\n\n## Table of contents\n\n* [Installation](#installation)\n* [Usage](#usage)\n    + [Generate command](#generate-command)\n    + [Create config command](#create-config-command)\n\n## Installation\n\nGlobal installation:\n\n```shell\nnpm install -g @nestorrente/erdiagram-cli\n```\n\nYou can also install it for a single project:\n\n```shell\nnpm install --save-dev @nestorrente/erdiagram-cli\n```\n\n## Usage\n\n```shell\nerdiagram \u003ccommand\u003e [options]\n```\n\nCommands:\n  * `erdiagram generate \u003cinput\u003e`: generate the code of an entity-relationship model.\n  * `erdiagram create-config`: create a config file with the default values.\n\nOptions:\n  * `--help`, `-h`: Show help.\n  * `--version`, `-v`  Show version number.\n\n### Generate command\n\nThe `generate` command generates the output code from an input entity-relationship diagram written using the _ERDiagram_\nlanguage.\n\nUsage:\n\n```shell\nerdiagram generate -f \u003cformat\u003e \u003cinput\u003e\n```\n\nRequired options:\n  * `--format \u003cformat\u003e`, `-f \u003cformat\u003e`: output format. See below the full list of supported formats.\n\nAdditional options:\n  * `--config \u003cfile\u003e`, `-c \u003cfile\u003e`: config file path. If not specified, uses `erdiagram.config.json` (if exists).\n  * `--output \u003cfile\u003e`, `-o \u003cfile\u003e`: output file path. Prints to standard output if not specified.\n\nSupported output formats:\n  * Database creation script:\n    * `mysql`\n    * `oracle`\n    * `postgresql`, `postgres`\n    * `sqlite`\n    * `sqlserver`, `mssql`, `mssqlserver`\n  * OOP classes/interfaces:\n    * `java`\n    * `typescript`, `ts`\n  * Diagram:\n    * `nomnoml`\n    * `plantuml`\n\n### Create config command\n\nThe `create-config` commands generates a config file with the default values.\n\nBy default, if the file already exists, it asks for confirmation, but this behaviour can be customized using the\n`--override` and `--preserve` options.\n\n```shell\nerdiagram create-config\n```\n\nAdditional:\n* `--config \u003cfile\u003e`, `-c \u003cfile\u003e`: config file path. If not specified, uses `erdiagram.config.json` if exists.\n* `--overwrite`, `-w`: overwrite existing config file without asking.\n* `--preserve`, `-p`: preserve existing config file without asking.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnestorrente%2Ferdiagram-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnestorrente%2Ferdiagram-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnestorrente%2Ferdiagram-cli/lists"}