SuperAPI AI 工具集

codemap

写作与研究

查看项目

更新于 10-15 16:48

技能介绍

用途:帮助用户理解和映射代码仓库,生成分层的 codemap(代码地图),并产出代码库文档;适用于开始接触陌生代码库的场景。

主要能力:为目录生成 codemap.md,记录职责、设计模式、数据与控制流、集成点;汇总为根级 Repository Atlas;通过文件与目录哈希检测变更并只更新受影响目录;在 AGENTS.md 中注册 ## Repository Map 以供自动加载。

使用方式:先检查仓库根目录是否存在 .slim/codemap.json;若不存在则检查旧路径 .slim/cartography.json,存在则迁移。无状态时执行初始化:node scripts/codemap.mjs init --root ./ --include "src//*.ts" --exclude "/*.test.ts" --exclude "dist/" --exclude "node_modules/"。已有状态时运行 node scripts/codemap.mjs changes --root ./,按受影响目录更新后运行 node scripts/codemap.mjs update --root ./。之后由 Orchestrator 维护根 codemap.md,并更新 AGENTS.md 的 Repository Map 段(幂等,已有则跳过)。

限制:被描述为昂贵操作,仅在用户明确要求代码库文档或映射时使用。默认排除测试、文档、翻译、构建产物与依赖;自动遵守 .gitignore。未提供价格、平台或效果数据。