repo-compass
一键生成代码库上下文文件,让AI快速理解项目结构。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:repo-compass。 它的用途是:一键生成代码库上下文文件,让AI快速理解项目结构。 完整的 Skill 内容见:https://321skill.com/skills/repo-compass/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'/repo-compass',它会自动运行扫描并读取生成的上下文文件,让你无需逐个文件提问,就能直接询问如‘这个项目的核心模块是哪个?’或‘请根据代码结构为我重构这个函数’等问题。
介绍
repo-compass 解决了AI在辅助开发时,因缺乏完整代码库上下文而理解困难、消耗大量Token的问题。它通过本地静态分析,扫描项目源代码,提取关键信息(如导出项、导入依赖),并生成一个高度浓缩的 CODEBASE.ctx 文件。
使用非常简单:在项目根目录下运行 repo-compass scan 命令,即可生成上下文文件。你可以将该文件内容直接粘贴给任何AI助手,或配合Claude Code的 /repo-compass 快捷命令,AI助手便能瞬间掌握整个项目的模块结构、核心文件和数据流向。
它非常适合需要AI深度介入代码理解、重构或开发辅助的开发者,尤其是全栈开发、后端开发以及智能体开发者,在处理陌生或复杂项目时能极大提升效率。
建议在项目开发中期或接手新项目时使用,以快速建立全局认知。对于超过300个文件的大型仓库,工具会自动启用紧凑模式以控制输出大小,使用 --all 参数可跳过确认提示。注意,它主要支持TypeScript、JavaScript和Python项目。
核心特点
与需要AI逐行读取代码或调用在线API的分析工具不同,repo-compass完全在本地运行,通过构建模块依赖图并智能识别核心模块(★),生成一个极其紧凑(通常低于2000Token)的上下文文件,为AI提供结构化、高信息密度的代码库全景视图,而非简单的文件列表。
注意事项
目前主要支持TypeScript、JavaScript和Python,对于其他语言或非标准项目结构的代码库分析能力有限。
常见问题
生成的CODEBASE.ctx文件安全吗?
安全,所有分析均在本地进行,无需上传代码或调用外部API。
支持哪些代码仓库?
支持包含TypeScript、JavaScript (ESM/CJS) 和Python文件的单仓库或monorepo项目。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/repo-compass/raw/index.md 读取 repo-compass 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/repo-compass/raw/index.md(查看排版版本)