编码代理与终端 · 详细指南 · 验证于 2026-08-29

repomix:详细版

仓库打包成单一 token 控制文件:给 AI 审查/理解大仓库喂料(可压缩、限范围),适合 AI 代码审查场景

repomix 详细指南

版本 1.18.0~1.18.0 | 分类 runtime | 安全(已审查) | 素材:项目官方文档(英文 README)+ 本市场实测(2026-08-29/30)
配套:站内文档(manifest + guide + 证据)| 快速版:站内文档

1. 场景:什么时候会用它

你想让 AI 一次性看完整仓库——审查代码、写文档、跨仓库对比。问题在于仓库动辄上万行,AI 上下文装不下,硬塞会截断、会漏文件。repomix 把整个仓库打包成单个文件,带 token 预算控制(--compress 压缩、--include 限定范围),是给 AI 分析做「喂料」的输入侧工具。

什么时候用:

  • 你要把仓库(或指定子集)打包给 AI 分析/审查;
  • 你要控制 token 预算(大仓库 --compress + --include 限定范围);
  • 你要单文件输出便于分享/存档;
  • 组合包 combo-ai-code-review(repomix + code-review-graph + swe-rex)的输入侧:先打包喂料,再审查、再沙箱验证。

什么时候别用:仓库太大且不需要全量时——用 --include 限范围;只需要单个文件内容时,直接给文件即可,不需要打包。

国内网络的关键:npm 包走 npmmirror 前缀(2026-08-29 实测秒装);单二进制 Release 在 GitHub(未实测,国内直连慢)。

2. 能力清单

能力作用
仓库打包整个仓库 → 单个文件(实测)
token 预算控制--compress 压缩(实测)、--include 限定范围(2026-08-30 实测)
输出路径--output 指定(实测)
配置生成--init 生成 repomix.config.json(2026-08-30 实测)
免安装形态npx -y repomix(实测)
安全扫描打包时自动安全检测(No suspicious files)

3. 快速安装

# 来源: Trove 详细指南 · 验证于 2026-08-29
npm_config_registry=https://registry.npmmirror.com npm install -g repomix
repomix --version

预期输出: 1.18.0(2026-08-29 实测)

前置条件:Node >= 18(npm/npx 形态);官方另有免 Node 的单二进制 Release(未实测)。

装好确认:

  • --version 输出 1.18.0;
  • 在任意仓库根目录跑 repomix . 能出 Pack Summary。

安装变体

路径命令实测
npm 全局(实测)npmmirror 前缀装 repomix✅ 2026-08-29 秒装
免安装npm_config_registry=https://registry.npmmirror.com npx -y repomix <目录>✅ 2026-08-29(npx --version + 打包)
单二进制 ReleaseGitHub Release 下载官方支持(未实测)
brew(macOS)brew install repomix官方支持(未实测)

4. 为什么会这样(机制与共享面)

repomix 是纯 CLI:在目标仓库根目录执行,遍历文件(默认排除 .gitignore 匹配项),合并成单文件并输出 Pack Summary(Total Files / Total Tokens / Output 路径)。--compress 做压缩(代码块用分隔符合并),--include 用 glob 限定范围,--output 换输出路径。它不常驻、无后台进程,跑完即退。

关键概念:

  • Pack Summary:打包报告(Total Files / Total Tokens / Output 路径);
  • --compress:压缩打包(实测);
  • --include:范围限定(2026-08-30 实测);
  • --output:输出路径(实测);
  • --init:生成 repomix.config.json(2026-08-30 实测)。

装完它动哪里:不写用户级配置;运行时会读 ~/.config/repomix/ 下的可选全局配置;输出单文件写当前目录(默认 repomix-output.txt,建议加入 .gitignore);npx 免安装形态的缓存落 ~/.npm。

5. 常用操作

第 1 步:把仓库打包成单文件

# 来源: Trove 详细指南 · 验证于 2026-08-29
repomix . --compress --output repomix-output.txt

预期输出: Pack Summary(Total Files / Total Tokens / Output 路径;2026-08-29 实测 2 文件 → 421 tokens/1983 字符)

卡住怎么办:

  • Pack Summary 报错 → 确认在目标仓库根目录执行、目录可读;
  • 输出文件进 git → 把 repomix-output.txt 加进 .gitignore(打包文件不该入库)。

第 2 步:控制范围与 token 预算

# 来源: Trove 详细指南 · 验证于 2026-08-29
repomix . --compress --include "src/**/*.ts,README.md"

预期输出: 只打包匹配的文件(--compress 实测通过;--include 于 2026-08-30 usage 实测,排除文件未进输出)

卡住怎么办:

  • --include 行为不符 → 以 --help/官方文档为准,确认 glob 写法;
  • 还是太大 → 缩小 glob 范围或先 --output 到临时文件看 token 数。

第 3 步:指定输出路径

# 来源: Trove 详细指南 · 验证于 2026-08-29
repomix . --output /tmp/repo-context.txt

预期输出: 单文件写入指定路径(2026-08-29 实测 --output 生效)

卡住怎么办:

  • 输出路径不可写 → 换可写目录;
  • 大仓库慢 → 用 --include 限范围(实测 站内文档 全目录 → 62KB/959 行单文件)。

6. 冲突逐条(摘要)

与工具页矩阵同源;完整对子、状态与证据见 冲突对子(共装矩阵)。已知关联:

  • code-review-graph / swe-rex × repomix:组合包 combo-ai-code-review 成员(输入喂料 → 审查 → 沙箱验证三段分工),写面不重叠(输出文件 / 审查报告 / 修复 diff),判定 possible-compatible,共装未实测;
  • vite-deploy × repomix:判定 possible-compatible(build 输出 dist/ 与打包输出互不干扰);
  • 其余 20+ 对子:均为 possible-compatible——repomix 无共享配置写面(输出单文件 + npx 缓存),静态判定可共存。

