Repomix 入门指南：将整个代码库打包成 AI 友好的单文件-北京尧图网络

Repomix 入门指南将整个代码库打包成 AI 友好的单文件【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix导读Repomix 是一款将整个 Git 仓库打包为单个 AI 友好文件的命令行工具专为向 ChatGPT、Claude、Gemini、Grok、DeepSeek、Perplexity、Gemma、Llama 等大语言模型LLM提供代码库上下文而设计。本指南以 Repomix 官方韩语版快速入门文档website/client/src/ko/guide/index.md为主线结合仓库源码src/index.ts、src/config/configSchema.ts、src/config/defaultIgnore.ts 等深入讲解其设计动机、核心功能与实战用法。读完本文你将能在一分钟内完成代码库打包并喂给任意 AI 助手同时理解其 AI 优化输出、Token 计数、Git 集成、安全扫描与多格式输出五大核心能力背后的实现原理。为什么选择 Repomix让 AI 看到完整的代码库在直接使用 AI 辅助编码时最常见的问题是上下文不足——把代码片段逐个粘贴给 AI既繁琐又容易遗漏关键依赖。Repomix 的解决思路是把整个仓库合并成一个文件一次性作为上下文提供给 AI。正如官方文档所述Repomix 可以与 ChatGPT、Claude、Gemini、Grok 等任意订阅服务自由搭配使用Repomix 本身不额外收费。将代码库整体作为上下文后AI 无需逐文件浏览即可进行实现方案规划缺陷Bug排查第三方库安全审查项目文档生成这一设计目标在项目入口 src/index.ts 的导出中得到了印证pack、collectFiles、processFiles、searchFiles、generateFileTree、runSecurityCheck、TokenCounter等核心 API 全部对外暴露表明收集文件 → 处理 → 安全扫描 → 统计 Token → 生成输出是一条完整、可编程复用的流水线。快速开始一条命令生成 AI 就绪文件在项目目录下执行npx repomixlatest仅此而已Repomix 会在当前目录生成一个repomix-output.xml文件以 AI 友好的格式包含整个仓库。随后把该文件连同如下提示词一起发送给 AI 助手이 파일에는 저장소의 모든 파일이 하나로 결합되어 있습니다. 코드를 리팩터링하고 싶으니 먼저 검토해 주세요.该文件包含了仓库中所有文件的合并内容。我想重构代码请先进行审查。AI 即可分析整个代码库并给出全面洞察当讨论具体改动时借助 Claude 的 Artifacts 等功能它甚至能输出多个相互依赖的文件。关于输出的细节默认输出文件名为repomix-output.xml这一定义可在 configSchema.ts 中的defaultFilePathMap找到xml、markdown、plain、json四种风格各有独立默认文件名。输出文件以对 AI 友好的说明开头file summary随后是目录结构directory structure、文件内容files与自定义指令instruction区块方便 AI 理解仓库的组织方式。核心功能详解AI 优化输出为 LLM 量身定制的格式Repomix 将代码库整理为 AI 易于理解与处理的结构化格式并以清晰的区块分隔不同部分。其底层由 src/core/output/ 目录下的输出风格模块markdownStyle.ts、plainStyle.ts、xmlStyle.ts等与 src/core/output/outputGenerate.ts 驱动。默认使用 XML 风格——XML 标签如file_summary、directory_structure、files、instruction能帮助模型更准确地解析多层上下文这也是 Repomix 默认选择 XML 的原因之一。Token 计数精准掌控上下文窗口LLM 都有上下文窗口限制因此 Repomix 内置了逐文件与全仓库的 Token 统计能力。运行repomix --token-count-tree可查看带 Token 数的层级树状视图帮助识别占用 Token 最多的文件并据此规划--include/--ignore筛选或压缩策略。计数引擎位于 src/core/metrics/核心是TokenCounterTokenCounter.ts与编码映射 tokenEncodings.ts。默认使用 OpenAI 兼容的o200k_base编码对应 GPT-4o可通过配置tokenCount.encoding切换为cl100k_baseGPT-3.5/4等见 configSchema.ts。Git 集成自动尊重版本控制规则Repomix 会自动读取并尊重项目的.gitignore与.git/info/exclude文件避免把被版本控制忽略的文件打进输出。进一步地output.git配置还支持sortByChanges默认true按 Git 修改频率排序文件改动越多的文件排在输出末尾includeDiffs把工作区与暂存区的未提交改动作为 Git diff 区块加入输出includeLogs/includeLogsCount默认 50把最近提交的日期、消息与涉及文件加入输出让 AI 理解代码演化与开发模式这些能力对应 src/core/git/ 下的gitDiffHandle.ts、gitLogHandle.ts、gitRemoteHandle.ts等实现并由 tests/core/git/ 中的测试用例覆盖验证。安全优先Secretlint 自动检测敏感信息Repomix 集成 Secretlint 对输出内容进行安全扫描自动检测并排除匹配已知凭据格式的文件防止 API 密钥、访问令牌、私钥、密码等敏感凭据被意外带入 AI 上下文。安全开关为配置项security.enableSecurityCheck默认true见 configSchema.tsCLI 可用--no-security-check关闭。底层实现在 src/core/security/securityCheck.ts配套测试见 tests/core/security/securityCheck.test.ts。多种输出格式按 AI 工具自由选择除默认的 XML 外Repomix 支持--style参数切换四种格式格式命令适用场景XML默认repomix --style xml结构分层清晰利于 AI 解析多组件上下文Markdownrepomix --style markdown人机皆宜、可读性好JSONrepomix --style json程序化处理、API 集成、jq提取数据纯文本repomix --style plain最简形式兼容性最好安装与后续探索路线Repomix 提供多种安装方式详见安装指南不安装即可通过npx repomixlatest临时使用长期使用可全局安装npm install -g repomix、yarn global add repomix、brew install repomix等还可在隔离环境用 Docker 运行或通过社区维护的 VSCode 扩展与浏览器扩展在编辑器/GitHub 页面一键打包。需注意环境要求Node.js 22.0.0 及以上处理远程仓库时需要 Git见 package.json 中声明的 engines 字段。掌握基础用法后建议按如下路径继续深入基础使用指南目录打包、文件筛选、stdin 管道、输出拆分、Git 集成配置指南repomix.config.json/ TS / JS 配置、include/ignore 模式、文件处理器安全功能了解安全扫描的检测范围输出格式选择最适合你的 AI 模型的输出格式MCP 服务器通过 Model Context Protocol 将 Repomix 直接集成进 AI 助手从源码理解 Repomix 的设计如果你想深入了解实现细节仓库本身提供了很好的学习路径配置模式configSchema.ts 使用 Valibot 定义了完整的配置 Schema集中呈现了所有配置项及其默认值如maxFileSize默认 50MB、topFilesLength默认 5、git.includeLogsCount默认 50。默认忽略列表defaultIgnore.ts 内置了.git/**、**/node_modules/**、coverage/**、dist/**、**/*.log、**/package-lock.json等大量跨语言默认忽略模式这是默认开箱即用的基础。公共 APIsrc/index.ts 展示了完整的程序化接口除pack外还提供defineConfig类型安全的配置函数、loadFileConfig、mergeConfigs、cli等意味着你可以在自己的工具链中以库的方式调用 Repomix。测试覆盖tests/ 下存在大量针对文件收集fileSearch.test.ts、Git 集成、安全扫描、Token 计数的测试可作为理解各模块行为的活文档。总体而言Repomix 的价值在于一次打包、处处可用把上下文准备这一重复性工作自动化让你和 AI 都把精力放在真正重要的代码分析与实现上。【免费下载链接】repomix Repomix is a powerful tool that packs your entire repository into a single, AI-friendly file. Perfect for when you need to feed your codebase to Large Language Models (LLMs) or other AI tools like Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok, and more.项目地址: https://gitcode.com/GitHub_Trending/rep/repomix创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考

