AiCommitMessage 0.12.3

🧠 🤖 This tool generates AI-powered commit messages via Git hooks, automating meaningful message suggestions from OpenAI and others to improve commit quality and efficiency.

[!CAUTION] This is still in development/beta. It will be GA when a major release 1.0 becomes available.

What this tool does

Generates a commit message based on the git diff result using the OpenAI API.

Requirements

• OpenAI API key.
• .NET 8.0 (or higher) runtime.
• GIT client.

Getting started

This repository is available at NuGet under the name AICommitMessage.

Installation

1. Install the tool globally (or per project/repository).
2. Move to the project folder.
3. Install the Git hook on the default hooks directory.

dotnet tool install -g AiCommitMessage
cd my-project/
dotnet-aicommitmessage install-hook
git add .
git commit -m ""

Use git log -1 to review the last commit details and find the automatically generated commit message.

Model Configuration and Settings

To configure and use models with dotnet-aicommitmessage, users need to set their settings once. This setup involves specifying the model, API key, and API URL. These settings will be stored as environment variables for future use.

Initial Setup

Run the following commands to configure the model and related settings:

dotnet-aicommitmessage set-settings -m gpt-4o-mini -k {api-key} -u {api-url}
dotnet-aicommitmessage set-settings -m llama-3-1-405b-instruct -k {api-key} -u {api-url}

Replace {api-key} with your API key and {api-url} with the URL of your API provider.

Switching Models

After the initial setup, you can easily switch between models without needing to provide the API key or URL again:

dotnet-aicommitmessage set-settings -m gpt-4o-mini
dotnet-aicommitmessage set-settings -m llama-3-1-405b-instruct

This allows for quick model changes while retaining your previously configured API details.

Supported Models

Currently supported models are gpt-4o-mini and llama-3-1-405b-instruct.

Commit message pattern

The training model for the AI used is designed using as reference these guidelines:

• Conventional Commits v1.0.0.
• Padrões de Commits (in Portuguese).
• Conventional Commit Messages.
• Emoji for Conventional Commits.
• conventional-commit-types.

Sequence of Execution

Here’s a flow diagram showing the sequence of execution of the prepare-commit-msg hook and its integration with dotnet-aicommitmessage to generate commit messages using the OpenAI API:

graph TD
    A[Git Commit] --> B[prepare-commit-msg Hook Trigger]
    B --> C[Invoke dotnet-aicommitmessage Tool]
    C --> D[Send Data to OpenAI API]
    D --> E[Generate Commit Message]
    E --> F[Check and append pre-defined commands to Commit Message]
    F --> G[Return Generated Commit Message]
    G --> H[Insert Commit Message into Git Commit]
    H --> I[Finalize Commit]

Commands

This tool accepts an argument as the command to execute. Here is a list of available commands:

Example output

Here is an example of the commit messages generated in a real-world project:

Debug

You can run the message generation manually to debug it, but it will not commit the content to your GIT repository. If you also want to check the OpenAI JSON response, append the -D parameter.

Manually generating the commit message

To manually generate a commit message without committing the staged changes, run the following command:

dotnet-aicommitmessage generate-message -m "."

Saving the OpenAI JSON response

If you want to persist the OpenAI JSON response, add the -D parameter and a debug.json file will be created with the response JSON.

dotnet-aicommitmessage generate-message -Dm "."

Here is a sample debug.json content:

{
  "Value": {
    "CreatedAt": "2024-11-20T12:54:03+00:00",
    "FinishReason": 0,
    "ContentTokenLogProbabilities": [],
    "RefusalTokenLogProbabilities": [],
    "Role": 2,
    "Content": [
      {
        "Kind": 0,
        "Text": "feat - add reactivation handling for refunds due today",
        "ImageUri": null,
        "ImageBytes": null,
        "ImageBytesMediaType": null,
        "ImageDetailLevel": null,
        "Refusal": null
      }
    ],
    "ToolCalls": [],
    "Refusal": null,
    "FunctionCall": null,
    "Id": "chatcmpl-[[REDACTED]]",
    "Model": "gpt-4o-mini-2024-07-18",
    "SystemFingerprint": "fp-[[REDACTED]]",
    "Usage": {
      "OutputTokenCount": 10,
      "InputTokenCount": 6229,
      "TotalTokenCount": 6239,
      "OutputTokenDetails": {
        "ReasoningTokenCount": 0
      }
    }
  }
}

Contributors

Bots