xenogit

Votre ami CLI pour les messages de validation Git instantanés.

Introduction

Xenogit est votre assistant de ligne de commande utile qui utilise OpenAI GPT pour créer rapidement des messages de validation qui suivent la spécification Conventional Commit. Arrêtez de passer du temps à rédiger des commits et commencez à gérer votre référentiel Git sans effort !

️Mise en route

Installation

Il existe deux manières d'installer Xenogit :

1. Utilisation de Composer : exécutez la commande suivante pour installer Xenogit globalement :

composer global require dotninth/xenogit

2. Téléchargement depuis GitHub : visitez la page Releases sur GitHub et téléchargez le binaire approprié.

Usage

Après avoir installé Xenogit, vous pouvez accéder à toutes les options disponibles en lançant simplement le programme :

$ 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

Clé API

Xenogit a besoin d'une clé API d'OpenAI pour fonctionner correctement. Il existe deux options pour fournir la clé API :

1. Utilisez la commande xenogit config:api-key <your-api-key> .

2. Utilisation d'une variable d'environnement : créez une variable d'environnement appelée API_KEY qui contient votre clé API OpenAI.

3. Créez un fichier nommé .env dans le répertoire où se trouve le binaire Xenogit. Ce fichier sera utilisé pour stocker vos variables d'environnement. Au fichier .env , ajoutez la ligne suivante, en remplaçant <YOUR_API_KEY> par votre clé API OpenAI actuelle :

API_KEY= < YOUR_API_KEY > 

Paiement

L'utilisation de Xenogit vous coûtera de l'argent pour chaque requête que vous adresserez à l'API OpenAI. Xenogit utilise le modèle officiel ChatGPT ( gpt-3.5-turbo-16k ), qui coûte environ 15 fois moins cher que GPT-4. Assurez-vous d'avoir suffisamment de fonds ou de crédits sur votre compte OpenAI pour payer votre utilisation de Xenogit.

Pour en savoir plus sur le prix d'utilisation des services d'OpenAI, veuillez consulter leur page de tarification sur la page Tarification OpenAI.

Contribuer

Vous êtes invités à contribuer à Xenogit ! Pour une collaboration fluide, veuillez suivre ces directives lorsque vous contribuez au projet :

1. Forkez le référentiel et clonez-le sur votre machine locale.
2. Créez une nouvelle branche pour votre contribution : git checkout -b my-contribution .
3. Apportez vos modifications en vous assurant que le code respecte le style et les conventions de codage du projet.
4. Testez minutieusement vos modifications.
5. Validez vos modifications avec un message de validation descriptif, conformément à la spécification Conventional Commit.
6. Poussez votre branche vers votre dépôt forké : `git push origin my-contribution'.
7. Ouvrez une pull request sur la branche « principale » du référentiel Xenogit.
8. Fournissez une description claire et détaillée de vos modifications dans la pull request, ainsi que toute information ou contexte pertinent.

Veuillez noter qu'en contribuant à Xenogit, vous acceptez de publier vos contributions sous la licence MIT.

Licence

Xenogit est publié sous la licence MIT. N'hésitez pas à le modifier et à le diffuser selon vos besoins.