comsu

Générateur de messages à propulsion (wrapper) AI

COMSU est un outil de ligne de commande simple mais puissant qui exploite Google Generative AI pour suggérer des messages de validation concise de haute qualité en fonction de vos changements de GIT. Automatisez le processus de rédaction de messages de validation significatifs et assurez la cohérence dans votre projet.

---

Table des matières

• Caractéristiques
• Installation
• Usage
• Contributif
• Montrez votre soutien

---

? Caractéristiques

• Messages de validation automatisés : générer des messages de validation en fonction de vos modifications en cours en utilisant le modèle d'IA de Google.
• Auto Commit : il peut valider automatiquement vos modifications avec votre message de validation sélectionné.
• Prend en charge les types de validation conventionnels : les suggestions suivent les types de validation standard ( feat , fix , build , chore , etc.).
• Configuration facile : installation en une commande pour commencer.
• Invites personnalisables : modifiez le fichier invite pour adapter les suggestions d'IA à vos besoins spécifiques du projet.

---

? Installation

Linux

Pour configurer COMSU sur votre système Linux, suivez ces étapes:

1. Clone le référentiel :

   git clone https://github.com/ali-hv/comsu.git
   cd comsu

2. Exécutez le script d'installation :

   chmod +x install.sh
   sudo ./install.sh

3. Définissez votre clé API :

   Assurez-vous que vous avez votre ensemble de touches API Google AI Studio comme variable d'environnement. Si vous n'en avez pas, vous pouvez créer une clé API gratuite ici.

    export GOOGLE_AI_STUDIO_API_KEY= " your_api_key_here "

   Vous pouvez ajouter cette ligne à votre ~/.bashrc ou ~/.zshrc pour le rendre persistant.

Fenêtre

Pour configurer COMSU sur votre système Windows, suivez ces étapes:

1. Clone le référentiel : Open PowerShell en tant qu'administrateur, puis écrivez ces commandes:

   git clone https: // github.com / ali - hv / comsu.git
   cd comsu

2. Exécutez le script d'installation :

   powershell - ExecutionPolicy Bypass - File install.ps1

3. Définissez votre clé API :

   Assurez-vous que vous avez votre ensemble de touches API Google AI Studio comme variable d'environnement. Si vous n'en avez pas, vous pouvez créer une clé API gratuite ici.

   set GOOGLE_AI_STUDIO_API_KEY = your_api_key_here

   Vous pouvez ajouter cette ligne à votre chemin $ pour le rendre persistant.

---

Usage

Une fois installé, vous pouvez exécuter COMSU à partir de n'importe quel répertoire où vous avez mis en scène des modifications:

Linux

git comsu

Fenêtre

Exécutez ceci dans le CMD:

git-comsu

Si vous vivez dans des pays limités par Google, vous pouvez utiliser un VPN ou modifier votre DNS.

Cela générera une liste de messages de validation suggérés en fonction de vos modifications et vous pouvez choisir le message que vous souhaitez, puis il engagera automatiquement vos modifications avec ce message. Si vous n'aimez aucun des messages, vous pouvez taper «x» pour quitter.

Exemple

git add .
git comsu

Sortir :

 Generating the commit messages based on your changes ...

1. ref: Refactor the send_email function for efficiency
2. ref: Update the send_email to reduce processing time
3. feat: Use new method for getting the changes in send_email

Write the message number you want to use (write 'x' to exit): 1

[main 6b25961] ref: Refactor the send_email function for efficiency
 1 file changed, 1 deletion(-)

Committed successfully.

---

Configuration

L'invite utilisée pour générer les messages de validation est stockée dans un fichier nommé invite situé sur / usr / local / share / git-cOMSU / invite. Vous pouvez modifier ce fichier pour modifier la façon dont l'IA génère les messages de validation.

---

? Contributif

Les contributions, les problèmes et les demandes de fonctionnalités sont les bienvenus! N'hésitez pas à vérifier la page des problèmes.

1. Fourk le référentiel.
2. Créez votre branche de fonctionnalités (fonctionnalité GIT COSSE -B / nouvelle fonction).
3. Commissez vos modifications (git commit -m «Ajouter une fonctionnalité»).
4. Poussez vers la branche (fonction Origine Git Push / Nouvelle-Fermeture).
5. Ouvrez une demande de traction.

---

? Montrez votre soutien

Si vous trouvez cet outil utile, veuillez donner un au référentiel!