用途:AgentLens 面向代码库导航与理解,帮助在大型项目中快速找到模块、符号以及相关说明信息。
层级结构:L0 为 .agentlens/INDEX.md,提供项目概览与全部模块列表;L1 位于 modules/{slug}/ 下,包括 MODULE.md(模块详情与文件列表)、outline.md(大文件中的符号)、memory.md(TODO、警告、业务规则)、imports.md(文件依赖);L2 为 files/{slug}.md,用于复杂文件的深度文档。
使用方式:开始处理任何代码库前,先阅读 .agentlens/INDEX.md 获取项目地图;导航流程为 INDEX.md → 定位模块 → MODULE.md → outline.md/memory.md → 源文件。需要项目概览读 INDEX.md,查找模块在 INDEX.md 中搜索模块名,理解模块读 MODULE.md,在大文件中查找函数或类读 outline.md,查找 TODO、警告和规则读 memory.md,理解文件依赖读 imports.md。
最佳实践:大型代码库不要直接读源文件,先用 outline.md;修改代码前查看 memory.md 中的警告与 TODO;用 outline.md 定位符号后只读取所需的源代码片段;若文档显得过时,可使用 agentlens 命令重新生成。
适用与限制:适用于需要系统化理解代码结构的开发场景,尤其是模块众多或单文件较大的项目。其文档内容质量取决于生成情况,若过时需重新生成;详细导航模式与结构说明见 references/navigation.md 与 references/structure.md。其他具体功能、安装步骤与平台支持暂未提供。