{"id":42770008,"url":"https://github.com/d02ev/gen-erd-cli","last_synced_at":"2026-01-29T21:42:34.090Z","repository":{"id":304554775,"uuid":"1018207596","full_name":"d02ev/gen-erd-cli","owner":"d02ev","description":"A CLI tool that can generate beautiful ERD diagrams","archived":false,"fork":false,"pushed_at":"2025-12-16T19:09:29.000Z","size":333,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-12-20T10:07:14.836Z","etag":null,"topics":["cli","erdiagram","javascript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/gen-erd-cli","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/d02ev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-11T19:51:57.000Z","updated_at":"2025-12-16T19:08:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"65938af0-9a36-42a2-acd5-70079691f222","html_url":"https://github.com/d02ev/gen-erd-cli","commit_stats":null,"previous_names":["d02ev/gen-erd-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/d02ev/gen-erd-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d02ev%2Fgen-erd-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d02ev%2Fgen-erd-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d02ev%2Fgen-erd-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d02ev%2Fgen-erd-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/d02ev","download_url":"https://codeload.github.com/d02ev/gen-erd-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d02ev%2Fgen-erd-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28886414,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T21:06:44.224Z","status":"ssl_error","status_checked_at":"2026-01-29T21:06:42.160Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cli","erdiagram","javascript"],"created_at":"2026-01-29T21:42:33.546Z","updated_at":"2026-01-29T21:42:34.082Z","avatar_url":"https://github.com/d02ev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gen-erd-cli\n\nA CLI tool that generates beautiful ERD diagrams using database connection configurations.\n\n## Features\n\n- Interactive Terminal User Interface (TUI)\n- Web-based ERD visualization with automatic browser opening\n- Support for connection string input\n- Support for individual database field configuration\n- Support for multiple database types:\n  - PostgreSQL\n  - MySQL\n  - SQL Server\n  - SQLite\n  - Oracle\n\n## Installation\n\n```bash\nnpm install -g gen-erd-cli\ngen-erd-cli init\n```\n\nOr use with npx:\n\n```bash\nnpx gen-erd-cli init\n```\n\n## Usage\n\nRun the CLI tool:\n\n```bash\ngen-erd-cli init\n```\n\nThis will open a beautiful interactive interface with ASCII art banners and styled boxes. After connecting to your database, the tool will automatically open a web browser to display the generated ERD diagram.\n\n### 1. Connection String Option\n\nChoose \"1. Connection String\" to provide a database connection string directly.\n\n**Supported formats:**\n\n- PostgreSQL: `postgresql://username:password@localhost:5432/database_name`\n- MySQL: `mysql://username:password@localhost:3306/database_name`\n- SQL Server: `mssql://username:password@localhost:1433/database_name`\n- SQLite: `sqlite://path/to/database.sqlite`\n- Oracle: `oracle://username:password@localhost:1521/service_name`\n\n### 2. Individual Fields Option\n\nChoose \"2. Individual Fields\" to configure database connection step by step:\n\n1. **Host**: Database host (defaults to localhost)\n2. **Port**: Database port (auto-suggests based on database type)\n3. **Username**: Database username\n4. **Password**: Database password (hidden input)\n5. **Database**: Database name\n\n## Dependencies\n\n- `inquirer`: Interactive command line interface\n- `chalk`: Terminal string styling\n- `commander`: CLI arg parsing\n- `express`: Web server for ERD visualization\n- `open`: Automatic browser opening\n- Database drivers:\n  - `pg`: PostgreSQL client\n  - `mysql2`: MySQL client\n  - `mssql`: SQL Server client\n  - `sqlite3`: SQLite client\n  - `oracledb`: Oracle client\n\n## How it Works\n\n1. Run `gen-erd-cli init` to start the interactive CLI\n2. Choose your preferred connection method (connection string or individual fields)\n3. Select your database type from the supported options\n4. Provide connection details\n5. The tool automatically opens a web browser displaying your ERD diagram\n6. The ERD visualization shows tables, fields, relationships, and data types\n\n## Recent Updates\n\n- **v2.0.0**: Added support for MySQL, SQL Server, SQLite, and Oracle\n- **v2.0.0**: Introduced web-based ERD visualization with automatic browser opening\n- **v2.0.0**: Enhanced interactive CLI with better error handling and user experience\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd02ev%2Fgen-erd-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fd02ev%2Fgen-erd-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd02ev%2Fgen-erd-cli/lists"}