Repomix

🏆 開源獎項提名 ​

我們深感榮幸！Repomix 已被提名為 JSNation Open Source Awards 2025 的 Powered by AI 類別獎項。

這一切都離不開所有使用和支持 Repomix 的用戶。謝謝大家！

如果 Repomix 幫助您分析或打包程式碼庫用於 AI 工具，我們將非常感謝您在 Powered by AI 類別中為我們投票。

什麼是 Repomix？ ​

Repomix 是一個強大的工具，可以將您的整個程式碼庫打包到一個 AI 友好的檔案中。無論您是在進行程式碼審查、重構，還是需要 AI 協助您的專案，Repomix 都可以輕鬆地與 AI 工具共享您的整個儲存庫上下文。

快速開始 ​

使用 Repomix 生成打包文件（repomix-output.xml）後，您可以將其發送給 AI 助手（如 ChatGPT、Claude），並附上這樣的提示：

此文件包含了倉庫中所有文件的合併內容。
我想重構程式碼，請先幫我審查一下。

AI 將分析您的整個程式碼庫並提供全面的見解：

在討論具體修改時，AI 可以幫助生成程式碼。通過像 Claude 的 Artifacts 這樣的功能，您甚至可以一次性接收多個相互依賴的文件：

祝您編碼愉快！🚀

使用 CLI 工具 ​

Repomix 可以作為命令行工具使用，提供強大的功能和自定義選項。

CLI 工具可以訪問私有倉庫，因為它使用您本地安裝的 Git。

快速上手 ​

您可以在專案目錄中無需安裝即可立即嘗試 Repomix：

npx repomix@latest

或者全局安裝以便重複使用：

# 使用 npm 安裝
npm install -g repomix

# 或使用 yarn 安裝
yarn global add repomix

# 或使用 bun 安裝
bun add -g repomix

# 或使用 Homebrew 安裝（macOS/Linux）
brew install repomix

# 然後在任意專案目錄中運行
repomix

就是這麼簡單！Repomix 將在您的當前目錄中生成一個 repomix-output.xml 文件，其中包含了以 AI 友好格式整理的整個程式碼庫。

基本用法 ​

打包整個程式碼庫：

repomix

打包特定目錄：

repomix path/to/directory

使用 glob 模式打包特定文件：

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

排除特定文件：

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

處理遠端倉庫：

# 使用簡寫格式
npx repomix --remote yamadashy/repomix

# 使用完整 URL（支援分支和特定路徑）
npx repomix --remote https://github.com/yamadashy/repomix
npx repomix --remote https://github.com/yamadashy/repomix/tree/main

# 使用提交 URL
npx repomix --remote https://github.com/yamadashy/repomix/commit/836abcd7335137228ad77feb28655d85712680f1

初始化配置文件（repomix.config.json）：

repomix --init

生成打包文件後，您可以將其用於 Claude、ChatGPT、Gemini 等生成式 AI 工具。

Docker 使用方法 ​

您也可以使用 Docker 運行 Repomix 🐳
如果您想在隔離環境中運行 Repomix 或更偏好使用容器，這是一個很好的選擇。

基本用法（當前目錄）：

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

打包特定目錄：

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

處理遠端倉庫並輸出到 output 目錄：

docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote https://github.com/yamadashy/repomix

輸出格式 ​

選擇您偏好的輸出格式：

# XML 格式（預設）
repomix --style xml

# Markdown 格式
repomix --style markdown

# 純文字格式
repomix --style plain

自定義設置 ​

創建 repomix.config.json 進行持久化設置：

{
  "output": {
    "style": "markdown",
    "filePath": "custom-output.md",
    "removeComments": true,
    "showLineNumbers": true,
    "topFilesLength": 10
  },
  "ignore": {
    "customPatterns": ["*.test.ts", "docs/**"]
  }
}

進階使用者指南 ​

Repomix 為進階使用案例提供強大的功能。以下是進階使用者的一些重要指南：

• MCP 伺服器 - AI 助理的 Model Context Protocol 整合
• GitHub Actions - 在 CI/CD 工作流程中自動化程式碼庫封裝
• 程式碼壓縮 - 基於 Tree-sitter 的智慧壓縮（約 70% 令牌減少）
• 作為函式庫使用 - 將 Repomix 整合到您的 Node.js 應用程式中
• 自訂指令 - 為輸出新增自訂提示和指令
• 安全功能 - 內建 Secretlint 整合和安全檢查
• 最佳實務 - 使用經過驗證的策略最佳化您的 AI 工作流程

更多示例 ​