用途:这是一个安装配置引导,帮助用户设置 Codemap CLI,以实现代码库的可视化与导航,并将其接入 Claude 的配置与钩子。
主要能力与用法:先确定配置存放位置,可选项目级共享(./CLAUDE.md 与 ./.claude/settings.json)、项目级个人(./CLAUDE.local.md 与 ./.claude/settings.local.json,需确认已加入 .gitignore)、或用户级全局(~/.claude/CLAUDE.md 与 ~/.claude/settings.json)。随后检查是否已安装(codemap -help),未安装则按平台执行:macOS/Linux 使用 brew tap JordanCoin/tap && brew install codemap;Windows 使用 scoop bucket add codemap https://github.com/JordanCoin/scoop-codemap 与 scoop install codemap。安装后用 codemap . 验证。
常用命令:codemap .(项目树)、codemap --only swift .、codemap --exclude .xcassets,Fonts,.png .、codemap --depth 2 .、codemap --diff、codemap --deps .;支持 --ref、--importers、--skyline、--json 等选项,模式匹配无需引号。若默认分支不是 main,需改用 --ref=master 等对应分支。
配置更新:在所选 CLAUDE.md 中说明必须使用 codemap --diff --ref master 研究分支差异,并用 git diff 与 git status 查看当前状态;在 .gitignore 加入 .codemap/;向设置文件添加钩子,可选 SessionStart、PreToolUse、PostToolUse、UserPromptSubmit、PreCompact、SessionEnd 等触发点。
限制:资料未提供 Codemap 的收费、价格、效果或平台细节;具体行为以实际安装与文档为准。