codemap

What is codemap?

codemap generates a single HTML file that visualizes the structure of a Go module. It displays every package, the files within them, and the functions they contain. The output shows direct dependencies between packages, helping developers understand how different parts of a codebase connect.

Users can search the generated page and click on any package to see what it depends on and what depends on it. When the source is hosted on GitHub, the map includes links that jump directly to specific function lines in the repository. Test files, vendor directories, and folders containing their own go.mod files are excluded from the map.

The tool runs as a local command using Go 1.24 or later. It outputs a standalone HTML file that requires no server to run and can be shared or embedded anywhere. It also supports integration into GitHub Actions workflows for automated dependency mapping.

codemap features

• Generates a single standalone HTML file for Go modules
• Visualizes packages, dependencies, files, and functions
• Clickable navigation to view package relationships
• Direct links to GitHub function lines when applicable
• Integrates with GitHub Actions for CI/CD workflows
• Excludes test files and vendor directories automatically

Who uses codemap and for what

• Quickly understand the architecture of a new Go codebase
• Generate static documentation for team members without IDE access
• Automate dependency mapping in continuous integration pipelines
• Share project structure with stakeholders as a simple HTML file
• Navigate large Go projects by clicking through package dependencies

codemap FAQ

Comments (0)

Comments and upvotes open when this product launches on ProductPerch.