{"id":24433837,"url":"https://github.com/windler/awesm","last_synced_at":"2025-08-17T21:39:24.567Z","repository":{"id":151075754,"uuid":"120180062","full_name":"windler/AwesM","owner":"windler","description":"Simplified generation of diagrams","archived":false,"fork":false,"pushed_at":"2018-03-24T15:22:34.000Z","size":649,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-13T21:26:12.292Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/windler.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2018-02-04T11:46:12.000Z","updated_at":"2021-08-13T20:19:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"ddb19a10-036e-4279-8d44-321a505c8471","html_url":"https://github.com/windler/AwesM","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/windler/AwesM","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windler%2FAwesM","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windler%2FAwesM/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windler%2FAwesM/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windler%2FAwesM/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/windler","download_url":"https://codeload.github.com/windler/AwesM/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windler%2FAwesM/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270912541,"owners_count":24666746,"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","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-01-20T16:50:56.755Z","updated_at":"2025-08-17T21:39:24.522Z","avatar_url":"https://github.com/windler.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Go Report Card](https://goreportcard.com/badge/github.com/windler/AwesM)](https://goreportcard.com/report/github.com/windler/AwesM) [![CircleCI](https://circleci.com/gh/windler/AwesM.svg?style=svg)](https://circleci.com/gh/windler/AwesM) [![codebeat badge](https://codebeat.co/badges/35d3d025-5d2c-4bc7-919f-3f1b9ab1fb20)](https://codebeat.co/projects/github-com-windler-awesm-master)\n# AwesM - Awesome Modeling\n`AwesM` is a tool that simplifies the generation of graphviz diagrams using the `awesome modeling language`. Currently, there is only an option to generate activity diagrams.\n\n# Installation \n```bash\ngo get github.com/windler/AwesM\n```\n\nMake sure you have [graphviz](https://www.graphviz.org/) installed.\n\n# Usage\nAfter creating a yaml file describing your diagram, you just call\n```bash\nawesm path/file.yaml\n```\n\nThis will create a graph in top/down presentation. You can change to left/right by calling \n\n```bash\nawesm path/file.yaml LR\n```\n\n# Activity diagram\nEvery activity diagram starts with the keyword `activity`. The start and end of the diagram are represented by the keywords `start` and `end`. The following keywords are possible:\n\n| Keyword       | Description                                        |\n|--|--|\n| if | Starts a condition. Multiple paths are allowed. |\n| ifopt | Starts a condition with only one subpath. A scecond path is directly connect with the join |\n| fork | Creates parallelizm. Multiple paths are allowed | \n\nPlease read the following examples to fully understand the yaml structure.\n\n## Activity diagram examples\n\n### pizza order (left/right)\n`yaml-File`:\n```yaml\nactivity:\n    - start\n    - order received\n    - ifopt: \n        \"comment from customer?\":\n            - consider comment\n    - choose dough\n    - choose sauce\n    - choose toppings\n    - fork:\n        path1:\n            - bake pizza\n        path2:\n            - organize driver\n        path3:\n            - calculate price\n    - deliver\n    - end\n``` \n\n```bash\nawesm examples/pizza.yaml LR\n```\n\nOutput:  \n![testoutput](examples/pizza.yaml.png)\n\n### waking up (top/down)\n`yaml-File`:\n```yaml\nactivity:\n    - start\n    - wake up\n    - stand up\n    - if: \n        \"not tired?\":\n            - shower\n            - get clothed\n        \"tired?\":\n            - drink coffee\n            - ifopt:\n                \"still tired?\":\n                    - fork:\n                        path1:\n                            - put on socks\n                        path2:\n                            - go to toilet\n    - end\n``` \n\n```bash\nawesm examples/simple_test.yaml\n```\n\nOutput:  \n![testoutput](examples/simple_test.yaml.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindler%2Fawesm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwindler%2Fawesm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindler%2Fawesm/lists"}