Repomix 入门指南：将整个代码库打包成 AI 友好的单文件

相关推荐

猫抓浏览器资源嗅探扩展：从网页视频到本地 MP4 完整指南

qwen-code 输出 Token 上限自适应升级（Adaptive Output Token Escalation）机制解析

kkFileView JDK8/JDK11 版本选型：国产化部署的三问实用指南

更多资讯

EDA篮球计分器设计：Verilog状态机与七段数码管动态扫描实战

Altium Designer实战：CR2032/CR1220电池座AD集成库制作全流程

自考备考工具全攻略：提升学习效率的10类必备工具

ToolJet 集成 Stripe 数据源完全指南：连接配置、查询操作与 API 底层实现解析

TDengine PI Data Ingestion CSV Model Configuration File Reference

Java Web外卖系统实战：Servlet+JSP+MySQL完整开发指南

今日更新

AI驱动的自动化专利分析平台技术解析

LeetCode-Go 题解：1252. Cells with Odd Values in a Matrix（奇数值单元格计数）双解法剖析

在线答疑系统Java毕设实战：Spring Boot前后端分离与状态流转

本周精选

AI驱动的自动化专利分析平台技术解析

LeetCode-Go 题解：1252. Cells with Odd Values in a Matrix（奇数值单元格计数）双解法剖析

在线答疑系统Java毕设实战：Spring Boot前后端分离与状态流转

本月热门

基于YOLO的焊缝缺陷检测：从数据标注到工业部署全流程实践

分布式服务的决策记录

创业产品的首版范围

读完文章，想聊聊您的网站？