AgentSkillsCN

agentlens

借助 agentlens 层次化文档，轻松导航与理解代码库。适用于探索新项目、查找模块、在大型文件中定位符号、搜寻 TODO 或警告，或深入理解代码结构时使用。

SKILL.md
--- frontmatter
name: 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.
metadata:
  short-description: Codebase navigation with agentlens
  author: agentlens
  version: "1.0"

AgentLens - Codebase Navigation

Before Working on Any Codebase

Always start by reading .agentlens/INDEX.md for the project map.

Navigation Hierarchy

LevelFilePurpose
L0INDEX.mdProject overview, all modules listed
L1modules/{slug}/MODULE.mdModule details, file list
L1modules/{slug}/outline.mdSymbols in large files
L1modules/{slug}/memory.mdTODOs, warnings, business rules
L1modules/{slug}/imports.mdFile dependencies
L2files/{slug}.mdDeep docs for complex files

Navigation Flow

code
INDEX.md → Find module → MODULE.md → outline.md/memory.md → Source file

When To Read What

You NeedRead This
Project overview.agentlens/INDEX.md
Find a moduleINDEX.md, search module name
Understand a modulemodules/{slug}/MODULE.md
Find function/class in large filemodules/{slug}/outline.md
Find TODOs, warnings, rulesmodules/{slug}/memory.md
Understand file dependenciesmodules/{slug}/imports.md

Best Practices

  1. •Don't read source files directly for large codebases - use outline.md first
  2. •Check memory.md before modifying code to see warnings and TODOs
  3. •Use outline.md to locate symbols, then read only the needed source sections
  4. •Regenerate docs with agentlens command if they seem stale

For detailed navigation patterns, see references/navigation.md For structure explanation, see references/structure.md