README
¶
godepgraph is a packages dependency graph visualization tool for your local go module project.
install
go install github.com/alovn/godepgraph@latest
How to use
path
You need run godepgraph in your go module project path, or use the parameter --path:
godepgraph --path=/workspace/bytego
bytego/internal/bytebufferpool
bytego/internal/fasttemplate
└── bytego/internal/bytebufferpool
bytego/middleware/cors
└── bytego
bytego/middleware/logger
├── bytego
└── bytego/internal/fasttemplate
bytego/middleware/pprof
└── bytego
bytego/middleware/recovery
└── bytego
bytego
pkg
If you want to display a specified package dependency, You need to know the parameter --pkg isn't the full pkg name, for examples the full pkg name is github.com/gostack-labs/bytego/middleware/cors, the --pkg parameter use a short pkg name: bytego/middleware/cors.
godepgraph --pkg=bytego/middleware/cors
bytego/middleware/cors
└── bytego
reverse
List dependent packages, need parameter --pkg.
godepgraph --pkg=bytego --reverse
bytego
├── bytego/middleware/cors
├── bytego/middleware/logger
├── bytego/middleware/pprof
└── bytego/middleware/recovery
std and thrid
The standard pkg and third pkg of dependence is not displayed by default, if want display it:
godepgraph --std --third
web
You can also start a local web server, and view the graph in a web browser, default listening localhost:7788.
godepgraph --web
godepgraph --web --listen=:8080
output
If you have the graphviz tools installed, parameter --dot can get a picture, default: godepgraph.png. you can specify an output file with --output, supoort format:jpg,png,svg,gif,dot.
godepgraph --path=/workspace/bytego --dot
godepgraph --path=/workspace/bytego --dot --output=xx.svg
the picture of godepgraph.png like this:
mod graph
go mod graph tree display, for exampels:
godepgraph --mod
github.com/gostack-labs/bytego-examples
├──github.com/go-playground/validator/v10@v10.10.1
│ ├──github.com/leodido/go-urn@v1.2.1
│ │ └──github.com/stretchr/testify@v1.6.1
│ │ ├──github.com/stretchr/objx@v0.1.0
│ │ ├──gopkg.in/yaml.v3@v3.0.0-20200313102051-9f266ea9e77c
│ │ │ └──gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405
│ │ ├──github.com/davecgh/go-spew@v1.1.0
│ │ └──github.com/pmezard/go-difflib@v1.0.0
│ ├──github.com/rogpeppe/go-internal@v1.8.0
│ │ ├──github.com/pkg/diff@v0.0.0-20210226163009-20ebb0f2a09e
│ │ └──gopkg.in/errgo.v2@v2.1.0
│ │ ├──github.com/kr/pretty@v0.1.0
│ │ │ └──github.com/kr/text@v0.1.0
│ │ │ └──github.com/kr/pty@v1.1.1
│ │ └──gopkg.in/check.v1@v1.0.0-20180628173108-788fd7840127
│ ├──github.com/stretchr/testify@v1.7.0
│ │ ├──github.com/stretchr/objx@v0.1.0
│ │ ├──gopkg.in/yaml.v3@v3.0.0-20200313102051-9f266ea9e77c
│ │ │ └──gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405
│ │ ├──github.com/davecgh/go-spew@v1.1.0
│ │ └──github.com/pmezard/go-difflib@v1.0.0
...
search dependency, use --pkg:
godepgraph --mod --pkg=gopkg.in/errgo.v2@v2.1.0
gopkg.in/errgo.v2@v2.1.0
├──github.com/kr/pretty@v0.1.0
│ └──github.com/kr/text@v0.1.0
│ └──github.com/kr/pty@v1.1.1
└──gopkg.in/check.v1@v1.0.0-20180628173108-788fd7840127
reverse dependency, use --reverse:
godepgraph --mod --pkg=gopkg.in/errgo.v2@v2.1.0 --reverse
gopkg.in/errgo.v2@v2.1.0
github.com/rogpeppe/go-internal@v1.8.0
github.com/rogpeppe/go-internal@v1.6.1
Documentation
Source Files
Directories