Gai - AI-Powered Git Commits

Say goodbye to tedious commit messages. gai is a command-line interface (CLI) that leverages AI to automatically generate clear, concise, and conventional commit messages from your staged changes.

Features

• Intelligent Commit Generation: Analyzes your code changes (git diff) and writes a high-quality commit message.
• Zero Configuration Required: Works out-of-the-box by using a public backend. No API key needed to get started.
• API-Key Optional: You can optionally provide your own Google Gemini API key for private, direct API access.
• Conventional Commits Compliant: Generated messages follow the Conventional Commits specification.
• Seamless Git Workflow: Integrates directly with your Git workflow, supporting staging, amending, and more.
• Safe & Transparent: Use --dry-run to preview the commit and --verbose for detailed output.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or later)
• Git

Installation

Install gai globally on your system using npm. This will make the gai command available in any terminal session.

npm install -g gai-cli

Once installed, you can run gai from any Git repository on your system.

Usage

Using gai is simple. Navigate to your Git repository, stage some files, and run the command.

Basic Usage

1. Stage the files you want to commit:

   git add src/index.ts package.json

2. Run gai to generate and create the commit:

   gai

This will analyze the staged changes, generate a commit message, display it for you, and then execute the git commit command.

Optional Configuration: Using Your Own API Key

gai is designed to work without any configuration. By default, it uses a shared public backend to generate commit messages, making it accessible to everyone immediately.

However, if you prefer to use your own Google Gemini API key for privacy, to bypass potential rate limits on the public endpoint, or to have direct control over the AI model, you can optionally provide it by setting the GEMINI_API_KEY environment variable.

If you wish to use your own key, follow these steps:

1. Get an API Key: Visit Google AI Studio to create your free API key.

2. Set the Environment Variable: You need to export the API key as an environment variable named GEMINI_API_KEY.

   export GEMINI_API_KEY="YOUR_API_KEY_HERE"

3. (Recommended) Make it Permanent: To avoid running the export command in every new terminal session, add it to your shell's configuration file (e.g., .zshrc, .bashrc, or .profile):

   # For Zsh users
   echo 'export GEMINI_API_KEY="YOUR_API_KEY_HERE"' >> ~/.zshrc
   
   # For Bash users
   echo 'export GEMINI_API_KEY="YOUR_API_KEY_HERE"' >> ~/.bashrc
   
   # Then, reload your shell to apply the changes
   source ~/.zshrc
   # or
   source ~/.bashrc

Options

| Option | Alias | Description | Default | | ----------------------- | ----- | ------------------------------------------------------------------ | --------- | | --help | -h | Display the help menu. | | | --version | -V | Display the version of the application. | | | --all | -a | Stage all tracked and untracked changes before committing (git add -A). | false | | --amend | -A | Amend the previous commit instead of creating a new one. | false | | --dry-run | -n | Show the generated commit message and command without executing it. | false | | --message <message> | -m | Provide a custom commit message and skip the AI generation. | | | --type <type> | -t | Force a specific Conventional Commit type (e.g., feat, fix). | | | --scope <scope> | -s | Specify a scope for the commit (e.g., api, auth). | | | --lang <lang> | -l | Language for the generated message (e.g., spanish, french). | english | | --verbose | -v | Show detailed information about the process. | false |

Examples

1. Stage all changes and generate a commit in Spanish

gai -a -l spanish

2. Force a feat type with a specific scope

# First, stage your files
git add .

# Run with type and scope
gai -t feat -s payments

Generated commit: feat(payments): add new endpoint for processing transactions

3. Preview a commit message without executing it (Dry Run)

gai -a -n

Output:

COMMIT READY
refactor(auth): simplify token validation logic

Dry Run: The following command will not be executed:
$ git commit -m "refactor(auth): simplify token validation logic"

4. Amend the last commit Stage the additional changes you want to include, then run:

git add src/fix.ts
gai -A

This will use all currently staged changes to amend the previous commit, generating a new message that reflects the complete set of changes.

5. Skip AI and use your own message

gai -a -m "docs: update README with new installation instructions"

Contributing

Contributions are welcome! If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make your changes.
4. Commit your changes (git commit -am 'feat: add some feature').
5. Push to the branch (git push origin feature/your-feature).
6. Create a new Pull Request.

License

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