https://github.com/kazukousen/gouml

Automatically generate PlantUML from Go Code.
https://github.com/kazukousen/gouml

go plantuml

Last synced: 5 months ago
JSON representation

Automatically generate PlantUML from Go Code.

• Host: GitHub
• URL: https://github.com/kazukousen/gouml
• Owner: kazukousen
• License: mit
• Created: 2019-03-04T02:07:12.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-06T10:15:20.000Z (over 6 years ago)
• Last Synced: 2024-06-18T18:52:35.705Z (about 2 years ago)
• Topics: go, plantuml
• Language: Go
• Homepage:
• Size: 2.53 MB
• Stars: 100
• Watchers: 8
• Forks: 17
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/kazukousen/gouml.svg?branch=master)](https://travis-ci.org/kazukousen/gouml)  

Automatically generate PlantUML from Go Code.  

example (self-reference):  

![self-ref](self-ref.png)

Note that the interface of this library is still ALPHA level quality.  

Breaking changes will be introduced frequently.  

## Usage

```console

$ go get -u github.com/kazukousen/gouml/cmd/gouml

$ gouml --version

```

Run `gouml init` (or `gouml i`) . This will parse `.go` files and generate the plantUML file.  

```console

$ gouml i -f /path/to/package/subpackage1/ -f /path/to/package/subpackage2/foo.go

```

Fire or Directory you want to parse, you can use `-f` flag.  

### Ignore a target directory or file

You can use `--ignore` Flag.  

```console

$ gouml i -f /path/to/package/ --ignore /path/to/package/ignorepackage/

```

## License

Copyright (c) 2019-present [Kazuki Nitta](https://github.com/kazukousen)

Licensed under [MIT License](./LICENSE)