https://github.com/gmarik/go-erd

Go-ERD (Entity Relationship Diagrams) for Golang with Graphviz [WIP]
https://github.com/gmarik/go-erd

erd golang graphviz

Last synced: 3 months ago
JSON representation

Go-ERD (Entity Relationship Diagrams) for Golang with Graphviz [WIP]

• Host: GitHub
• URL: https://github.com/gmarik/go-erd
• Owner: gmarik
• Created: 2017-03-27T22:43:24.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-05T18:49:38.000Z (almost 8 years ago)
• Last Synced: 2024-08-01T16:28:06.811Z (6 months ago)
• Topics: erd, golang, graphviz
• Language: Go
• Homepage:
• Size: 135 KB
• Stars: 285
• Watchers: 12
• Forks: 22
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - go-erd - Go-ERD (Entity Relationship Diagrams) for Golang with Graphviz [WIP] (Go)

README

        
# Go-ERD [WIP]

Entity Relationship Diagrams for Golang with GraphViz.

# Why

Visualize package's types and their inter-relationships to aid exploring and studying source code.

# Installation

```

go get github.com/gmarik/go-erd

```

# Use

```

# go-erd -path 

# ie

go-erd -path $(go env GOROOT)/src/go/ast/ |dot -Tsvg > out.svg

open out.svg

```

### go/ast

![go/ast](https://cdn.rawgit.com/gmarik/go-erd/master/examples/go-ast.svg)

### go/types

![go/ast](https://cdn.rawgit.com/gmarik/go-erd/master/examples/go-types.svg)

### net/http

Simple on the outside very complex on the inside.

![go/ast](https://cdn.rawgit.com/gmarik/go-erd/master/examples/net-http.svg)

## TODO

- [ ] cleanup

- [ ] exhaustive coverage for types

- [ ] flag to show only exported fields