code2prompt

クイックインストール⚡

pip を使用した SDK 🐍

どのように役立ちますか?

コア

code2prompt 、コード分析、生成、その他のタスクのためのLLMプロンプトの作成プロセスを効率化するコード取り込みツールです。ディレクトリを走査し、ツリー構造を構築し、各ファイルに関する情報を収集することで動作します。コアライブラリは他のアプリケーションに簡単に統合できます。

コマンドライン

code2promptコマンドラインインターフェース（CLI）は、コードベースから直接プロンプトを生成できるように設計されています。生成されたプロンプトは自動的にクリップボードにコピーされ、出力ファイルに保存することもできます。さらに、Handlebars テンプレートを使用してプロンプト生成をカスタマイズすることもできます。ドキュメントで提供されているプロンプトをご確認ください。

SDK

code2promptソフトウェア開発キット（SDK）は、コアライブラリへのPythonバインディングを提供します。これは、コードベースとシームレスに連携させたいAIエージェントや自動化スクリプトに最適です。SDKはPypiでホストされており、pip経由でインストールできます。

MCP

code2promptはモデルコンテキストプロトコル（MCP）サーバーとしても利用可能で、ローカルサービスとして実行できます。これにより、コードベースの構造化されたコンテキストを自動的に収集するツールが提供され、LLMの性能が向上します。

ドキュメント 📚

詳しい手順についてはオンラインドキュメントをご覧ください。

特徴

Code2Promptは、コードベース全体を大規模言語モデルに適した構造化されたプロンプトに変換します。主な機能は以下のとおりです。

• 自動コード処理: あらゆるサイズのコードベースを読みやすくフォーマットされたプロンプトに変換します
• スマートフィルタリング: glob パターンを使用してファイルを含める/除外し、 .gitignoreルールを尊重する
• 柔軟なテンプレート: さまざまなユースケースに合わせて、Handlebars テンプレートを使用してプロンプトをカスタマイズします。
• トークン追跡: LLM コンテキスト制限内に収まるようにトークンの使用状況を追跡します
• Git 統合: プロンプトに diff、ログ、ブランチの比較を含める
• 開発者エクスペリエンス: 自動クリップボードコピー、行番号、ファイル整理オプション

LLM 用のファイルのコピーやコードのフォーマットを手動で行う必要はもうありません。Code2Prompt が面倒な作業を処理するので、AI モデルから洞察やソリューションを得ることに集中できます。

代替インストール

詳細なインストール手順については、ドキュメントを参照してください。

バイナリリリース

Releasesから、ご使用の OS の最新バイナリをダウンロードしてください。

ソースビルド

必要：

• Git 、 Rust 、そしてCargo 。

スターの歴史

ライセンス

MIT ライセンスに基づいてライセンスされています。詳細については、LICENSE を参照してください。

プロジェクトは気に入りましたか?

プロジェクトが気に入って、役に立ったと感じた場合は、 : を付けてください。

貢献

貢献する方法:

• 機能を提案する
• バグを報告する
• 何かを修正してプルリクエストを開く
• コードのドキュメント化を手伝ってください
• 広めてください