Repomix 是一款强大的工具，能够将整个代码库打包成一个AI友好的单个文件。它特别适合用于将代码库输入到大型语言模型（LLMs）或其他AI工具中，如Claude、ChatGPT和Gemini。通过Repomix，你可以轻松地将代码库转换为适合AI处理的格式，从而更好地利用AI进行代码审查、文档生成等任务。
Repomix 提供了多种输出格式，包括纯文本、XML和Markdown，并且支持自定义配置。此外，它还集成了Secretlint进行安全检查，确保不会泄露敏感信息。
主要功能
- AI优化：格式化代码库，使其更易于AI理解和处理。
- Token计数：提供每个文件及整个仓库的Token计数，有助于控制LLM的上下文限制。
- 简单易用：只需一条命令即可打包整个代码库。
- 可定制化：轻松配置要包含或排除的内容。
- Git感知：自动尊重项目中的.gitignore文件。
- 安全性检查：使用Secretlint检测并防止敏感信息的泄露。
技术原理
- 日志记录框架：集成到Repomix应用中，捕获和记录关键操作的数据。
- Git感知：自动识别和处理项目中的.gitignore文件，确保不包含不必要的文件。
- 安全性检查：使用Secretlint进行敏感信息检测，确保打包文件的安全性。
- Token计数：计算每个文件及整个仓库的Token数量，帮助用户优化AI输入。
如何运行 Repomix
1. 使用 CLI 工具
你可以通过 npx 立即在项目目录中运行 Repomix，而无需安装：
npx repomix
或者全局安装 Repomix 以便重复使用：
# 使用 npm 安装
npm install -g repomix
# 或者使用 yarn
yarn global add repomix
# 或者使用 Homebrew (macOS/Linux)
brew install repomix
# 然后在任何项目目录中运行
repomix
这将生成一个 repomix-output.txt 文件，其中包含整个代码库的AI友好格式。
2. 使用官方网站
访问 repomix官方网站，输入你的仓库名称，填写任何可选详情，然后点击“Pack”按钮以查看生成的输出。
3. 使用 VSCode 扩展
社区维护的VSCode扩展允许你在编辑器中直接运行Repomix，管理输出文件并控制一切。你可以在 VSCode Repomix Runner 上尝试此扩展。
4. 使用 Docker
你也可以使用 Docker 运行 Repomix，这对于需要隔离环境或喜欢使用容器的用户非常有用。
基本用法（当前目录）：
docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix
处理远程仓库并将输出保存到 output 目录：
docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote https://github.com/yamadashy/repomix
仅供个人学习参考/导航指引使用，具体请以第三方网站说明为准，本站不提供任何专业建议。如果地址失效或描述有误，请联系站长反馈～感谢您的理解与支持！
链接: https://web.fly63.com/nav/4715
