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. トークンカウンター

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を提出して、バグを修正または機能を改善してください。
3. コミュニティのディスカッションに参加し、開発の決定に関与してください。

リポジトリのURL

GitHub | Gitee

📄 ライセンス

このプロジェクトはMITライセンスの下でオープンソース化されています：

著作権 (c) 2023 Repomix開発チーム この作品はMITライセンスの下で公開され、自由な使用、修正、および配布が許可されています。

付録

• 文書の過去バージョン
• FAQ
• 変更履歴