Repomix

🏆 Đề cử Giải thưởng Mã nguồn Mở ​

Chúng tôi rất vinh dự! Repomix đã được đề cử cho hạng mục Powered by AI tại JSNation Open Source Awards 2025.

Điều này không thể thực hiện được nếu không có tất cả các bạn sử dụng và hỗ trợ Repomix. Xin cảm ơn!

Nếu Repomix đã giúp bạn phân tích hoặc đóng gói codebase cho các công cụ AI, chúng tôi sẽ rất biết ơn nếu bạn bỏ phiếu cho chúng tôi trong hạng mục Powered by AI.

Bạn có thể bỏ phiếu tại đây: https://forms.gle/5QaYBM6pNoyWLfL2A

Cảm ơn sự hỗ trợ của bạn!

Bắt đầu nhanh ​

Sau khi bạn đã tạo một tệp đóng gói (repomix-output.xml) bằng Repomix, bạn có thể gửi nó đến trợ lý AI (như ChatGPT, Claude) với một prompt như:

Tệp này chứa tất cả các tệp trong kho lưu trữ được kết hợp thành một.
Tôi muốn tái cấu trúc mã, vì vậy hãy xem xét nó trước.

AI sẽ phân tích toàn bộ codebase của bạn và cung cấp những hiểu biết toàn diện:

Khi thảo luận về các thay đổi cụ thể, AI có thể giúp tạo mã. Với các tính năng như Artifacts của Claude, bạn thậm chí có thể nhận được nhiều tệp phụ thuộc lẫn nhau:

Chúc bạn code vui vẻ! 🚀

Sử dụng công cụ CLI ​

Repomix có thể được sử dụng như một công cụ dòng lệnh, cung cấp các tính năng mạnh mẽ và tùy chọn tùy chỉnh.

Công cụ CLI có thể truy cập các kho lưu trữ riêng tư vì nó sử dụng git được cài đặt cục bộ của bạn.

Bắt đầu nhanh ​

Bạn có thể thử Repomix ngay lập tức trong thư mục dự án của bạn mà không cần cài đặt:

npx repomix

Hoặc cài đặt toàn cục để sử dụng nhiều lần:

# Cài đặt với npm
npm install -g repomix

# Hoặc với yarn
yarn global add repomix

# Hoặc với bun
bun add -g repomix

# Hoặc với Homebrew (macOS/Linux)
brew install repomix

# Sau đó chạy trong bất kỳ thư mục dự án nào
repomix

Vậy là xong! Repomix sẽ tạo một tệp repomix-output.xml trong thư mục hiện tại của bạn, chứa toàn bộ kho lưu trữ của bạn ở định dạng thân thiện với AI.

Cách sử dụng ​

Để đóng gói toàn bộ kho lưu trữ của bạn:

repomix

Để đóng gói một thư mục cụ thể:

repomix path/to/directory

Để đóng gói các tệp hoặc thư mục cụ thể bằng cách sử dụng mẫu glob:

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

Để loại trừ các tệp hoặc thư mục cụ thể:

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

Để đóng gói một kho lưu trữ từ xa:

# Sử dụng định dạng rút gọn
npx repomix --remote yamadashy/repomix

# Sử dụng URL đầy đủ (hỗ trợ nhánh và đường dẫn cụ thể)
npx repomix --remote https://github.com/yamadashy/repomix
npx repomix --remote https://github.com/yamadashy/repomix/tree/main

# Sử dụng commit cụ thể với --remote-branch
npx repomix --remote yamadashy/repomix --remote-branch 836abcd7335137228ad77feb28655d85712680f1

Để khởi tạo một tệp cấu hình mới (repomix.config.json):

repomix --init

Sau khi bạn đã tạo tệp đóng gói, bạn có thể sử dụng nó với các công cụ AI Tạo sinh như Claude, ChatGPT và Gemini.

Sử dụng Docker ​

Bạn cũng có thể chạy Repomix bằng Docker 🐳
Điều này hữu ích nếu bạn muốn chạy Repomix trong môi trường biệt lập hoặc thích sử dụng container.

Cách sử dụng cơ bản (thư mục hiện tại):

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

Để đóng gói một thư mục cụ thể:

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

Xử lý một kho lưu trữ từ xa và xuất ra thư mục output:

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

Định dạng đầu ra ​

Chọn định dạng đầu ra ưa thích của bạn:

# Định dạng XML (mặc định)
repomix --style xml

# Định dạng Markdown
repomix --style markdown

# Định dạng văn bản thuần túy
repomix --style plain

Tùy chỉnh ​

Tạo một repomix.config.json cho các cài đặt cố định:

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

Thêm ví dụ ​