AiCommitMessage 2.0.6

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

---

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:

# OpenAI GPT-5.1 (flagship model - best quality)
dotnet-aicommitmessage set-settings -m gpt-5.1 -k {api-key} -u {api-url}

# OpenAI GPT-5 Mini (balanced performance and cost)
dotnet-aicommitmessage set-settings -m gpt-5-mini -k {api-key} -u {api-url}

# OpenAI GPT-5 Nano (fastest and most cost-effective)
dotnet-aicommitmessage set-settings -m gpt-5-nano -k {api-key} -u {api-url}

# OpenAI GPT-4o Mini
dotnet-aicommitmessage set-settings -m gpt-4o-mini -k {api-key} -u {api-url}

# Azure AI Llama
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-5.1
dotnet-aicommitmessage set-settings -m gpt-5-mini
dotnet-aicommitmessage set-settings -m gpt-5-nano
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

The tool supports the following AI models:

Model	Provider	Description
gpt-5.1	OpenAI	Flagship GPT-5 model with best quality and capabilities
gpt-5-mini	OpenAI	Balanced model offering good performance at lower cost
gpt-5-nano	OpenAI	Most cost-effective option with fastest response times
gpt-4o-mini	OpenAI	Previous generation model, still highly capable
llama-3-1-405b-instruct	Azure AI	Meta's Llama model via Azure AI services

Default Model: gpt-5.1 (automatically used if no model is specified)

---

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{API Disabled?}
    D -->|No| E[Send Data to OpenAI API]
    D -->|Yes| F[Use Fallback Message Generation]
    E --> G[Generate Commit Message]
    F --> G
    G --> H[Check and append pre-defined commands to Commit Message]
    H --> I[Return Generated Commit Message]
    I --> J[Insert Commit Message into Git Commit]
    J --> K[Finalize Commit]

---

Commands

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

Command	Description
install-hook	Installs GIT hooks in the default .git/hooks directory or in the custom directory configured in GIT settings.
generate-message	Generates a commit message based on the current changes (git diff context).
set-settings	Set the OpenAI settings.
help	Display information about this program.
version	Display version information.

---

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
      }
    }
  }
}

---

Configuration Options

The tool supports several configuration options through environment variables:

Disable API Calls

In some network environments, the OpenAI API may be blocked due to firewall or proxy restrictions. You can disable API calls entirely by setting the following environment variable:

export DOTNET_AICOMMITMESSAGE_DISABLE_API=true

Or on Windows:

set DOTNET_AICOMMITMESSAGE_DISABLE_API=true

When this option is enabled, the tool will:

• Skip any calls to the OpenAI API
• Display a warning message indicating that API calls are disabled
• Use fallback commit message generation (either the provided message or a placeholder)
• Continue to work with branch name processing and issue number extraction

Contributors

<table> <tbody> <tr> <td align="center"> <a href="https://github.com/guibranco"> <img src="https://avatars.githubusercontent.com/u/3362854?v=4" width="100;" alt="guibranco"/> <br /> _{<b>Guilherme Branco Stracini</b>} </a> </td> <td align="center"> <a href="https://github.com/krisbiradar"> <img src="https://avatars.githubusercontent.com/u/104765390?v=4" width="100;" alt="krisbiradar"/> <br /> _<b>Kris</b> </a> </td> <td align="center"> <a href="https://github.com/Malay-dev"> <img src="https://avatars.githubusercontent.com/u/91375797?v=4" width="100;" alt="Malay-dev"/> <br /> _{<b>Malay Kumar</b>} </a> </td> <td align="center"> <a href="https://github.com/RyanFloresTT"> <img src="https://avatars.githubusercontent.com/u/53247675?v=4" width="100;" alt="RyanFloresTT"/> <br /> _{<b>Ryan Flores</b>} </a> </td> </tr> <tbody> </table>

Bots

<table> <tbody> <tr> <td align="center"> <a href="https://github.com/dependabot[bot]"> <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="100;" alt="dependabot[bot]"/> <br /> _{<b>dependabot[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/penify-dev[bot]"> <img src="https://avatars.githubusercontent.com/in/399279?v=4" width="100;" alt="penify-dev[bot]"/> <br /> _{<b>penify-dev[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/gitauto-ai[bot]"> <img src="https://avatars.githubusercontent.com/in/844909?v=4" width="100;" alt="gitauto-ai[bot]"/> <br /> _{<b>gitauto-ai[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/github-actions[bot]"> <img src="https://avatars.githubusercontent.com/in/15368?v=4" width="100;" alt="github-actions[bot]"/> <br /> _{<b>github-actions[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/pixeebot[bot]"> <img src="https://avatars.githubusercontent.com/in/193111?v=4" width="100;" alt="pixeebot[bot]"/> <br /> _{<b>pixeebot[bot]</b>} </a> </td> <td align="center"> <a href="https://github.com/snyk-bot"> <img src="https://avatars.githubusercontent.com/u/19733683?v=4" width="100;" alt="snyk-bot"/> <br /> _{<b>Snyk bot</b>} </a> </td> </tr> <tr> <td align="center"> <a href="https://github.com/codefactor-io"> <img src="https://avatars.githubusercontent.com/u/11671095?v=4" width="100;" alt="codefactor-io"/> <br /> _{<b>CodeFactor</b>} </a> </td> </tr> <tbody> </table>