EverGit

An AI-powered Git helper for the Evergreen ILS project. Evergit uses OpenAI’s models to generate commit messages that adhere to specific standards, streamlining the commit process while reducing manual input.

Features

• Generate commit messages using OpenAI's LLM models.
• Automatically reference Launchpad bugs in commit messages.
• Automatically sign off commits with the user's name and email.
• Select files to stage for commit.
• Use different models by specifying the model name as an argument.

Requirements

• Node.js, npm, and Git must be installed on your system.
• OpenAI API key (stored in the OPENAI_API_KEY environment variable)
• A launchpad account is required to reference bugs in commit messages.

Installation

npm install -g evergit

Usage

evergit needs to be run in a git repository. It will automatically detect the repository and branch you are on. If run without any arguments, it will display the help message.

evergit

Commands

evergit commit

Generates a commit message using a LLM model from OpenAI that follows the Evergreen ILS commit message format.

evergit commit                      # Uses the default model

• Prompts the user to select files to stage.
• Prompts the user for a Launchpad bug number.
  • References the bug name, description and conversation when generating the commit message using the Launchpad API.
• Automatically signs off the commit with the user's name and email from the git configuration.

Options

• --model <model-name>: Use a specific model to generate the commit message.

evergit commit --model <model-name> # Uses a specific model