CommitAI

CommitAI

CommitAI est une application d'interface de ligne de commande qui génère automatiquement des messages de validation basés sur la sortie de git diff. Il utilise la puissance de l'API GPT-3 d'OpenAI pour créer des messages de validation significatifs et descriptifs, facilitant ainsi le suivi des modifications de code. Avec CommitAI, vous pouvez gagner du temps et vous concentrer sur l'écriture de code, plutôt que sur la création de messages de validation.

Installer

$ npm install --global commitai

ou

$ yarn global add commitai

Usage

$ npx commitai [OPTIONS]

ou

$ commitai [OPTIONS]

Remarque : Vous devez disposer d'une clé API OpenAI valide pour pouvoir utiliser CommitAI. Vous pouvez obtenir une clé API OpenAI. Une fois que vous avez votre clé API, vous devez la définir comme variable d'environnement ou vous devez exécuter la commande suivante avant d'utiliser CommitAI :

OPENAI_API_KEY=sk- < your-api-key > commitai

ou exportez-le en tant que variable d'environnement dans votre fichier .bashrc ou .zshrc :

 export OPENAI_API_KEY=sk- < your-api-key > 

Possibilités

• -h, --help : Afficher l'aide
• -v, --version : Afficher le numéro de version
• -n [number], --numberOfCommitMessages [number] : Nombre de messages de validation à générer
• -e, --edit : modifie le message de validation avant de valider
  • --no-e, --no-edit : Ne pas demander de modifier le message de validation avant de valider
• -c, --confirmation : Confirmez le message de validation avant de valider
  • --no-c, --no-confirmation : Ne pas demander de confirmation avant de s'engager