askrepo：ソースコード閲覧ツール。LLMを使ってコードを分析し、詳細なコード解説を提供する。

はじめに

askrepoはLLM(Large Language Model)に基づいたソースコードリーディングツールです。指定したディレクトリにあるGitで管理されたテキストファイルの内容を読み込み、それをGoogleの ジェミニ 指定されたプロンプトに基づいて質問への回答を提供するAPI。このツールは、開発者がソースコードをよりよく理解し、分析できるように設計されており、幅広いプログラミング言語をサポートしている。

機能一覧

• ソースコードの読み取りGitが管理するテキストファイルの内容を読み込む。
• コード解析Google Gemini APIを使ったコード解析。
• 問題解決指定されたプロンプトに基づき、質問に対する回答を提供する。
• 多言語サポート複数のプログラミング言語に対応しています。
• コマンドラインツール開発者が使えるコマンドラインツールを提供。
• コードの詳細開発者がコードをよりよく理解できるよう、詳細なコード説明を提供する。

ヘルプの使用

設置プロセス

1. Google Gemini APIキーを取得するアクセスグーグルAPIスタジオAPIキーを取得する。
2. askrepoをインストールするターミナルで以下のコマンドを実行し、askrepoをインストールする：

   cargo install askrepo

3. APIキーの設定APIキーを使用するために、ターミナルで環境変数を設定する：

   export GOOGLE_API_KEY="YOUR_API_KEY"

使用方法

1. 基本的な使い方ターミナルで以下のコマンドを実行すると、指定したディレクトリのソースコードが解析され、コメントが生成される：

   askrepo --prompt "解释提供的文件中的代码" --model "gemini-1.5-flash" ./src

2. カスタムヒントを通じて行うことができる。--prompt例えば、パラメータのカスタマイズの問題：

   askrepo --prompt "这段代码的目的是什么？" --model "gemini-1.5-flash" ./src

3. モデルの指定を通じて行うことができる。--modelこのパラメーターは、例えば、使用するグーグルAIモデルを指定する：

   askrepo --model "gemini-1.5-flash" ./src

4. コードエラーの発見コードの潜在的なエラーを見つけるには、以下のコマンドを使用します：

   askrepo --prompt "查找这段代码中的错误" --model "gemini-1.5-flash" ./src

詳細な機能操作の流れ

1. ファイルの内容を読む:askrepoは、指定したディレクトリにあるすべてのGitで管理されたテキストファイルを読み込み、その内容をクエリに適した形に整形します。
2. ビルドのヒントファイル情報、質問、抽出されたソースコードの内容に基づいてヒントを構築します。
3. リクエストを送信解析のためにGoogle Gemini APIにプロンプトを送信する。
4. レスポンスを解析するAPI が返す JSON レスポンスを解析し、生成されたテキストを取り出す。
5. 出力結果生成されたテキストはターミナルに出力され、開発者がコードを理解したり、エラーを発見したりするのに役立つ。