AiCommitMessage 0.2.5
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet tool install --global AiCommitMessage --version 0.2.5
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local AiCommitMessage --version 0.2.5
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=AiCommitMessage&version=0.2.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package AiCommitMessage --version 0.2.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
🧠🧰 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 becomes available.
What this tool does
Generates a commit message based on the git diff
result using the OpenAI API.
Requirements
Getting started
This repository is available at NuGet under the name AICommitMessage.
Installation
- Install the tool globally (or per project/repository).
- Move to the project folder.
- 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.
Commit message pattern
The training model for the AI used is designed using as reference these two guidelines:
- Conventional Commits v1.0.0.
- Padrões de Commits (in Portuguese).
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-openai-url |
Configures a custom OpenAI API URL to generate commit messages. |
set-openai-key |
Sets or updates the OpenAI API key required to access the OpenAI service. |
set-cryptography-for-key |
Specifies whether the OpenAI API key should be stored in an encrypted format or as plain text in environment variables. |
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
Version | Downloads | Last updated |
---|---|---|
0.10.0 | 31 | 11/20/2024 |
0.9.1 | 37 | 11/20/2024 |
0.9.0 | 32 | 11/20/2024 |
0.8.8 | 71 | 11/18/2024 |
0.8.7 | 64 | 11/18/2024 |
0.8.6 | 67 | 11/15/2024 |
0.8.5 | 64 | 11/15/2024 |
0.8.4 | 67 | 11/12/2024 |
0.8.3 | 79 | 11/11/2024 |
0.8.2 | 75 | 11/11/2024 |
0.8.1 | 68 | 11/4/2024 |
0.8.0 | 76 | 11/1/2024 |
0.7.9 | 66 | 11/1/2024 |
0.7.8 | 68 | 11/1/2024 |
0.7.7 | 62 | 11/1/2024 |
0.7.6 | 70 | 11/1/2024 |
0.7.5 | 74 | 11/1/2024 |
0.7.4 | 67 | 10/28/2024 |
0.7.3 | 78 | 10/28/2024 |
0.7.2 | 72 | 10/28/2024 |
0.7.1 | 71 | 10/27/2024 |
0.7.0 | 71 | 10/26/2024 |
0.6.1 | 73 | 10/26/2024 |
0.6.0 | 73 | 10/22/2024 |
0.5.1 | 70 | 10/22/2024 |
0.5.0 | 67 | 10/22/2024 |
0.4.23 | 78 | 10/22/2024 |
0.4.22 | 71 | 10/22/2024 |
0.4.21 | 85 | 10/21/2024 |
0.4.20 | 159 | 10/19/2024 |
0.4.19 | 104 | 10/19/2024 |
0.4.18 | 103 | 10/19/2024 |
0.4.17 | 105 | 10/19/2024 |
0.4.16 | 101 | 10/19/2024 |
0.4.15 | 107 | 10/19/2024 |
0.4.14 | 116 | 10/19/2024 |
0.4.13 | 113 | 10/19/2024 |
0.4.12 | 114 | 10/19/2024 |
0.4.11 | 115 | 10/19/2024 |
0.4.10 | 113 | 10/19/2024 |
0.4.9 | 80 | 10/14/2024 |
0.4.8 | 78 | 10/14/2024 |
0.4.7 | 106 | 10/14/2024 |
0.4.6 | 88 | 10/8/2024 |
0.4.5 | 80 | 10/8/2024 |
0.4.4 | 82 | 10/8/2024 |
0.4.3 | 79 | 10/8/2024 |
0.4.2 | 81 | 10/8/2024 |
0.4.1 | 80 | 10/8/2024 |
0.4.0 | 83 | 10/8/2024 |
0.3.11 | 82 | 10/8/2024 |
0.3.10 | 117 | 10/8/2024 |
0.3.9 | 81 | 10/8/2024 |
0.3.8 | 91 | 10/8/2024 |
0.3.7 | 78 | 10/8/2024 |
0.3.6 | 78 | 10/8/2024 |
0.3.5 | 79 | 10/7/2024 |
0.3.4 | 81 | 10/7/2024 |
0.3.3 | 118 | 9/30/2024 |
0.3.2 | 88 | 9/30/2024 |
0.3.1 | 90 | 9/25/2024 |
0.3.0 | 79 | 9/25/2024 |
0.2.7 | 88 | 9/23/2024 |
0.2.6 | 91 | 9/23/2024 |
0.2.5 | 88 | 9/23/2024 |
0.2.4 | 88 | 9/23/2024 |
0.2.3 | 85 | 9/23/2024 |
0.2.2 | 123 | 9/23/2024 |
0.2.1 | 83 | 9/21/2024 |
0.2.0 | 88 | 9/20/2024 |
0.1.29 | 83 | 9/20/2024 |
0.1.28 | 77 | 9/20/2024 |
0.1.27 | 82 | 9/20/2024 |
0.1.26 | 84 | 9/20/2024 |
0.1.25 | 86 | 9/20/2024 |
0.1.24 | 93 | 9/20/2024 |
0.1.23 | 104 | 9/17/2024 |
0.1.22 | 94 | 9/17/2024 |
0.1.21 | 93 | 9/17/2024 |
0.1.20 | 93 | 9/17/2024 |
0.1.19 | 99 | 9/17/2024 |
0.1.18 | 93 | 9/17/2024 |
0.1.17 | 98 | 9/17/2024 |
0.1.16 | 97 | 9/16/2024 |
0.1.15 | 150 | 9/16/2024 |
0.1.14 | 94 | 9/16/2024 |
0.1.12 | 96 | 9/16/2024 |
0.1.11 | 97 | 9/16/2024 |