能做什么
codemap 为 Go 模块生成一页可交互的代码地图。在模块目录里用 Go 1.24 或更高版本执行一条 go run 命令,它就会写出一个 HTML 文件,列出每个包、每个包在模块内依赖哪些包,以及每个文件里的函数。用浏览器打开后可以搜索,点击某个包查看它用到了谁、又被谁使用;托管在 GitHub 上的模块还能直接跳到任意函数所在的行。布局上,底层基础包在下、命令在上,方框越宽函数越多,颜色区分顶层目录;测试、vendor 和 testdata 不计入。作者用 cobra、gin、hugo、prometheus 和 kubernetes 核对过统计结果,其中 Kubernetes 有 1278 个包、34823 个函数,不到两秒生成一个 4.5 MB 的页面。输出只是单个文件,不需要服务器,可以放在任何网站上,也能通过 GitHub Action 在持续集成里自动生成。作者还有一个做同样事情的 Perl 版本。采用 MIT 许可证。适合刚接手或长期维护大型 Go 项目的开发者。
适合谁
接手或维护大型 Go 项目的开发者。
主要使用场景
- 入职第一天快速摸清大型 Go 项目的结构
- 把可浏览的架构地图和项目文档一起发布
- 代码评审时发现包之间不该有的依赖

