Repomix

🚀 Repomix 使用說明

Repomix 是一款功能強大的工具，既可以作為 CLI 命令行工具使用，也能當作 Node.js 庫來用。它能對本地和遠程代碼庫進行處理，還提供多種輸出格式，為代碼處理和報告生成帶來了極大的便利。

✨ 主要特性

1. 多種文件處理模式

• 本地模式：掃描當前目錄及其子目錄，生成指定格式的報告。
• 遠程模式：通過 Git 協議克隆遠程倉庫後進行處理。

2. 支持多種輸出格式

• XML
• JSON
• 文本（默認）

3. 壓縮功能

支持對生成的文件進行壓縮，便於存儲和傳輸。

📦 安裝指南

安裝工具

npm install repomix

💻 使用示例

快速上手

基本命令

repomix --input <目錄> [--output <文件名>] [--format <格式>]

示例

處理當前目錄並輸出為 result.xml：

repomix . --output result.xml --format xml

📚 詳細文檔

配置選項

1. 常用參數

• --input 或 -i：指定輸入目錄或文件路徑。
• --output 或 -o：指定輸出文件名，默認為 repomix-output.txt。
• --format 或 -f：指定輸出格式，支持 txt, xml, json。
• --compress 或 -c：啟用壓縮功能，默認為 false。

2. 高級選項

• --style：指定輸出風格（僅限文本格式），支持 plain 和 markdown。
• --quiet 或 -q：禁用終端輸出，僅生成文件。

核心組件

1. 文件搜索與收集

import { searchFiles, collectFiles } from 'repomix';

async function processFiles(directory) {
  const files = await searchFiles(directory);
  const collected = await collectFiles(files);
  return collected;
}

2. 文件處理流程

import { processFiles } from 'repomix';

async function handleFiles(filePaths, directory) {
  const rawFiles = await collectFiles(filePaths, directory);
  const processed = await processFiles(rawFiles);
  return processed;
}

3. token 計數器

import { TokenCounter } from 'repomix';

const counter = new TokenCounter('gpt-4');
const tokens = counter.countTokens('Hello World!');

示例代碼

處理遠程倉庫

import { runCli, type CliOptions } from 'repomix';

async function processRemoteRepo(url: string) {
  const options: CliOptions = {
    input: url,
    output: 'remote-output.xml',
    format: 'xml',
    compress: true
  };
  await runCli(options);
}

注意事項

⚠️ 重要提示

• 依賴管理：確保安裝所有必需的包，包括 repomix 和其依賴項。
• 權限問題：處理遠程倉庫時，需確保有訪問權限。
• 性能優化：對於大規模代碼庫，建議啟用壓縮功能以減少存儲空間。

項目貢獻

貢獻指南

1. 提交 ISSUE 報告問題或提出需求。
2. Fork 代碼庫並提交 PR 修復 bug 或改進功能。
3. 加入社區討論，參與開發決策。

倉庫地址

GitHub | Gitee

許可證

本項目遵循 MIT 協議開源：

版權所有 (c) 2023 Repomix 開發團隊 本作品在 MIT 協議下發布，允許自由使用、修改和分發。

附錄

• 文檔歷史版本
• FAQ
• 變更日誌

支持的輸出格式