English | 中文
AI 友好的源码索引生成器。从源文件中提取符号，输出结构化 Markdown 供 LLM 使用。
npm install -g agent-codemap更新到最新版本：
agent-codemap --update# 为当前目录生成索引（输出到 stdout）
agent-codemap .
# 为指定文件生成索引
agent-codemap src/main.rs
# 输出 JSON 格式
agent-codemap . --format json
# 保存到文件
agent-codemap . > codemap.md输入 src/user.py：
class User:
def __init__(self, name):
self.name = name
def validate(self):
return len(self.name) > 0
def create_user(name):
return User(name)输出：
# src/user.py
- [class] `User` (line 1)
- [method] `__init__` (line 2)
- [method] `validate` (line 5)
- [function] `create_user` (line 9)| 语言 | 扩展名 |
|---|---|
| Python | .py, .pyi |
| TypeScript | .ts, .tsx |
| JavaScript | .js, .mjs, .cjs, .jsx |
| Go | .go |
| Rust | .rs |
| Java | .java |
| C | .c, .h |
| C++ | .cpp, .cc, .cxx, .hpp, .hxx |
| Ruby | .rb |
| Swift | .swift |
| Objective-C | .m, .mm |
| Kotlin | .kt, .kts |
| C# | .cs |
| Markdown | .md, .markdown |
- 输出到 stdout（管道友好）
- 支持 Markdown 和 JSON 格式
- 自动遵循
.gitignore - 嵌套符号提取（类内方法等）
最简单的方式 - 直接让 Agent 使用：
用 agent-codemap 了解项目结构。运行 agent-codemap --help 查看用法。
--help 输出足够详细，大多数 Agent 能自己搞定。
想要更稳定的效果，添加到项目指令文件中：
## 代码结构
使用 `agent-codemap` 获取代码大纲。运行 `agent-codemap --help` 查看所有选项。
用法：
- `agent-codemap .` - 扫描整个项目
- `agent-codemap src/` - 扫描指定目录
- `agent-codemap path/to/file.py` - 扫描单个文件
输出格式（每个文件一个章节）：
```
# path/to/file.py
- [class] `ClassName` (line N)
- [method] `method_name` (line N)
- [variable] `var_name` (line N)
- [function] `func_name` (line N)
```
符号类型：class, function, method, variable, constant, interface, enum, module, property, constructor, field, type, namespaceMIT