Navigate and understand codebases using agentlens hierarchical documentation. Use when exploring new projects, finding modules, locating symbols in large files, finding TODOs/warnings, or understanding code structure. Use when this capability is needed.
Always start by reading .agentlens/INDEX.md for the project map.
| Level | File | Purpose |
|---|---|---|
| L0 | INDEX.md | Project overview, all modules listed |
| L1 | modules/{slug}/MODULE.md | Module details, file list |
| L1 | modules/{slug}/outline.md | Symbols in large files |
| L1 | modules/{slug}/memory.md | TODOs, warnings, business rules |
| L1 | modules/{slug}/imports.md | File dependencies |
| L2 |
files/{slug}.md| Deep docs for complex files |
INDEX.md → Find module → MODULE.md → outline.md/memory.md → Source file
| You Need | Read This |
|---|---|
| Project overview | .agentlens/INDEX.md |
| Find a module | INDEX.md, search module name |
| Understand a module | modules/{slug}/MODULE.md |
| Find function/class in large file | modules/{slug}/outline.md |
| Find TODOs, warnings, rules | modules/{slug}/memory.md |
| Understand file dependencies | modules/{slug}/imports.md |
agentlens command if they seem staleFor detailed navigation patterns, see references/navigation.md For structure explanation, see references/structure.md
Converted and distributed by TomeVault | Claim this content