Repomix

项目简介

Repomix 可将整个代码库打包为一个 AI 友好文件，并能按适合 AI 理解的方式格式化代码库，支持 XML、Markdown、JSON 或纯文本输出。它面向需要与大型语言模型及其他 AI 工具共享完整仓库上下文的场景。

核心功能

• AI 优化输出会以更便于 AI 理解和处理的方式格式化代码库。Token 计数提供每个文件和整个仓库的 token 数量，有助于应对 LLM 上下文限制。Git 感知会自动遵循 .gitignore、.ignore 和 .repomixignore 文件。安全功能使用 Secretlint 检测匹配已知凭据格式的文件，并将其排除在输出之外。代码压缩使用 Tree-sitter 提取关键代码元素，在保留结构的同时减少 token 用量。自定义支持包含与忽略模式、输出样式、持久配置以及远程仓库打包。

适用场景

• 使用打包后的仓库作为上下文，与 AI 助手进行代码审查和重构。进行实现规划、缺陷排查以及第三方库安全检查。基于整个代码库生成文档和测试用例。将博客、文档和书籍等写作内容打包为 LLM 兼容的知识数据包。

快速开始

• 在项目目录中运行 npx repomix@latest，无需安装即可试用 Repomix。也可通过 npm install -g repomix、yarn global add repomix、bun add -g repomix 或 Homebrew 全局安装，然后运行 repomix。Repomix 会在当前目录生成 repomix-output.xml，其中包含 AI 友好格式的仓库内容。运行 repomix --init 可创建 repomix.config.json 以保存持久设置。使用 repomix --remote 搭配仓库简写或

部署与要求

• 可通过 npx、全局 npm、yarn 或 bun 安装、Homebrew 或 Docker 运行 Repomix。支持使用 ghcr.io/yamadashy/repomix 镜像进行容器化使用。CLI 使用本地安装的 git，因此可访问私有仓库。

采用前须知

• 许可证：MIT。在使用、修改或分发项目前，请确认其具体条款。