pkgviz-go

Generate a vizualization of a Go package's types.

This package is still v0. If you run into bugs, please report it in Issues ✍🏻

How does it work

pkgviz-go uses Go's type-checker to analyse a given go package, builds a graph of the types, writes it to DOT format, and generates an image of the graph using graphviz.

Installation

Ensure that you have graphviz installed:

• MacOS: brew install graphviz
• Windows: install the latest package from here
• Linux: follow your distribution's instructions here

Then install the pkgviz command:

go install github.com/tiegz/pkgviz-go/cmd/pkgviz

Usage

pkgviz A_GO_PKGNAME

The graph image is output to out.png.

Examples:

pkgviz github.com/tiegz/pkgviz-go

pkgviz time