Code2Prompt Documentation

クイックスタート

始める 🚀

インストール 📥

フィルタリングについて学ぶ 🔍

テンプレートについて学ぶ 📝

ビジョン 🔮

code2promptは、コード分析、生成、その他のタスクのためのプロンプトを生成するように設計された強力なコードインジェストツールです。ディレクトリをトラバースし、ツリー構造を構築し、各ファイルに関する情報を収集することで動作します。

LLMを使用したコードの分析、ドキュメント化、リファクタリングを容易にするために、コードの結合とフォーマットを簡素化します。

以下の方法でcode2promptを使用できます:

コア

コードインジェストのためのコアライブラリ

CLI

人間向けに特別に設計されたコマンドラインインターフェース

SDK

AIエージェントと自動化スクリプトのためのソフトウェア開発キット

MCP

強力なLLMのためのモデルコンテキストプロトコルサーバー

主な機能

• LLMプロンプトの生成: 構造化されたLLMプロンプトにコードベース全体を迅速に変換します。
• グロブパターンによるフィルタリング: グロブパターンを使用して特定のファイルやディレクトリを含めたり除外したりします。
• カスタマイズ可能なテンプレート: Handlebarsテンプレートを使用してプロンプト生成を調整します。
• トークンカウント: トークン使用量を分析し、コンテキストウィンドウが異なるLLMを最適化します。
• Git統合: コードレビューのためにGitの差分とコミットメッセージをプロンプトに含めます。
• .gitignoreを尊重: .gitignoreにリストされたファイルを自動的に無視してプロンプト生成を合理化します。

なぜcode2prompt?

1. 時間を節約:

   • コードベースをトラバースし、LLM用のファイルをフォーマットするプロセスを自動化します。
   • コードのコピーと貼り付けを繰り返す必要がなくなります。

2. 生産性を向上:

   • コード分析のための構造化された一貫したフォーマットを提供します。
   • バグの特定、コードのリファクタリング、ドキュメントの作成を迅速に行うことができます。

3. 大規模なコードベースの処理:

   • 大規模なコードベースでシームレスに動作するように設計されており、LLMのコンテキスト制限を尊重します。

4. カスタマイズ可能なワークフロー:

   • ファイルのフィルタリング、テンプレートの使用、ターゲットプロンプトの生成のための柔軟なオプション。

使用例

• コードドキュメント: 公開関数、メソッド、クラスのドキュメントを自動生成します。

• バグ検出: コードベースをLLMで分析して潜在的なバグや脆弱性を検出します。

• リファクタリング: コード品質の向上のためのプロンプトを生成してコードを簡素化および最適化します。

• 学習と探索: サマリや詳細な内訳を生成して新しいコードベースを理解します。

• GitコミットとPRの説明: Gitの差分から意味のあるコミットメッセージとプルリクエストの説明を生成します。

このページは便宜上、自動的に翻訳されています。元のコンテンツについては英語版を参照してください。