xenogit

Ihr CLI-Partner für sofortige Git-Commit-Nachrichten.

Einführung

Xenogit ist Ihr hilfreicher Befehlszeilenassistent, der OpenAI GPT verwendet, um schnell Commit-Nachrichten zu erstellen, die der Conventional Commit-Spezifikation folgen. Verschwenden Sie keine Zeit mehr mit dem Schreiben von Commits und beginnen Sie mit der mühelosen Verwaltung Ihres Git-Repositorys!

️Erste Schritte

Installieren

Es gibt zwei Möglichkeiten, Xenogit zu installieren:

1. Mit Composer: Führen Sie den folgenden Befehl aus, um Xenogit global zu installieren:

composer global require dotninth/xenogit

2. Herunterladen von GitHub: Besuchen Sie die Seite „Releases“ auf GitHub und laden Sie die entsprechende Binärdatei herunter.

Verwendung

Nach der Installation von Xenogit können Sie alle verfügbaren Optionen nutzen, indem Sie einfach das Programm starten:

$ xenogit

  Xenogit  v1.3.2

  USAGE:  < command > [options] [arguments]

  commit         Automatically generate commit messages

  config:api-key Configure the API key in the .env file

API-Schlüssel

Xenogit benötigt einen API-Schlüssel von OpenAI, um ordnungsgemäß zu funktionieren. Es gibt zwei Möglichkeiten, den API-Schlüssel bereitzustellen:

1. Verwenden Sie den Befehl xenogit config:api-key <your-api-key> .

2. Umgebungsvariable verwenden: Erstellen Sie eine Umgebungsvariable namens API_KEY , die Ihren OpenAI-API-Schlüssel enthält.

3. Erstellen Sie eine Datei mit dem Namen .env in dem Verzeichnis, in dem sich die Xenogit-Binärdatei befindet. Diese Datei wird zum Speichern Ihrer Umgebungsvariablen verwendet. Fügen Sie der .env Datei die folgende Zeile hinzu und ersetzen Sie <YOUR_API_KEY> durch Ihren tatsächlichen OpenAI-API-Schlüssel:

API_KEY= < YOUR_API_KEY > 

Zahlung

Die Verwendung von Xenogit kostet Sie Geld für jede Anfrage, die Sie an die OpenAI-API stellen. Xenogit verwendet das offizielle ChatGPT-Modell ( gpt-3.5-turbo-16k ), das etwa 15-mal weniger kostet als GPT-4. Stellen Sie sicher, dass Ihr OpenAI-Konto über genügend Guthaben oder Guthaben verfügt, um Ihre Nutzung von Xenogit zu bezahlen.

Um mehr über den Preis für die Nutzung der Dienste von OpenAI zu erfahren, schauen Sie sich bitte deren Preisseite unter OpenAI-Preisseite an.

Beitragen

Sie sind herzlich eingeladen, zu Xenogit beizutragen! Für eine reibungslose Zusammenarbeit befolgen Sie bitte diese Richtlinien, wenn Sie zum Projekt beitragen:

1. Forken Sie das Repository und klonen Sie es auf Ihren lokalen Computer.
2. Erstellen Sie einen neuen Zweig für Ihren Beitrag: git checkout -b my-contribution .
3. Nehmen Sie Ihre Änderungen vor und stellen Sie sicher, dass der Code dem Codierungsstil und den Konventionen des Projekts entspricht.
4. Testen Sie Ihre Änderungen gründlich.
5. Übernehmen Sie Ihre Änderungen mit einer beschreibenden Commit-Nachricht gemäß der herkömmlichen Commit-Spezifikation.
6. Schieben Sie Ihren Zweig in Ihr geforktes Repository: „git push origin my-contribution“.
7. Öffnen Sie eine Pull-Anfrage für den Hauptzweig des Xenogit-Repositorys.
8. Geben Sie im Pull-Request eine klare und detaillierte Beschreibung Ihrer Änderungen an, zusammen mit allen relevanten Informationen oder Kontexten.

Bitte beachten Sie, dass Sie durch Ihren Beitrag zu Xenogit der Veröffentlichung Ihrer Beiträge unter der MIT-Lizenz zustimmen.

Lizenz

Xenogit wird unter der MIT-Lizenz veröffentlicht. Fühlen Sie sich frei, es entsprechend Ihren Bedürfnissen zu ändern und zu verteilen.