code2prompt: コードライブラリをビッグモデルで理解可能なプロンプトファイルに変換する

はじめに

code2promptは、開発者Mufeed VHによって作成され、GitHubでホストされているオープンソースのコマンドラインツールで、ユーザがコードベース全体をLarge Language Model (LLM)に適したプロンプトに素早く変換できるように設計されています。コード・ディレクトリをトラバースし、ソース・ツリー構造を生成し、コード分析、ドキュメンテーション、機能改善などのタスクで直接使用するためにファイルの内容を統合することで、フォーマットされたMarkdown出力を生成します。Handlebarsテンプレートのカスタマイズ、トークン数の統計、Git diffの統合をサポートするこのツールは、以下のような大きなモデルの力を活用したい開発者に特に適しています。 チャットGPT (またはClaude）を使用して複雑なコードベースを処理することができます。パフォーマンスの最適化であれ、バグの発見であれ、コミットの生成であれ、code2promptは大幅な効率化を実現する。2025年3月3日現在、このプロジェクトは4,500以上の星を獲得しており、開発者コミュニティに広く受け入れられていることを示している。

機能一覧

• コードベース変換: 指定されたディレクトリのコードファイルを、LLMで読める1つのプロンプトに統合する。
• ソースコードのツリー生成コード・ディレクトリのツリー構造を自動的に生成し、プロジェクトのレイアウトをわかりやすくします。
• テンプレートのカスタマイズHandlebarsテンプレートで出力形式をカスタマイズし、幅広い利用シーンをサポートします。
• トークン数プロンプトの統計的生成 トークン 異なるモデルの文脈上の制約に適応できるようにするための数字である。
• Gitの統合コードの変更履歴を表示するためのGit diffとログの追加をサポート。
• ドキュメント・フィルタリング.gitignore のような余計な内容を無視する、ファイルのグロブ・モード・フィルタリングに対応。
• マークダウン出力構造化されたMarkdownドキュメントを生成し、LLMに直接簡単にアップロードできます。
• クロスプラットフォーム対応Linux、macOS、Windowsで安定。
• クリップボードのサポート生成されたヒントを自動的にクリップボードにコピーし、作業効率を向上させます。

ヘルプの使用

設置プロセス

code2promptはRustで書かれたコマンドラインツールで、簡単なインストール手順と複数のメソッドをサポートしている。詳しい手順は以下の通り：

方法1：ソースコードからのインストール

1. 前提条件RustとCargo（Rustのパッケージ・マネージャー）がシステムにインストールされていることを確認してください。これは以下のコマンドで確認できる：

   rustc --version
   cargo --version

お持ちでない方は、Rustのウェブサイトからダウンロードしてインストールしてください。
2. クローン倉庫::

git clone https://github.com/mufeedvh/code2prompt.git
cd code2prompt

3. コンパイルとインストール::

   cargo build --release
   

   コンパイルされると target/release/ ディレクトリで code2prompt 実行可能ファイル。

4. グローバルパスへ移動(オプション): グローバル・コールなどのために、ファイルをシステム・パスに移動する：

   sudo mv target/release/code2prompt /usr/local/bin/
   

方法2：バイナリをプリコンパイルする

1. GitHubのリリースページにアクセスして、お使いのオペレーティング・システム用の最新バージョンのバイナリをダウンロードしてください（例 code2prompt-v2.0.0-linux-x86_64).
2. 解凍して実行権限を与える：

   chmod +x code2prompt
   

3. グローバルパスに移動する（オプション）：

   sudo mv code2prompt /usr/local/bin/
   

方法3：ニックス経由でのインストール

Nixパッケージマネージャを使用している場合は、直接インストールできる：

# 无 flakes
nix-env -iA nixpkgs.code2prompt
# 有 flakes
nix profile install nixpkgs#code2prompt

使用方法

インストールしたら、コマンドラインから実行できる。 code2prompt.以下は主な機能の詳細な操作手順である：

1.基本的な使い方：コードベースのヒント生成

コード・ディレクトリがあるとする。 /path/to/codebase次のコマンドを実行する：

code2prompt /path/to/codebase

• 出力にはソースツリーとすべてのファイルの内容が含まれ、デフォルトではMarkdown形式で生成され、クリップボードにコピーされます。
• 出力例：

  Source Tree:
  

  ディレクトリ
  ファイル1.rs
  └── file2.py

  `dir/file1.rs`:
  <文件内容>
  

2.カスタムテンプレート

code2promptには、組み込みのテンプレート（gitコミットメッセージやドキュメントのコメントなどを生成するためのもの）が用意されています。 templates/ フォルダに保存されます。カスタムテンプレートを作成することもできます。例えば document-the-code.hbs 文書コメントを追加する：

code2prompt /path/to/codebase -t templates/document-the-code.hbs

• カスタムテンプレートは、Handlebars構文に従う必要があります。 absolute_code_path(コードパス）、source_tree(ソースコードツリー）と files(文書のリスト）。

3.トークンのカウントとエンコードのオプション

複数のスプリッターをサポートし、生成されたヒント・トークンの数を表示します：

code2prompt /path/to/codebase --tokens -c cl100k

• オプションの分詞：cl100k(デフォルト）、p50kそしてp50k_editそしてr50k.

4.ギットの統合

Git diff（ステージファイル）を追加：

code2prompt /path/to/codebase --diff

2つの支部の違いを比較する：

code2prompt /path/to/codebase --git-diff-branch "main, development"

ブランチ間のコミットログを取得する：

code2prompt /path/to/codebase --git-log-branch "main, development"

5.文書フィルタリング

特定のファイルやディレクトリを除外する：

code2prompt /path/to/codebase --exclude "*.log" --exclude "tests/*"

特定のファイルのみを含む：

code2prompt /path/to/codebase --include "*.rs" --include "*.py"

6.出力を保存する

結果をクリップボードにコピーするだけでなく、ファイルとして保存する：

code2prompt /path/to/codebase -o output.md

操作例

Pythonプロジェクトに対してパフォーマンス最適化の推奨事項を生成したいとします：

1. コマンドを実行する：

   code2prompt /path/to/project -t templates/improve-performance.hbs -o prompt.md
   

2. そうしれいかん prompt.md にアップロードされたコンテンツ クロード またはChatGPTの場合は、"このコードベースに基づいてパフォーマンスの最適化を提案する "と入力してください。
3. ループの最適化、メモリ管理の推奨など、モデルが返す最適化オプションを取得します。

ほら

• 一部のシステム（Ubuntu 24.04など）でクリップボード機能が使えない場合は、ターミナルにエクスポートして手動でコピーしてください：

  code2prompt /path/to/codebase -o /dev/stdout | xclip -selection c
  

• プローブ .gitignore ファイルを使用して、余計なファイルが正しく無視されるようにします。 --no-ignore (無効）。

以上の手順で、code2promptをすぐに使い始めることができ、簡単にコードベースを大規模なモデルで使用可能なプロンプトに変換し、分析から最適化までの全プロセスを完了することができます。