AiCommitMessage 0.1.28
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.1.28
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.1.28
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=AiCommitMessage&version=0.1.28
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package AiCommitMessage --version 0.1.28
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-commit |
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.3.1 | 23 | 9/25/2024 |
0.3.0 | 31 | 9/25/2024 |
0.2.7 | 57 | 9/23/2024 |
0.2.6 | 58 | 9/23/2024 |
0.2.5 | 52 | 9/23/2024 |
0.2.4 | 54 | 9/23/2024 |
0.2.3 | 48 | 9/23/2024 |
0.2.2 | 86 | 9/23/2024 |
0.2.1 | 51 | 9/21/2024 |
0.2.0 | 54 | 9/20/2024 |
0.1.29 | 51 | 9/20/2024 |
0.1.28 | 48 | 9/20/2024 |
0.1.27 | 52 | 9/20/2024 |
0.1.26 | 53 | 9/20/2024 |
0.1.25 | 51 | 9/20/2024 |
0.1.24 | 62 | 9/20/2024 |
0.1.23 | 65 | 9/17/2024 |
0.1.22 | 55 | 9/17/2024 |
0.1.21 | 57 | 9/17/2024 |
0.1.20 | 55 | 9/17/2024 |
0.1.19 | 61 | 9/17/2024 |
0.1.18 | 55 | 9/17/2024 |
0.1.17 | 59 | 9/17/2024 |
0.1.16 | 56 | 9/16/2024 |
0.1.15 | 110 | 9/16/2024 |
0.1.14 | 55 | 9/16/2024 |
0.1.12 | 54 | 9/16/2024 |
0.1.11 | 63 | 9/16/2024 |