https://github.com/MrIceman/go-uml Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Case Studies + Customer Stories + Resources * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this user All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} MrIceman / go-uml Public * Notifications * Fork 1 * Star 78 A tool written in Go to build Sequence Diagrams and more UML - in Go pkg.go.dev/github.com/mriceman/go-uml License MIT license 78 stars 1 fork Star Notifications * Code * Issues 0 * Pull requests 0 * Actions * Projects 0 * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Security * Insights MrIceman/go-uml This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 1 branch 0 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/M] Use Git or checkout with SVN using the web URL. [gh repo clone MrIcem] Work fast with our official CLI. Learn more. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @MrIceman MrIceman Added how to install to README ... ce99dac Apr 27, 2023 Added how to install to README ce99dac Git stats * 24 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time examples Added missing files April 27, 2023 12:34 sequence changed AddParticipant(name string) to AddParticipants(name ...string) April 27, 2023 12:33 LICENSE.md added license April 26, 2023 23:08 README.md Added how to install to README April 27, 2023 13:09 go.mod fixed import of example April 27, 2023 12:13 go.sum Initial commit April 26, 2023 21:01 View code go-uml How to install Example Warning - AI not welcome here README.md go-uml Just a little tool to create UML Diagrams built in Go. You can use it already to build simple sequence diagrams, however, this project is still under development and you won't find some functionalities yet such as * provide conditional flows The generated diagram is saved as .PNG file So far, you can create only sequence diagrams and add Participants, directional and undirectional Edges, labels for Edges and set a Title for the diagram. I'll be updating this repository whenever I need the tool to support more functionality, feel free to create an Issue with a feature request. Since I just started this project, contributing should also be quite easy (I appreciate any contribution). You don't need to download any dependencies such as plantUML or Graphviz, which is what most of the tools out there require and what was also my motivation to start this project. go-uml is using a 2D graphics engine written 100% in Go https://github.com/fogleman/gg How to install Simply run go get -u github.com/mriceman/go-uml Example d := sequence.NewDiagram("user_starts_chatting") client := "Client" backend := "Backend" db := "DynamoDB" d.SetTitle("User initiates chat with another User") d.AddParticipants(client, backend, db) d.AddDirectionalEdge(client, backend, "PUT /chat/user/") d.AddDirectionalEdge(backend, db, "checks or create inbox for user") d.AddDirectionalEdge(backend, client, "return chat meta data + chat secret") d.AddDirectionalEdge(client, backend, "WS /joinchat/ payload: secret") d.AddDirectionalEdge(backend, db, "compare inbox secret") d.AddDirectionalEdge(backend, db, "set all unread messages to read") d.AddDirectionalEdge(backend, db, "store connection ID for user") d.AddDirectionalEdge(backend, client, "202 - You're good to go") d.AddDirectionalEdge(client, backend, "WS /sendmessage/ payload: hello!") d.AddDirectionalEdge(backend, db, "get connection ID for ") d.AddDirectionalEdge(backend, backend, "notify with connection ID if present") d.AddDirectionalEdge(backend, db, "store message in chat") d.AddDirectionalEdge(client, backend, "disconnect") d.AddDirectionalEdge(backend, db, "remove connection ID for user") d.Render() Result PNG file: Sequence Diagram generated based on above code Some more examples: example_a example_a Warning - AI not welcome here Because of my own personal philosophy regarding technology and AI, all the code in this repository that was written by me - I wrote 100% on my own. There is and will be no usage of Github Co-Pilot or any other AI tool. I became a software developer because of my passion for our craft - Software Engineering. I build this tool because I enjoy programming. Every single line of code you'll read in this repo, that was written by me, is produced first in my mind and then manifested into reality through my hands. I encourage any contributor to follow the same principle, though I can't and don't want to put any restrictions on this. Just like people stopped walking because they commute by cars and trains, which caused an increase in obesity and illness, I believe that the massive usage of AI will cause people to stop thinking and using their minds and the resulting havoc is unthinkable. About A tool written in Go to build Sequence Diagrams and more UML - in Go pkg.go.dev/github.com/mriceman/go-uml Topics uml uml-diagram sequence-diagrams Resources Readme License MIT license Stars 78 stars Watchers 1 watching Forks 1 fork Report repository Releases No releases published Packages 0 No packages published Languages * Go 100.0% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.