7. 排障速查

  • 症状:打包报错/无输出 → 确认在仓库根目录执行、目录可读
  • 症状:输出文件进了 git → 把 repomix-output.txt 加进 .gitignore(默认排除 .gitignore 匹配项,但输出文件本身建议显式忽略)
  • 症状:--include 没按预期过滤 → 官方功能,以 --help/官方文档为准(2026-08-30 已实测基础用法)
  • 症状:npm 装不上/慢 → 确认带 npmmirror 前缀
  • 症状:Node 版本报错 → 确认 >= 18
四段式全文(症状→原因→解法→验证证据):站内文档(如已收录)

8. 卸载与残留检查

# 来源: Trove 详细指南 · 验证于 2026-08-29
npm uninstall -g repomix
command -v repomix >/dev/null 2>&1 && echo "残留: repomix 仍存在" || echo "repomix removed: OK"

预期输出: repomix removed: OK(npm 移除输出在前)

注意:卸载后残留项 = 输出文件(默认当前目录 repomix-output.txt,或 --output 指定路径)与可选 repomix.config.json(若曾 --init 生成,位于工作区);~/.npm 下 npx 缓存无需清理。

9. FAQ

  • 问:会改我的配置吗?答:不写用户级配置;运行时会读 ~/.config/repomix/ 下的可选全局配置(--init 生成的配置在工作区);输出单文件写当前目录。
  • 问:和 code-review-graph / swe-rex 一起装会冲突吗?答:判定 possible-compatible——写面不重叠(输出文件 / 审查报告 / 修复 diff),共装未实测。
  • 问:大仓库 token 超限怎么办?答:--compress 压缩 + --include 限定范围(实测 站内文档 全目录 → 62KB/959 行单文件)。
  • 问:输出文件会进 git 吗?答:默认排除 .gitignore 匹配项,但输出文件本身建议加入 .gitignore。
  • 问:国内 npm 装不上?答:用安装段的 npmmirror 前缀(2026-08-29 实测秒装)。
  • 问:使用问题向谁反馈?答:本市场安装/卸载问题走条目反馈入口;项目自身问题请向作者仓库反馈。
  • 版本:1.18.0(manifest 锁定;实测 2026-08-29/30)。
  • 环境:Node >= 18(npm/npx 形态);单二进制 Release 免 Node(未实测)。
  • 网络:npm 用 npmmirror 前缀(实测秒装)。
  • 写面:不写用户级配置;输出单文件写当前目录(默认 repomix-output.txt,建议 .gitignore)。
  • 共装:与 code-review-graph / swe-rex 判定 possible-compatible(combo-ai-code-review 成员),共装未实测。

10. 出处

  • 条目签名:repomix 安装 | 仓库打包 | 代码上下文 | AI 上下文
  • 实测:实测复现日志(2026-08-29)(npm 安装 + version + 打包 + --output 全链路);实测复现日志(2026-08-30)(npx 形态 + --compress --include 排除文件实测成功);实测复现日志(2026-08-30)(--init 配置生成 + 文件检查)
  • 未实测:单二进制 Release;brew(macOS);与 code-review-graph/swe-rex 真实共装。

外部教学(来源未实测)

第三方教学未逐条实测,仅供学习;有出入以本页与官方文档为准。

  • 官方 README:Quick Start(npx 免安装 / 全局安装 / 输出与用法) [官方文档 · repomix 官方 · 2026-08-30(v1.18.0 README)]
    免安装 `npx repomix@latest`(项目目录直接跑);全局安装四路(npm -g / yarn global / bun add -g / brew);默认输出 `repomix-output.xml`(AI 友好单文件,含 file_summary);配 prompt 用法(「这个文件是仓库合并表示,我要重构代码,请先审阅」)
  • 官方 README:Usage(目录/glob/ignore/remote/stdin/logs/compress) [官方文档 · repomix 官方 · 2026-08-30(v1.18.0 README)]
    六类用法——①`repomix`/指定目录;②`--include "src/**/*.ts,**"` glob 限定;③`--ignore "**,tmp/"` 排除;④`--remote <仓库>`(GitHub shorthand/分支/commit/URL 都支持);⑤`--stdin` 管道(find/git ls-files/rg/fd/fzf 组合喂文件列表,忽略规则仍生效、自动去重);⑥`--include-logs`(git 日志默认 50 条,可 --include-logs-count N、--include-diffs 组合);`--compress` 压缩输出
  • 官方 README:--init 配置生成(交互向导语义) [官方文档 · repomix 官方 · 2026-08-30(v1.18.0 README)]
    `repomix --init` 生成 repomix.config.json(项目级;另有全局配置 ~/.config/repomix/repomix.config.*,支持 ts/mts/js/json5/jsonc/json 等 9 种后缀);未建配置时运行会提示可加配置文件
  • 官方 README:网站 / 浏览器扩展 / VSCode 扩展(其他入口) [官方文档 · repomix 官方 · 2026-08-31(官方 README 复核)]
    repomix.com 网页版(输入仓库名打包,可选 XML/Markdown/Plain Text + token 估算);Chrome/Firefox 扩展(GitHub 仓库页一键 Repomix);VSCode 扩展 Repomix Runner(社区维护,文件夹打包/管理输出/自动清理)

收录来源(已合并)

本页内容由多篇来源文章按哈希去重、实测验证、AI 重写后合并而来——来源不散落,全部挂在这一个页面上。

暂无已合并来源:本页为本地实测与多来源重写的沉淀;来源与验证细节见站内对应方案页。

← 返回 repomix 方案页 | 编码代理与终端 问题域