https://github.com/bayraktugrul/modview
Effortlessly visualize mod graph with all external dependencies for your Go projects
https://github.com/bayraktugrul/modview
dependency dependency-graph go golang graph visualize
Last synced: 3 months ago
JSON representation
Effortlessly visualize mod graph with all external dependencies for your Go projects
- Host: GitHub
- URL: https://github.com/bayraktugrul/modview
- Owner: bayraktugrul
- License: mit
- Created: 2024-09-04T21:47:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-19T18:09:36.000Z (over 1 year ago)
- Last Synced: 2024-12-19T19:21:52.980Z (over 1 year ago)
- Topics: dependency, dependency-graph, go, golang, graph, visualize
- Language: Go
- Homepage:
- Size: 4.69 MB
- Stars: 179
- Watchers: 1
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
__ ___ __ _
/ |/ /__ ___/ / __(_)__ _ __
/ /|_/ / _ \/ _ / |/ / / -_) |/|/ /
/_/ /_/\___/\_,_/|___/_/\__/|__,__/
[![][workflow-badge]][workflow-actions] [![Release][release-badge]][release] [![][license-badge]][license]
[](https://github.com/nikolaydubina/go-recipes)
Transform your Go project's dependency graph into a dynamic, interactive visualization with modview.
This powerful tool takes the complexity out of your module graph, offering a clear and explorable view of your
project's dependencies.
`modview` leverages the output of `go mod graph` to create a browser-based visualization,
enabling you to navigate, search, and understand your dependency structure effortlessly.
Whether you're optimizing your codebase, resolving version conflicts, or exploring the ecosystem
surrounding your project, modview is your guide through the intricate web of Go modules.
## Features
**Interactive HTML Visualization:** Generate a dynamic, browser-friendly graph of your Go module dependencies.
**Dependency Highlighting:** Easily distinguish between picked and unpicked dependencies, as determined
by the `Minimal Version Selection (MVS)` algorithm.
**Intuitive Navigation:** Zoom, pan, and explore large dependency graphs with ease.
**Search Functionality:** Quickly locate specific dependencies within your graph.
**Dark Mode Support:** Seamlessly switch between light and dark themes for a comfortable viewing experience, especially during late-night coding sessions.
## Installation
### Option 1
To install modview, use the following command:
```bash
go install github.com/bayraktugrul/modview@latest
```
Ensure that your Go bin directory is in your system's PATH.
### Option 2
```bash
git clone https://github.com/bayraktugrul/modview.git
cd modview
go install
```
## Usage
Navigate to your Go project's root directory and run:
```
modview
```
This will generate a file named `dependency_tree.html` in the current directory. Open this file in a web browser to view
your module's dependency graph.
To automatically open the dependency graph in your default web browser, use the `--open` flag:
```
modview --open
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
[MIT License](LICENSE)
## Contact
For questions and feedback, please open an issue on the GitHub repository.
[workflow-actions]: https://github.com/bayraktugrul/modview/actions
[workflow-badge]: https://github.com/bayraktugrul/modview/workflows/build/badge.svg
[license]:https://github.com/bayraktugrul/modview/blob/main/LICENSE
[license-badge]:https://img.shields.io/badge/License-MIT-blue.svg
[release]: https://github.com/bayraktugrul/modview/releases
[release-badge]: https://img.shields.io/github/v/release/bayraktugrul/modview.svg