Repomix 与 GitHub Actions 集成指南自动化打包代码库供 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 能够将整个仓库打包成单个 AI 友好的文件XML / Markdown / JSON / Plain Text而 GitHub Actions 可以把这一过程完全自动化每次推送、拉取请求或手动触发时自动生成打包产物供 CI 流程、代码评审以及 Claude、ChatGPT 等 LLM 工具消费。本文以官方 GitHub Actions 集成指南为主体结合 Repomix 仓库源码完整讲解 Action 的输入/输出参数、四种输出格式、智能压缩、产物上传与完整 Workflow 示例帮助你落地一套仓库即文档的自动化 AI 分析流水线。为什么要在 GitHub Actions 中使用 Repomix将 Repomix 集成到 GitHub Actions 工作流中可以自动完成代码库的打包过程省去每次手动执行命令的重复劳动。官方文档明确列出了三类典型用途持续集成CI在构建与测试之外同步产出可供 AI 分析的仓库快照代码评审Code Review让评审者或 AI 助手基于打包后的单一文件快速理解改动上下文为 LLM 工具准备输入将代码库整理成 Claude、ChatGPT、DeepSeek、Gemini 等模型可直接消费的结构化文本。从 defaultAction.ts 的runDefaultAction可以看出Repomix 的核心打包逻辑由pack()统一完成它接收目录列表、合并后的配置mergeConfigs合并默认值、配置文件与 CLI 参数GitHub Action 本质上就是把这个 CLI 调用封装成可复用的 YAML 步骤。基础用法把 Action 加入 Workflow在 workflow YAML 中添加一个 step 即可打包整个仓库- name: Pack repository with Repomix uses: yamadashy/repomix/.github/actions/repomixmain with: output: repomix-output.xml该步骤会在 runner 上安装对应版本的 repomix npm 包由repomix-version控制默认latest对 checkout 出来的代码执行打包并生成repomix-output.xml。使用不同输出格式Repomix 支持四种输出格式通过style参数指定默认值为xml。这一点在源码 configSchema.ts 中有明确依据repomixOutputStyleSchema定义为[xml, markdown, json, plain]默认配置文件里style默认值为xml且默认输出文件名随格式联动xml→repomix-output.xml、markdown→repomix-output.md、plain→repomix-output.txt、json→repomix-output.json。- name: Pack repository with Repomix uses: yamadashy/repomix/.github/actions/repomixmain with: output: repomix-output.md style: markdown- name: Pack repository with Repomix (JSON format) uses: yamadashy/repomix/.github/actions/repomixmain with: output: repomix-output.json style: json- name: Pack repository with Repomix (Plain text format) uses: yamadashy/repomix/.github/actions/repomixmain with: output: repomix-output.txt style: plain各格式的适用场景见 output.md格式典型场景xml默认面向 AI 优化官方文档指出其选择受 AnthropicClaude、GoogleGemini、OpenAIGPT对结构化标签提示的推荐影响解析准确度最高markdown可读性强适合人机共读json结构化、可编程访问方便配合jq提取文件路径、内容、目录结构等plain极简文本通用兼容性最好注意在 GitHub Actions 中指定style时建议同时把output扩展名改为对应格式如.md、.json、.txt保持约定与默认文件名映射一致。打包多个目录并开启智能压缩directories参数支持同时打包多个目录配合include/ignore的 glob 模式精确控制文件范围并用compress开启智能压缩- name: Pack repository with Repomix uses: yamadashy/repomix/.github/actions/repomixmain with: directories: src tests include: **/*.ts,**/*.md ignore: **/*.test.ts output: repomix-output.xml compress: true文件选择与 glob 模式include与ignore均为逗号分隔的 glob 模式列表。在源码层CLI 解析时通过 patternUtils.ts 的splitPatterns把逗号分隔的字符串拆成数组并分别映射到配置的include与ignore.customPatterns见 defaultAction.ts 中buildCliConfig的实现。除此之外文件过滤还默认叠加三层规则可在repomix.config.json的ignore字段控制见 configuration.mduseGitignore默认true遵循项目.gitignore与.git/info/excludeuseDotIgnore默认true遵循.ignore文件useDefaultPatterns默认true内置忽略node_modules、.git、dist等常见目录。在 CI 中利用这一点可以确保打包产物不混入依赖目录与构建产物。智能压缩compresscompress: true启用基于 Tree-sitter 的智能压缩保留函数/方法签名、接口与类型定义、类结构与属性、import/export 等结构性要素同时移除函数体、循环与条件逻辑细节、内部变量声明等实现内容从而显著降低 token 数。官方示例中一个带循环计算的calculateTotal函数在压缩后仅保留签名与注释函数体被替换为⋮----占位符interface Item的结构则被完整保留。从 parseFile.ts 可以看到其容错设计当语言不受支持或解析失败时会静默回退到未压缩的原始内容Failed to compress ${filePath}, using uncompressed content不会中断整个打包流程该文件也注明 WASM 解析的开销对压缩场景是可接受的。压缩也可以写入配置文件output.compress默认false并可与--remove-comments、--remove-empty-lines等选项组合进一步瘦身见 code-compress.md。将输出上传为 Artifact打包文件若需供后续 workflow 步骤使用或供人工下载可配合actions/upload-artifact上传- name: Pack repository with Repomix uses: yamadashy/repomix/.github/actions/repomixmain with: directories: src output: repomix-output.xml compress: true - name: Upload Repomix output uses: actions/upload-artifactv7 with: name: repomix-output path: repomix-output.xmlactions/upload-artifact的版本号与 Action 内部逻辑无耦合可按 GitHub 官方维护版本自行升级当前示例使用v7。Action 输入参数参考名称说明默认值directories空格分隔的待打包目录列表.include逗号分隔的包含 glob 模式ignore逗号分隔的忽略 glob 模式output输出文件路径repomix-output.xmlcompress启用智能压缩truestyle输出格式xml、markdown、json、plainxmladditional-args传递给 repomix 的额外 CLI 参数repomix-version要安装的 npm 包版本latest几点结合源码的补充说明directories默认.对应 Repomix CLI 的默认目标目录在 defaultAction.ts 中每个目录都会被path.resolve(cwd, directory)解析为绝对路径后再交给pack()。style的四个取值与 configSchema.ts 的repomixOutputStyleSchema完全一致CLI 传入时会被转成小写再经 Valibot 校验。compress在 Action 中默认true与 CLI/配置文件的默认值false不同——这是 Action 面向AI 分析场景做的默认优化注意区分。additional-args可透传任意 CLI 参数例如--remove-comments、--token-budget 50000或--include-logs。以--token-budget为例cliTokenBudget.ts 的validateTokenBudget会在输出生成后检查 token 总数超出预算即抛出错误并以非零退出码失败这非常适合在 CI 中作为上下文窗口护栏使用。Action 输出参数名称说明output_file生成的输出文件路径后续步骤可通过steps.id.outputs.output_file引用该路径例如配合上传或继续处理。完整 Workflow 示例name: Pack repository with Repomix on: workflow_dispatch: push: branches: [ main ] pull_request: branches: [ main ] jobs: pack-repo: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkoutv7 - name: Pack repository with Repomix uses: yamadashy/repomix/.github/actions/repomixmain with: output: repomix-output.xml - name: Upload Repomix output uses: actions/upload-artifactv7 with: name: repomix-output.xml path: repomix-output.xml retention-days: 30这个 Workflow 覆盖了三种触发方式手动触发workflow_dispatch、推送到main分支、以及针对main的拉取请求。retention-days: 30控制产物保留时长。进阶技巧与注意事项用 token 预算做 CI 护栏。在additional-args中传入--token-budget当打包产物超过目标模型上下文窗口时让 workflow 失败避免把超长输入喂给 LLM。错误信息会提示用--compress、--include/--ignore或提高预算来调整见 cliTokenBudget.ts。把常用配置固化到配置文件。directories、include、ignore、compress、style等参数都对应repomix.config.json中的同名配置详见 configuration.md 与 configSchema.tsAction 参数优先级高于配置文件推荐将团队统一口径如忽略模式、压缩开关、token 预算放进仓库根目录的配置文件Workflow 里只留少数易变参数。利用 JSON 格式做程序化消费。当后续步骤或外部工具需要按文件提取内容时style: json配合jq可以轻松完成文件列表、内容检索、大小统计等操作无需解析 XML用法示例见 output.md。安全提醒。Repomix 默认启用安全扫描security.enableSecurityCheck基于 Secretlint 检测 API key、令牌、私钥等敏感信息。在 CI 中打包仓库时建议保持默认开启避免把密钥写入产物若确有需要可用additional-args传入--no-security-check但需充分评估泄露风险。从源码结构看Action 的output、style、compress等参数最终都汇入mergeConfigs合并管线默认值 → 配置文件 → CLI 参数逐层覆盖见 defaultAction.ts因此 Action 内任何参数组合的行为都可以先在本地用repomixCLI 复现验证再固化到 workflow 中保证 CI 结果与本地一致。参考资源完整 Workflow 示例位于仓库.github/workflows/pack-repository.yml命令行选项参考Action 参数对应的完整 CLI 选项输出格式详解四种格式的详细结构与 AI 场景选择智能压缩原理Tree-sitter 压缩的保留/移除清单与配置配置文件说明repomix.config.json全量参数与示例【免费下载链接】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），仅供参考