Gitlore

Gitlore is a simple cli tool to summarize git commits. Run gitlore in a git repository to select the number of commits to summarize, choose the style of the summary, and the model either one from OpenAI or a locally running model via Ollama.

Installation

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

bundle add gitlore

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

gem install gitlore

Usage

Navigate to a git repository and run gitlore in that directory.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

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

License

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