0.0
No release in over 3 years
A gem that leverages OpenAI's API to automatically generate Git commit messages based on staged changes.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

~> 0.1.0
~> 0.22.0
~> 1.4
 Project Readme

AiGitCommit

AiGitCommit is a Ruby gem designed to help automate and enhance your git commit workflow using AI.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add ai_git_commit

If bundler is not being used to manage dependencies, install the gem by executing:

gem install ai_git_commit

then run to install it:

ai_git_commit install

Usage

All you have to do is to have a OPENAI_API_KEY environment variable set with your OpenAI API key.

Then, just:

git add <files>
git commit

That's it! Your commit message will be generated by AI.

If you would like to skip the AI generation for a specific commit, you can use:

SKIP_AI=true git commit

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/drkmen/ai_git_commit.

License

The gem is available as open source under the terms of the MIT License.