README
¶
gograph
gograph is a local-only CLI tool designed to generate repository structures and improve IDE context awareness for codebases.
Note on Language Support: I originally built
gographspecifically for Golang because that is what I needed for my own workflows. It currently only parses and maps Go codebases. However, the architecture is extensible! If you want to add support for other languages (Python, TypeScript, Rust, etc.), contributions are more than welcome. Please see the Contributing Guide to get started.
Features
- Local Only: No network calls or external API dependencies. All analysis is done securely on your machine.
- Go Focused: Deeply understands Go project structures, packages, and dependencies.
- Fast: Written in Go for high performance.
Installation
go install github.com/ozgurcd/gograph@latest
Usage
Navigate to your Go project and run:
gograph path/to/repo
Contributing
We love pull requests! See the CONTRIBUTING.md file for guidelines on how to build, test, and contribute to the project. If you are adding support for a new language, please open an issue first to discuss the design.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gograph
command
Command gograph is the entrypoint for the gograph CLI tool.
|
Command gograph is the entrypoint for the gograph CLI tool. |
|
internal
|
|
|
cli
Package cli wires together the CLI commands.
|
Package cli wires together the CLI commands. |
|
graph
Package graph defines the core data model for the gograph tool.
|
Package graph defines the core data model for the gograph tool. |
|
parser
Package parser extracts graph nodes from a single Go source file using the standard go/ast and go/parser packages.
|
Package parser extracts graph nodes from a single Go source file using the standard go/ast and go/parser packages. |
|
report
Package report generates the human-readable GRAPH_REPORT.md file.
|
Package report generates the human-readable GRAPH_REPORT.md file. |
|
scanner
Package scanner walks the target repository and identifies Go files to parse.
|
Package scanner walks the target repository and identifies Go files to parse. |
|
search
Package search provides case-insensitive query matching over a Graph.
|
Package search provides case-insensitive query matching over a Graph. |