介绍
# AgentLens - Codebase Navigation
## 在处理任何代码库之前 请务必先阅读 `.agentlens/INDEX.md` 以了解项目地图。
## 导航层级
| 层级 | 文件 | 用途 | |-------|------|---------| | L0 | `INDEX.md` | 项目概览，列出所有模块 | | L1 | `modules/{slug}/MODULE.md` | 模块详情，文件列表 | | L1 | `modules/{slug}/outline.md` | 大文件中的符号 | | L1 | `modules/{slug}/memory.md` | 待办事项 (TODOs)、警告、业务规则 | | L1 | `modules/{slug}/imports.md` | 文件依赖关系 | | L2 | `files/{slug}.md` | 复杂文件的深度文档 |
## 导航流程
``` INDEX.md → Find module → MODULE.md → outline.md/memory.md → Source file ```
## 何时阅读什么
| 当您需要 | 阅读此内容 | |----------|-----------| | 项目概览 | `.agentlens/INDEX.md` | | 查找模块 | INDEX.md，搜索模块名称 | | 理解模块 | `modules/{slug}/MODULE.md` | | 在大文件中查找函数/类 | `modules/{slug}/outline.md` | | 查找 TODOs、警告、规则 | `modules/{slug}/memory.md` | | 理解文件依赖 | `modules/{slug}/imports.md` |
## 最佳实践
1. **不要直接阅读源文件**——对于大型代码库，请先使用 outline.md 2. **在修改代码前检查 memory.md**，以查看警告和待办事项 3. **使用 outline.md 定位符号**，然后仅阅读所需的源代码部分 4. **如果文档看起来过时，请使用 `agentlens` 命令重新生成**
有关详细的导航模式，请参阅 [references/navigation.md](references/navigation.md) 有关结构说明，请参阅 [references/structure.md](references/structure.md)