{"id":41925327,"url":"https://github.com/nesheep5/rough-erd","last_synced_at":"2026-01-25T17:09:54.924Z","repository":{"id":57650380,"uuid":"173647081","full_name":"nesheep5/rough-erd","owner":"nesheep5","description":"This tool creates a rough ER Diagram. It uses the ID to create a ERD. (Not using FOREIGN KEY)","archived":false,"fork":false,"pushed_at":"2019-04-11T06:04:40.000Z","size":130,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-20T09:24:01.374Z","etag":null,"topics":["db","erd","erdiagram","golang","plantuml","uml","uml-diagram"],"latest_commit_sha":null,"homepage":"","language":"Go","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/nesheep5.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":"2019-03-04T00:27:50.000Z","updated_at":"2022-01-13T16:51:13.000Z","dependencies_parsed_at":"2022-09-13T10:51:42.052Z","dependency_job_id":null,"html_url":"https://github.com/nesheep5/rough-erd","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nesheep5/rough-erd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nesheep5%2Frough-erd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nesheep5%2Frough-erd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nesheep5%2Frough-erd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nesheep5%2Frough-erd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nesheep5","download_url":"https://codeload.github.com/nesheep5/rough-erd/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nesheep5%2Frough-erd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28755568,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T16:32:25.380Z","status":"ssl_error","status_checked_at":"2026-01-25T16:32:09.189Z","response_time":113,"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":["db","erd","erdiagram","golang","plantuml","uml","uml-diagram"],"created_at":"2026-01-25T17:09:54.858Z","updated_at":"2026-01-25T17:09:54.916Z","avatar_url":"https://github.com/nesheep5.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rough-erd\nThis tool creates a rough ER Diagram.  \nIt uses the ID to create a ERD. (Not using FOREIGN KEY)  \nIt can make ERD Text([PlantUml](http://plantuml.com) Format), PNG, SVG, and [online editor](http://www.plantuml.com/plantuml/) URL.\n\n## Sample ERD\n![uml.png](https://github.com/nesheep5/rough-erd/blob/master/example/uml.png)\n\n## Relation Role\nThis tool uses the ID to relate.  Not using FOREIGN KEY.\nExample, `salaries` table has `employee_id`, `salaries` related `employees`.   \n(example sql:  `SELECT * FROM employees JOIN salaries ON employees.id = salaries.employee_id;`)\n\n## Install\n```bash\ngo get -u github.com/nesheep5/rough-erd/cmd/rough-erd\n```\n\n## Usage\n```bash\n\u003e rough-erd -h\nNAME:\n   rough-erd - This tool creates a rough ER diagram.\n\nUSAGE:\n   rough_erd [global options] command [command options] [arguments...]\n\nVERSION:\n   v1.0.0\n\nCOMMANDS:\n     make, m  make ER diagram.\n     help, h  Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n   --help, -h     show help\n   --version, -v  print the version\n```\n### make command\n```bash\n\u003e rough-erd make -h\nNAME:\n   rough_erd make - make ER diagram.\n\nUSAGE:\n   rough_erd make [command options] [arguments...]\n\nOPTIONS:\n   --dbtype value              database type (default: \"mysql\")\n   --user value, -u value      database user\n   --password value, -p value  database password\n   --host value, -H value      database host (default: \"127.0.0.1\")\n   --port value, -P value      database port (default: 3306)\n   --protocol value            database protocol\n   --name value, -n value      database name\n   --output value, -o value    output style [text, url, png, svg]  (default: \"text\")\n```\n\n## Example\nhttps://github.com/nesheep5/rough-erd/tree/master/example\n### Run TestDB\n```bash\n\u003e cd $[GOPATH]/src/github.com/nesheep5/rough-erd/example\n\u003e docker-compose up -d --build \n\u003e mysql -P23306 -uroot -prough-erd --protocol=TCP -Dtest\nmysql: [Warning] Using a password on the command line interface can be insecure.\nReading table information for completion of table and column names\nYou can turn off this feature to get a quicker startup with -A\n\nWelcome to the MySQL monitor.  Commands end with ; or \\g.\nYour MySQL connection id is 8\nServer version: 5.7.25 MySQL Community Server (GPL)\n\nCopyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.\n\nOracle is a registered trademark of Oracle Corporation and/or its\naffiliates. Other names may be trademarks of their respective\nowners.\n\nType 'help;' or '\\h' for help. Type '\\c' to clear the current input statement.\n\nmysql\u003e show tables;\n+----------------+\n| Tables_in_test |\n+----------------+\n| departments    |\n| dept_emp       |\n| dept_manager   |\n| employees      |\n| salaries       |\n| titles         |\n+----------------+\n6 rows in set (0.00 sec)\n```\n\n### make UML Text\n```bash\n\u003e rough_erd make -P 23306 -u root -p rough-erd -protocol tcp -n test -o text\n\n@startuml\ntitle ER Diagram\nentity \"departments\" {\nid\n}\nentity \"dept_emp\" {\nid\nemployee_id\ndepartment_id\n}\nentity \"dept_manager\" {\nid\nemployee_id\ndepartment_id\n}\nentity \"employees\" {\nid\n}\nentity \"salaries\" {\nid\nemployee_id\n}\nentity \"titles\" {\nid\nemployee_id\n}\ndept_emp -- employees :employee_id\ndept_emp -- departments :department_id\ndept_manager -- employees :employee_id\ndept_manager -- departments :department_id\nsalaries -- employees :employee_id\ntitles -- employees :employee_id\n@enduml\n\n```\n\n### make UML URL\n```bash\n\u003e rough_erd make -P 23306 -u root -p rough-erd -protocol tcp -n test -o url\nOpen → http://www.plantuml.com/plantuml/uml/UDgKaKsgmp0CXFSwXSW-5yWgY_Skq0i4WKKGM6wmrKKelNlfZnstAIvTppVZ6Gl6P1Jjf1vCp3F-7_1FQ8wamC74LkmSBnHDELZgy0pYu59hDh4kJu5rySULUH87cstQMvG2pHn_i6Lcto6HfoX5gCCswBxkCv8tODzZUGM7jr85gRu3XzUszRHlQHNMICpR6ccFPGrWvE1k1xu6003__qByi0K0\n```\nOpen → http://www.plantuml.com/plantuml/uml/UDgKaKsgmp0CXFSwXSW-5yWgY_Skq0i4WKKGM6wmrKKelNlfZnstAIvTppVZ6Gl6P1Jjf1vCp3F-7_1FQ8wamC74LkmSBnHDELZgy0pYu59hDh4kJu5rySULUH87cstQMvG2pHn_i6Lcto6HfoX5gCCswBxkCv8tODzZUGM7jr85gRu3XzUszRHlQHNMICpR6ccFPGrWvE1k1xu6003__qByi0K0\n\n### make UML png\n```bash\n\u003e rough_erd make -P 23306 -u root -p rough-erd -protocol tcp -n test -o png \u003e uml.png\n\u003e open uml.png\n```\n![uml.png](https://github.com/nesheep5/rough-erd/blob/master/example/uml.png)\n\n### make UML svg\n```\n\u003e rough_erd make -P 23306 -u root -p rough-erd -protocol tcp -n test -o svg \u003e uml.svg\n\u003e open uml.svg -a /Applications/Google\\ Chrome.app/\n```\n![uml.svg](https://github.com/nesheep5/rough-erd/blob/master/example/uml.svg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnesheep5%2Frough-erd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnesheep5%2Frough-erd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnesheep5%2Frough-erd/lists"}