askrepo : outil de lecture du code source, utilisant LLM pour analyser le code, fournir des explications détaillées sur le code, prise en charge d'une variété de langages de programmation.

Introduction générale

askrepo est un outil de lecture de code source basé sur le LLM (Large Language Model). Il peut lire le contenu d'un fichier texte géré par Git dans un répertoire spécifié et l'envoyer au serveur Google Gémeaux API qui fournit des réponses à des questions sur la base d'invites spécifiées. L'outil est conçu pour aider les développeurs à mieux comprendre et analyser le code source et prend en charge un large éventail de langages de programmation.

Liste des fonctions

• Lecture du code source: Lit le contenu d'un fichier texte géré par Git.
• analyse du codeAnalyse du code à l'aide de l'API Google Gemini.
• Résolution de problèmesLes services d'aide à l'enfance : Fournir des réponses à des questions sur la base d'invites spécifiées.
• Prise en charge multilingueLes langages de programmation multiples sont pris en charge.
• outil en ligne de commande: Fournit des outils de ligne de commande pour les développeurs.
• Explication détaillée du codeLes services d'aide à la décision : fournir des explications détaillées sur le code afin d'aider les développeurs à mieux le comprendre.

Utiliser l'aide

Processus d'installation

1. Obtenir la clé API de Google Gemini: AccèsGoogle API StudioObtenir la clé de l'API.
2. Installer askrepoInstallation de askrepo : Installez askrepo en exécutant la commande suivante dans un terminal :

   cargo install askrepo

3. Définition de la clé APILa clé de l'API : Définir les variables d'environnement dans le terminal pour utiliser la clé de l'API :

   export GOOGLE_API_KEY="YOUR_API_KEY"

Utilisation

1. Utilisation de baseLa commande suivante est exécutée dans le terminal afin d'analyser le code source dans le répertoire spécifié et de générer des commentaires :

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

2. Conseils personnalisésLa demande peut être faite par l'intermédiaire de l'organisme suivant--promptProblèmes de personnalisation des paramètres, par exemple :

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

3. Spécification des modèlesLa demande peut être faite par l'intermédiaire de l'organisme suivant--modelLe paramètre spécifie le modèle d'IA de Google utilisé, par exemple :

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

4. Recherche d'erreurs de codeLe code de l'utilisateur : Utilisez la commande suivante pour trouver des erreurs potentielles dans le code :

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

Fonction détaillée du déroulement des opérations

1. Lire le contenu du fichieraskrepo : askrepo lit tous les fichiers texte gérés par Git dans le répertoire spécifié et formate leur contenu dans un format adapté à l'interrogation.
2. Conseils de constructionLes indices : Construire des indices basés sur les informations du fichier, les questions et le contenu du code source extrait.
3. Envoyer une demande: envoie l'invite à l'API Google Gemini à des fins d'analyse.
4. analyser la réponse: analyse la réponse JSON renvoyée par l'API et extrait le texte généré.
5. résultat de la sortieLe texte généré est affiché dans le terminal afin d'aider les développeurs à comprendre le code ou à trouver des erreurs.