Agent Skills
› viralcode/openwhale
› agentlens
agentlens
GitHub提供代码库层级导航方法，通过读取INDEX.md等文档快速理解项目结构、定位模块与符号、查找TODO及依赖关系。适用于探索新项目或大型代码库时的高效浏览与分析场景。
Trigger Scenarios
探索新代码库
查找模块或符号
理解代码结构
查找TODO或警告
Install
npx skills add viralcode/openwhale --skill agentlens -g -y
SKILL.md
Frontmatter
{
"name": "agentlens",
"metadata": {
"author": "agentlens",
"version": "1.0",
"short-description": "Codebase navigation with agentlens"
},
"description": "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."
}
AgentLens - Codebase Navigation
Before Working on Any Codebase
Always start by reading .agentlens/INDEX.md for the project map.
Navigation Hierarchy
| 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 |
Navigation Flow
INDEX.md → Find module → MODULE.md → outline.md/memory.md → Source file
When To Read What
| 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 |
Best Practices
- Don't read source files directly for large codebases - use outline.md first
- Check memory.md before modifying code to see warnings and TODOs
- Use outline.md to locate symbols, then read only the needed source sections
- Regenerate docs with
agentlenscommand if they seem stale
For detailed navigation patterns, see references/navigation.md For structure explanation, see references/structure.md
Version History
- 238a4b1 Current 2026-08-20 08:20
