repomix

环境要求

• Node.js 环境与 npm 包管理器（用于 npm 全局安装）
• 如需容器方式运行，需预先安装 Docker
• 可选：Chrome 或 Firefox 浏览器扩展，用于网页端打包
• 可选：使用 TypeScript/JavaScript 配置文件时需在项目中安装 repomix 开发依赖

安装与启动步骤

1. 1安装 Repomix

   通过 npm 全局安装 repomix 命令行工具，安装完成后可在任意项目目录调用 repomix 命令。

   npm install -g repomix

   复制

2. 2打包当前仓库

   在项目根目录直接执行，Repomix 会把整个仓库打包成单个 AI 友好的输出文件。

   repomix

   复制

3. 3打包指定目录

   把路径作为参数传入，即可只打包该目录下的内容，路径按实际项目结构替换。

   repomix path/to/directory

   复制

4. 4按模式筛选文件

   使用 --include 配合 glob 模式，只打包匹配的文件，多个模式用英文逗号分隔。

   repomix --include "src/**/*.ts,**/*.md"

   复制

5. 5排除不需要的文件

   使用 --ignore 排除日志、临时目录等，多个模式用英文逗号分隔，减少输出体积。

   repomix --ignore "**/*.log,tmp/"

   复制

6. 6打包远程仓库

   用 --remote 直接克隆并打包远端仓库，无需先手动 git clone 到本地。

   repomix --remote https://github.com/yamadashy/repomix

   复制

7. 7生成配置文件

   执行 --init 在当前目录生成默认的 repomix.config.json，之后可自定义打包规则。

   repomix --init

   复制

8. 8用 Docker 运行

   把当前目录挂载到容器 /app，无需本地安装 Node.js 即可隔离运行 Repomix。

   docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix

   复制

关键配置

如何确认成功

命令执行结束后，当前目录下生成 repomix-output.xml 文件，打开能看到整个仓库的内容即成功。

常见问题

注意事项

• Repomix 支持 npm 全局安装、Docker、官网在线打包和浏览器扩展多种使用方式，按需选择。
• 配置文件支持 TypeScript、JavaScript、JSON5、JSONC、JSON 多种格式，按优先级自动查找，需用 TS/JS 配置时要先安装 repomix 开发依赖。
• Claude Code 用户可通过 /plugin marketplace add yamadashy/repomix 与 /plugin install repomix-explorer@repomix 安装插件；其他支持 Agent Skills 的助手可用 npx skills 安装技能。
• 打包文件包含仓库全部内容，发送给 AI 或他人前请确认其中不含密钥等敏感信息。