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/repomixRepomix 是一款把整个代码仓库打包成单一、AI 友好文件的命令行工具专为将代码库投喂给 ChatGPT、Claude、Gemini、Grok、DeepSeek、Perplexity、Gemma、Llama 等大语言模型LLM而设计。本文以 Repomix 官方「快速开始」指南为骨架结合本仓库源码与配置讲解从运行第一条命令到善用配置、安全检测与多输出格式的完整实践读完即可把任意项目压缩成一份可直接交给 AI 分析的上下文文件。快速开始一条命令打包整个仓库在项目目录下运行npx repomixlatest无需先安装npx会直接拉取并运行 Repomix。执行完成后目录中会生成一个repomix-output.xml文件其中包含整个仓库的 AI 友好格式内容。随后即可把该文件发送给 AI 助手并附上如下提示该文件将仓库中的所有文件合并为一个整体。 我想重构代码请先对整体进行审查。AI 会基于完整的代码库上下文给出全面分析。当你讨论具体改动时AI 也能直接辅助生成代码借助 Claude 的 Artifacts 等功能甚至可以同时接收多个相互依赖的文件。说明该文档示例默认生成repomix-output.xml因为 Repomix 的默认输出风格是 XML详见下文「输出格式」一节默认输出路径正是repomix-output.xml见仓库根目录的 repomix.config.json。为什么选择 RepomixRepomix 的价值在于无需担心订阅制服务的成本即可将完整代码库作为上下文提供给 ChatGPT、Claude、Gemini、Grok 等模型。它消除了逐个文件导航的成本为 AI 提供完整代码库上下文让分析更快、也往往更准确。当整个代码库都作为上下文可用时Repomix 支持广泛的使用场景包括应用规划application planningBug 排查bug investigation第三方库安全审查third-party library security checks文档生成documentation generation以及更多核心特性官方文档总结的五大核心特性均可在本仓库源码中找到对应实现特性说明对应实现AI 优化输出以 AI 易于处理的方式编排代码库内容src/core/output/outputGenerate.ts 中基于 Handlebars 模板渲染生成Token 计数跟踪 Token 用量以匹配 LLM 上下文限制src/core/metrics/TokenCounter.tsGit 感知遵循.gitignore与.git/info/excludesrc/core/file/fileSearch.ts安全优先检测敏感信息src/core/security/securityCheck.ts多输出格式可选纯文本、XML 或 Markdownsrc/core/output/outputStyles/下面分别深入解析这些特性在源码层面的实现。AI 优化输出与多输出格式Repomix 支持多种输出风格。从 src/config/configSchema.ts 的配置模式可以看到输出风格支持xml、markdown、json、plain四种取值export const repomixOutputStyleSchema v.picklist([xml, markdown, json, plain]);而输出生成的底层实现位于 src/core/output/outputGenerate.ts它按风格选择对应的 Handlebars 模板markdownStyle.ts、plainStyle.ts、xmlStyle.ts并将模板编译结果缓存以避免重复编译Markdown 模板还会根据内容中最长的反引号串动态计算代码围栏分隔符防止内容中的 提前闭合围栏而破坏输出结构。仓库根目录的 repomix.config.json 展示了默认配置output.style为xml、output.filePath为repomix-output.xml这正是快速开始中生成 XML 文件的原因。Token 计数控制上下文预算Token 计数是 Repomix 面向 LLM 上下文限制的关键能力。在 src/core/metrics/TokenCounter.ts 中TokenCounter基于gpt-tokenizer的 BPEByte Pair Encoding分词实现支持o200k_base等编码并通过resolveEncodingAsync懒加载编码数据用PLAIN_TEXT_OPTIONSdisallowedSpecial: new Set()把所有内容当作普通文本计数避免特殊 token 干扰统计。配置层面Token 计数相关参数可通过 repomix.config.json 中的tokenCount与output.tokenCountTree控制例如{ tokenCount: { encoding: o200k_base }, output: { tokenCountTree: 50000 } }tokenCountTree用于控制 token 树状统计信息的生成阈值。对应测试见 tests/core/metrics/TokenCounter.test.ts覆盖了普通文本、空字符串、多行文本、特殊字符、Unicode 文本你好世界等场景的计数正确性。Git 感知尊重忽略规则Repomix 会遵循项目的.gitignore与.git/info/exclude。在 src/core/file/fileSearch.ts 中可以看到忽略控制文件包括.gitignore、.ignore、.repomixignore当启用config.ignore.useGitignore时.gitignore交由 globby 的 gitignore 选项处理以正确遵循父目录的.gitignore与 Git 行为一致.git/info/exclude也会被读取并加入忽略模式.git目录本身会被排除。安全优先敏感信息检测Repomix 内置安全检测机制。src/core/security/securityCheck.ts 中的runSecurityCheck将文件内容以及可选的 Git diff、Git log 内容分批每批 50 项交给工作线程执行检测最多并发 2 个安全检测 worker以避免与指标计算的 worker 池争抢资源。底层检测引擎基于 Secretlint 的推荐规则集secretlint/secretlint-rule-preset-recommend见 src/core/security/workers/securityCheckWorker.ts可识别 API 密钥等敏感信息。在 repomix.config.json 中通过如下配置启用{ security: { enableSecurityCheck: true } }需要注意的是安全检测是辅助手段分享私有或敏感代码给任何 AI 服务前仍应自行审查生成结果。从repomix.config.json看完整配置骨架仓库根目录的 repomix.config.json 是理解 Repomix 配置的绝佳范本涵盖输入、输出、忽略、安全与 Token 计数等全部维度{ $schema: https://repomix.com/schemas/latest/schema.json, input: { maxFileSize: 50000000 }, output: { filePath: repomix-output.xml, style: xml, parsableStyle: false, compress: false, headerText: This repository contains the source code for the Repomix tool.\nRepomix is designed to pack repository contents into a single file,\nmaking it easier for AI systems to analyze and process the codebase., instructionFilePath: repomix-instruction.md, fileSummary: true, directoryStructure: true, files: true, removeComments: false, removeEmptyLines: false, topFilesLength: 5, showLineNumbers: false, includeEmptyDirectories: true, truncateBase64: true, tokenCountTree: 50000, git: { sortByChanges: true, sortByChangesMaxCommits: 100, includeDiffs: true, includeLogs: true, includeLogsCount: 50 } }, include: [], ignore: { useGitignore: true, useDefaultPatterns: true, customPatterns: [] }, security: { enableSecurityCheck: true }, tokenCount: { encoding: o200k_base } }各字段含义速览配置项取值作用input.maxFileSize字节数单文件大小上限超过则跳过output.filePath/output.style路径 /xml等输出文件路径与格式output.parsableStyle/compress布尔是否生成可解析风格、是否压缩注释/空行output.headerText字符串输出文件头部的自定义说明文本output.instructionFilePath路径附加给 AI 的使用说明文件output.fileSummary/directoryStructure/files布尔是否输出文件摘要、目录结构、文件内容output.removeComments/removeEmptyLines布尔是否移除注释与空行减小 Tokenoutput.topFilesLength/showLineNumbers数字 / 布尔文件统计排序展示数量、是否显示行号output.truncateBase64布尔是否截断 base64 内容output.tokenCountTree数字Token 树统计阈值output.git.*—Git 变更排序、diff 与 log 是否包含ignore.useGitignore/useDefaultPatterns/customPatterns—忽略策略遵循 .gitignore、默认模式、自定义模式security.enableSecurityCheck布尔是否启用安全检测tokenCount.encoding编码名Token 计数所用编码当项目过大、超出目标模型上下文窗口时官方还建议使用--include、--ignore、--compress、--remove-comments等命令行参数来裁剪内容需要可复现的、项目级配置时可使用repomix --init生成配置文件。这些参数最终都会经 src/cli/actions/defaultAction.ts 中的buildMergedConfig合并为最终配置其流程为先运行迁移将旧版 Repopack 配置改写为 repomix 配置、再加载文件配置repomix.config.*、解析 CLI 参数最后通过mergeConfigs合并默认配置、文件配置与 CLI 配置优先级为 CLI 参数 文件配置 默认值。快速上手的完整流水线一条命令背后发生了什么从源码结构看npx repomixlatest的执行链路可概括为文件搜索 → 文件收集 → 路径排序 → 文件处理 → 安全检测 → 指标Token计算 → 输出生成 → 写出文件。核心编排位于 src/core/packager.ts 的pack函数其中包含若干值得注意的实现细节Token 缓存预加载pack一开始就异步加载 Token 计数缓存使其与文件搜索、收集阶段并行避免在指标阶段阻塞排序数据预取在搜索与收集进行的同时预取 Git 文件变更次数供后续sortOutputFiles直接命中缓存安全检测并行化见上文「安全优先」一节。这些并行化设计让打包大仓库时更高效也是「整个代码库作为上下文」能力得以落地的底层保障。从官方指南继续深入本文对应官方文档的入门章节若需进一步掌握可在本仓库的指南目录中继续阅读安装指南Repomix 的不同安装方式使用指南基础与高级功能配置指南按需定制 Repomix安全特性安全检测机制详解输出格式为你的 AI 模型选择最佳格式MCP 服务器将 Repomix 直接集成到 AI 助手中命令行选项--include、--ignore、--compress等参数的完整说明若要在本地对 Repomix 进行二次开发或运行测试可参照根目录 package.jsonnpm run build编译 TypeScriptnpm test运行 vitest 测试套件打包自己仓库时可直接npm run repomix等价于构建后执行bin/repomix.cjs。最后尝试用一条命令开启你的 AI 驱动开发工作流吧npx repomixlatest【免费下载链接】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 友好的单文件上下文
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/repomixRepomix 是一款把整个代码仓库打包成单一、AI 友好文件的命令行工具专为将代码库投喂给 ChatGPT、Claude、Gemini、Grok、DeepSeek、Perplexity、Gemma、Llama 等大语言模型LLM而设计。本文以 Repomix 官方「快速开始」指南为骨架结合本仓库源码与配置讲解从运行第一条命令到善用配置、安全检测与多输出格式的完整实践读完即可把任意项目压缩成一份可直接交给 AI 分析的上下文文件。快速开始一条命令打包整个仓库在项目目录下运行npx repomixlatest无需先安装npx会直接拉取并运行 Repomix。执行完成后目录中会生成一个repomix-output.xml文件其中包含整个仓库的 AI 友好格式内容。随后即可把该文件发送给 AI 助手并附上如下提示该文件将仓库中的所有文件合并为一个整体。 我想重构代码请先对整体进行审查。AI 会基于完整的代码库上下文给出全面分析。当你讨论具体改动时AI 也能直接辅助生成代码借助 Claude 的 Artifacts 等功能甚至可以同时接收多个相互依赖的文件。说明该文档示例默认生成repomix-output.xml因为 Repomix 的默认输出风格是 XML详见下文「输出格式」一节默认输出路径正是repomix-output.xml见仓库根目录的 repomix.config.json。为什么选择 RepomixRepomix 的价值在于无需担心订阅制服务的成本即可将完整代码库作为上下文提供给 ChatGPT、Claude、Gemini、Grok 等模型。它消除了逐个文件导航的成本为 AI 提供完整代码库上下文让分析更快、也往往更准确。当整个代码库都作为上下文可用时Repomix 支持广泛的使用场景包括应用规划application planningBug 排查bug investigation第三方库安全审查third-party library security checks文档生成documentation generation以及更多核心特性官方文档总结的五大核心特性均可在本仓库源码中找到对应实现特性说明对应实现AI 优化输出以 AI 易于处理的方式编排代码库内容src/core/output/outputGenerate.ts 中基于 Handlebars 模板渲染生成Token 计数跟踪 Token 用量以匹配 LLM 上下文限制src/core/metrics/TokenCounter.tsGit 感知遵循.gitignore与.git/info/excludesrc/core/file/fileSearch.ts安全优先检测敏感信息src/core/security/securityCheck.ts多输出格式可选纯文本、XML 或 Markdownsrc/core/output/outputStyles/下面分别深入解析这些特性在源码层面的实现。AI 优化输出与多输出格式Repomix 支持多种输出风格。从 src/config/configSchema.ts 的配置模式可以看到输出风格支持xml、markdown、json、plain四种取值export const repomixOutputStyleSchema v.picklist([xml, markdown, json, plain]);而输出生成的底层实现位于 src/core/output/outputGenerate.ts它按风格选择对应的 Handlebars 模板markdownStyle.ts、plainStyle.ts、xmlStyle.ts并将模板编译结果缓存以避免重复编译Markdown 模板还会根据内容中最长的反引号串动态计算代码围栏分隔符防止内容中的 提前闭合围栏而破坏输出结构。仓库根目录的 repomix.config.json 展示了默认配置output.style为xml、output.filePath为repomix-output.xml这正是快速开始中生成 XML 文件的原因。Token 计数控制上下文预算Token 计数是 Repomix 面向 LLM 上下文限制的关键能力。在 src/core/metrics/TokenCounter.ts 中TokenCounter基于gpt-tokenizer的 BPEByte Pair Encoding分词实现支持o200k_base等编码并通过resolveEncodingAsync懒加载编码数据用PLAIN_TEXT_OPTIONSdisallowedSpecial: new Set()把所有内容当作普通文本计数避免特殊 token 干扰统计。配置层面Token 计数相关参数可通过 repomix.config.json 中的tokenCount与output.tokenCountTree控制例如{ tokenCount: { encoding: o200k_base }, output: { tokenCountTree: 50000 } }tokenCountTree用于控制 token 树状统计信息的生成阈值。对应测试见 tests/core/metrics/TokenCounter.test.ts覆盖了普通文本、空字符串、多行文本、特殊字符、Unicode 文本你好世界等场景的计数正确性。Git 感知尊重忽略规则Repomix 会遵循项目的.gitignore与.git/info/exclude。在 src/core/file/fileSearch.ts 中可以看到忽略控制文件包括.gitignore、.ignore、.repomixignore当启用config.ignore.useGitignore时.gitignore交由 globby 的 gitignore 选项处理以正确遵循父目录的.gitignore与 Git 行为一致.git/info/exclude也会被读取并加入忽略模式.git目录本身会被排除。安全优先敏感信息检测Repomix 内置安全检测机制。src/core/security/securityCheck.ts 中的runSecurityCheck将文件内容以及可选的 Git diff、Git log 内容分批每批 50 项交给工作线程执行检测最多并发 2 个安全检测 worker以避免与指标计算的 worker 池争抢资源。底层检测引擎基于 Secretlint 的推荐规则集secretlint/secretlint-rule-preset-recommend见 src/core/security/workers/securityCheckWorker.ts可识别 API 密钥等敏感信息。在 repomix.config.json 中通过如下配置启用{ security: { enableSecurityCheck: true } }需要注意的是安全检测是辅助手段分享私有或敏感代码给任何 AI 服务前仍应自行审查生成结果。从repomix.config.json看完整配置骨架仓库根目录的 repomix.config.json 是理解 Repomix 配置的绝佳范本涵盖输入、输出、忽略、安全与 Token 计数等全部维度{ $schema: https://repomix.com/schemas/latest/schema.json, input: { maxFileSize: 50000000 }, output: { filePath: repomix-output.xml, style: xml, parsableStyle: false, compress: false, headerText: This repository contains the source code for the Repomix tool.\nRepomix is designed to pack repository contents into a single file,\nmaking it easier for AI systems to analyze and process the codebase., instructionFilePath: repomix-instruction.md, fileSummary: true, directoryStructure: true, files: true, removeComments: false, removeEmptyLines: false, topFilesLength: 5, showLineNumbers: false, includeEmptyDirectories: true, truncateBase64: true, tokenCountTree: 50000, git: { sortByChanges: true, sortByChangesMaxCommits: 100, includeDiffs: true, includeLogs: true, includeLogsCount: 50 } }, include: [], ignore: { useGitignore: true, useDefaultPatterns: true, customPatterns: [] }, security: { enableSecurityCheck: true }, tokenCount: { encoding: o200k_base } }各字段含义速览配置项取值作用input.maxFileSize字节数单文件大小上限超过则跳过output.filePath/output.style路径 /xml等输出文件路径与格式output.parsableStyle/compress布尔是否生成可解析风格、是否压缩注释/空行output.headerText字符串输出文件头部的自定义说明文本output.instructionFilePath路径附加给 AI 的使用说明文件output.fileSummary/directoryStructure/files布尔是否输出文件摘要、目录结构、文件内容output.removeComments/removeEmptyLines布尔是否移除注释与空行减小 Tokenoutput.topFilesLength/showLineNumbers数字 / 布尔文件统计排序展示数量、是否显示行号output.truncateBase64布尔是否截断 base64 内容output.tokenCountTree数字Token 树统计阈值output.git.*—Git 变更排序、diff 与 log 是否包含ignore.useGitignore/useDefaultPatterns/customPatterns—忽略策略遵循 .gitignore、默认模式、自定义模式security.enableSecurityCheck布尔是否启用安全检测tokenCount.encoding编码名Token 计数所用编码当项目过大、超出目标模型上下文窗口时官方还建议使用--include、--ignore、--compress、--remove-comments等命令行参数来裁剪内容需要可复现的、项目级配置时可使用repomix --init生成配置文件。这些参数最终都会经 src/cli/actions/defaultAction.ts 中的buildMergedConfig合并为最终配置其流程为先运行迁移将旧版 Repopack 配置改写为 repomix 配置、再加载文件配置repomix.config.*、解析 CLI 参数最后通过mergeConfigs合并默认配置、文件配置与 CLI 配置优先级为 CLI 参数 文件配置 默认值。快速上手的完整流水线一条命令背后发生了什么从源码结构看npx repomixlatest的执行链路可概括为文件搜索 → 文件收集 → 路径排序 → 文件处理 → 安全检测 → 指标Token计算 → 输出生成 → 写出文件。核心编排位于 src/core/packager.ts 的pack函数其中包含若干值得注意的实现细节Token 缓存预加载pack一开始就异步加载 Token 计数缓存使其与文件搜索、收集阶段并行避免在指标阶段阻塞排序数据预取在搜索与收集进行的同时预取 Git 文件变更次数供后续sortOutputFiles直接命中缓存安全检测并行化见上文「安全优先」一节。这些并行化设计让打包大仓库时更高效也是「整个代码库作为上下文」能力得以落地的底层保障。从官方指南继续深入本文对应官方文档的入门章节若需进一步掌握可在本仓库的指南目录中继续阅读安装指南Repomix 的不同安装方式使用指南基础与高级功能配置指南按需定制 Repomix安全特性安全检测机制详解输出格式为你的 AI 模型选择最佳格式MCP 服务器将 Repomix 直接集成到 AI 助手中命令行选项--include、--ignore、--compress等参数的完整说明若要在本地对 Repomix 进行二次开发或运行测试可参照根目录 package.jsonnpm run build编译 TypeScriptnpm test运行 vitest 测试套件打包自己仓库时可直接npm run repomix等价于构建后执行bin/repomix.cjs。最后尝试用一条命令开启你的 AI 驱动开发工作流吧npx repomixlatest【免费下载链接】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），仅供参考