用途
AgentLens 用于导航和理解代码库,尤其适合在探索新项目、查找模块、在大型文件中定位符号等场景中使用。它通过一套分层文档,让使用者(包括 AI 代理)不必一开始就通读源码,而是先建立项目地图,再逐层深入。
主要能力
AgentLens 提供多级导航层次:
- L0:INDEX.md,提供项目总览,列出所有模块。
- L1:modules/{slug}/MODULE.md,提供模块详情与文件列表。
- L1:modules/{slug}/outline.md,列出大型文件中的符号。
- L1:modules/{slug}/memory.md,记录 TODO、警告与业务规则。
- L1:modules/{slug}/imports.md,描述文件依赖关系。
- L2:files/{slug}.md,为复杂文件提供深度文档。
使用方式
在任何代码库上工作之前,应先阅读 .agentlens/INDEX.md 获取项目地图。导航流程为:INDEX.md → 找到模块 → MODULE.md → outline.md/memory.md → 源文件。
按需求选择阅读对象:
- 需要项目总览:读 .agentlens/INDEX.md。
- 需要查找模块:在 INDEX.md 中搜索模块名。
- 需要理解某个模块:读 modules/{slug}/MODULE.md。
- 需要在大型文件中查找函数或类:读 modules/{slug}/outline.md。
- 需要查找 TODO、警告、规则:读 modules/{slug}/memory.md。
- 需要理解文件依赖:读 modules/{slug}/imports.md。
适用场景
适用于探索新项目、查找模块、在大型代码库中定位符号,以及需要了解文件依赖、TODO、警告与业务规则的场景。
限制与注意事项
对于大型代码库,不要直接阅读源文件,应先用 outline.md。修改代码前应检查 memory.md 以查看警告和 TODO。应使用 outline.md 定位符号,然后只阅读所需的源文件片段。如果文档看起来过时,可用 agentlens 命令重新生成。更详细的导航模式见 references/navigation.md,结构说明见 references/structure.md。