comsu

AI-betrieben (Wrapper) Commit Message Generator

COMSU ist ein einfaches, aber leistungsstarkes Befehlszeilen-Tool, mit dem Google Generative AI eine hochwertige, prägnante Festungsnachrichten vorschlägt, die auf Ihren inszenierten Änderungen in Git basieren. Automatisieren Sie den Prozess des Schreibens aussagekräftiger Festschreibungsnachrichten und gewährleisten Sie die Konsistenz in Ihrem Projekt.

---

Inhaltsverzeichnis

• Merkmale
• Installation
• Verwendung
• Beitragen
• Zeigen Sie Ihre Unterstützung

---

? Merkmale

• Automatisierte Commit -Nachrichten : Generieren Sie Commit -Nachrichten basierend auf Ihren festgelegten Änderungen mit dem KI -Modell von Google.
• Auto Commit : Es kann Ihre Änderungen automatisch mit Ihrer ausgewählten Commit -Nachricht begehen.
• Unterstützt herkömmliche Festschreibungstypen : Vorschläge folgen den Standard -Commit -Typen ( feat , fix , build , chore usw.).
• Einfache Setup : Ein-Command-Installation, um loszulegen.
• Anpassbare Eingabeaufforderungen : Ändern Sie die Eingabeaufforderungsdatei, um die AI -Vorschläge auf Ihre spezifischen Projektanforderungen anzupassen.

---

? Installation

Linux

Befolgen Sie die folgenden Schritte, um COMSU auf Ihrem Linux -System einzurichten:

1. Klonen Sie das Repository :

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

2. Führen Sie das Installationsskript aus :

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

3. Legen Sie Ihre API -Taste fest :

   Stellen Sie sicher, dass Ihr Google AI Studio -API -Schlüssel als Umgebungsvariable eingestellt ist. Wenn Sie keinen haben, können Sie hier einen kostenlosen API -Schlüssel erstellen.

    export GOOGLE_AI_STUDIO_API_KEY= " your_api_key_here "

   Sie können diese Zeile zu Ihrem ~/.bashrc oder ~/.zshrc hinzufügen, um sie anhaltend zu machen.

Fenster

Befolgen Sie die folgenden Schritte, um COMSU auf Ihrem Windows -System einzurichten:

1. Klonen Sie das Repository : Öffnen Sie PowerShell als Administrator und schreiben Sie dann folgende Befehle:

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

2. Führen Sie das Installationsskript aus :

   powershell - ExecutionPolicy Bypass - File install.ps1

3. Legen Sie Ihre API -Taste fest :

   Stellen Sie sicher, dass Ihr Google AI Studio -API -Schlüssel als Umgebungsvariable eingestellt ist. Wenn Sie keinen haben, können Sie hier einen kostenlosen API -Schlüssel erstellen.

   set GOOGLE_AI_STUDIO_API_KEY = your_api_key_here

   Sie können diese Zeile Ihrem $ -Path hinzufügen, um sie anhaltend zu machen.

---

Verwendung

Nach der Installation können Sie COMSU aus jedem Verzeichnis ausführen, in dem Sie Änderungen durchführten:

Linux

git comsu

Fenster

Führen Sie dies in der CMD aus:

git-comsu

Wenn Sie in Ländern leben, die von Google eingeschränkt sind, möchten Sie möglicherweise ein VPN verwenden oder Ihren DNS ändern.

Dies generiert eine Liste der vorgeschlagenen Festschreibmeldungen, die auf Ihren Änderungen basieren, und Sie können die gewünschte Nachricht auswählen und Ihre Änderungen automatisch mit dieser Nachricht festlegen. Wenn Sie keine der Nachrichten mögen, können Sie 'x' zum Ausgang eingeben.

Beispiel

git add .
git comsu

Ausgabe :

 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.

---

Konfiguration

Die Eingabeaufforderung, mit der die Commit-Nachrichten generiert werden, wird in einer Datei mit dem Namen Eingabeaufforderung unter/usr/local/share/git-comsu/Eingabeaufforderung gespeichert. Sie können diese Datei ändern, um die Art und Weise zu ändern, wie AI die Festschreibungsmeldungen generiert.

---

? Beitragen

Beiträge, Probleme und Feature -Anfragen sind willkommen! Überprüfen Sie die Seite mit der Ausgabe.

1. Geben Sie das Repository auf.
2. Erstellen Sie Ihre Funktionszweig (Git Checkout -B -Funktion/Neugegründung).
3. Bestimmen Sie Ihre Änderungen (Git Commit -m 'Fügen Sie eine Funktion hinzu ").
4. Drücken Sie in den Zweig (Git Push Origin-Feature/Neugegründung).
5. Öffnen Sie eine Pull -Anfrage.

---

? Zeigen Sie Ihre Unterstützung

Wenn Sie dieses Tool hilfreich finden, geben Sie bitte ein Repository!