askrepo: Werkzeug zum Lesen von Quellcode, das LLM zur Analyse des Codes verwendet und detaillierte Erklärungen zum Code liefert, Unterstützung für eine Vielzahl von Programmiersprachen

Allgemeine Einführung

askrepo ist ein Tool zum Lesen von Quellcode, das auf dem LLM (Large Language Model) basiert. Es kann den Inhalt einer Git-verwalteten Textdatei in einem bestimmten Verzeichnis lesen und an die Google Zwillinge API, die auf der Grundlage bestimmter Aufforderungen Antworten auf Fragen liefert. Das Tool soll Entwicklern helfen, Quellcode besser zu verstehen und zu analysieren, und unterstützt eine breite Palette von Programmiersprachen.

Funktionsliste

• Lesen des QuellcodesLiest den Inhalt einer von Git verwalteten Textdatei.
• Code-AnalyseCode-Analyse unter Verwendung der Google Gemini API.
• Lösung von ProblemenBeantworten Sie Fragen auf der Grundlage vorgegebener Aufforderungen.
• Unterstützung mehrerer SprachenMehrere Programmiersprachen werden unterstützt.
• KommandozeilentoolBietet Befehlszeilentools für Entwickler an.
• Detaillierte Code-ErläuterungDetaillierte Code-Erklärungen, um Entwicklern ein besseres Verständnis des Codes zu ermöglichen.

Hilfe verwenden

Einbauverfahren

1. Google Gemini API-Schlüssel erhalten: ZugangGoogle API StudioAbrufen des API-Schlüssels.
2. askrepo installieren: Installieren Sie askrepo, indem Sie den folgenden Befehl in einem Terminal ausführen:

   cargo install askrepo

3. Einstellen des API-Schlüssels: Setzen Sie Umgebungsvariablen im Terminal, um den API-Schlüssel zu verwenden:

   export GOOGLE_API_KEY="YOUR_API_KEY"

Verwendung

1. Grundlegende Verwendung: Führen Sie den folgenden Befehl im Terminal aus, um den Quellcode im angegebenen Verzeichnis zu analysieren und Kommentare zu erzeugen:

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

2. Benutzerdefinierte TippsKann durchgeführt werden durch--promptProbleme bei der Anpassung von Parametern, zum Beispiel:

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

3. Modelle spezifizierenKann durchgeführt werden durch--modelDer Parameter gibt das verwendete Google AI-Modell an, zum Beispiel:

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

4. Finden von Code-Fehlern: Verwenden Sie den folgenden Befehl, um mögliche Fehler im Code zu finden:

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

Detaillierte Funktionsabläufe

1. Lesen Sie den Inhalt der Dateiaskrepo: askrepo liest alle von Git verwalteten Textdateien im angegebenen Verzeichnis und formatiert deren Inhalt in eine für Abfragen geeignete Form.
2. Tipps zum AufbauConstruct hints based on file information, questions and extracted source code content.
3. Anfrage sendenSenden Sie die Eingabeaufforderung zur Analyse an die Google Gemini API.
4. die Antwort analysierenParsing: Analysiert die von der API zurückgegebene JSON-Antwort und extrahiert den generierten Text.
5. AusgabeergebnisAusgabe des generierten Textes auf dem Terminal, um Entwicklern zu helfen, den Code zu verstehen oder Fehler zu finden.