#commit-message #generator #ai #api-key #gemini #google-api

app commitai

This is an ai commit message generator

2 releases

new 0.1.1 Nov 16, 2024
0.1.0 Nov 16, 2024

#1512 in Web programming

MIT license

20KB
170 lines

CommitAI

AI-powered git commit message generator using Google's Gemini API.

Installation

cargo install commitai

Setup

  1. Get a Google API key from Google AI Studio

  2. Create a config file:

Linux/macOS:

mkdir -p ~/.config/commitai
echo "GOOGLE_API_KEY=your_api_key_here" > ~/.config/commitai/config

Windows:

mkdir -p $env:APPDATA\commitai
echo "GOOGLE_API_KEY=your_api_key_here" > $env:APPDATA\commitai\config

Usage

  1. Stage your changes:
git add .
  1. Generate commit message:
commitai
  1. Choose what to do with the generated message:
  • y - Use the message and commit
  • e - Edit the message before committing
  • n - Cancel without committing

Features

  • Generates contextual commit messages based on staged changes
  • Follows conventional commit format
  • Supports message editing with your preferred editor
  • Color-coded status messages
  • Automatic retry with backoff

License

This project is licensed under the MIT License - see the LICENSE file for details.

Dependencies

~17–29MB
~505K SLoC