jfeliu007 / goplantuml

PlantUML Class Diagram Generator for golang projects
MIT License
1.84k stars 172 forks source link

How to generate the UML diagram? #99

Closed aggarwalanubhav closed 4 years ago

aggarwalanubhav commented 4 years ago

Hi @jfeliu007,

I have created the .puml file but I'm not quite getting what command should I run to generate the UML diagram. Please help me with this.

Thanks.

jfeliu007 commented 4 years ago

You have to use plantuml. Take a look www.plantuml.com for options on how to generate an image from the pulm file.

jfeliu007 commented 4 years ago

@aggarwalanubhav maybe you would be interested in knowing that we made a service that help you generate diagrams. If you have your project in github.com or are interested in reviewing any other public GoLang project, you can use www.dumels.com to generate yours. 😄

jasoncoleusa commented 4 years ago

Because I cannot use a public service for private code, I use PlantUML from the Shell like @jfeliu007 mentioned. It took a bit of digging to figure it out but I end up using something like cat pumlfile.puml | plantuml -pipe > imagefile.png. Of course, you'll need PlantUML installed. As a side note, add the argument -DPLANTUML_LIMIT_SIZE=100000 if you have a very large puml or else the image will be cutoff.