AIC: AI Commit Message Generator

A CLI tool that uses AI to generate meaningful commit messages by analyzing your staged Git changes.

Features

• 🤖 AI-Powered: Automatically generates detailed and context-aware commit messages
• ✏️ Interactive Mode: Review and edit generated messages before committing
• 🔌 Multiple AI Providers: Works with OpenAI and compatible APIs
• 🌟 Project-level Config: Use .aic.toml for repository-specific settings
• ⚙️ Customizable: Configure prompts, models, and API endpoints

Installation

cargo install aic

Quick Start

1. Configure your API settings:

# For OpenAI
aic config setup --api-token your_openai_token --api-base-url https://api.openai.com --model gpt-3.5-turbo

# For DeepSeek
aic config setup --api-token your_deepseek_token --api-base-url https://api.deepseek.com --model deepseek-chat

Output:

⚙️  Updating configuration...
✓ Set api_token to: your•••••
✓ Set api_base_url to: https://api.openai.com
✓ Set model to: gpt-3.5-turbo
🎉 Configuration updated successfully!

2. Verify your configuration:

aic config list

Output:

⚙️  Current Configuration:
┌───────────────┬──────────────────────────────────────┐
│ api_token     │ your•••••                            │
│ api_base_url  │ https://api.openai.com               │
│ model         │ gpt-3.5-turbo                        │
│ system_prompt │ You are an expert at writing...      │
│ user_prompt   │ Here is the git diff of the staged...│
└───────────────┴──────────────────────────────────────┘

📁 Configuration file location:
   /home/user/.config/aic/config.toml

3. Test your API connection:

aic ping

Output:

🔍 Testing API connection...
🌐 API Base URL: https://api.openai.com
🤖 Model: gpt-3.5-turbo
✅ API connection successful!
✨ Configuration is working correctly.

4. Generate commit messages:

# Stage changes and generate commit message
aic -a

# Generate and commit automatically
aic -ac

# Generate, commit, and push automatically
aic -acp

# Generate commit message (with staged changes)
aic

Example output:

╭─────────────────────────────────────╮
│     AI Commit Message Generator     │
╰─────────────────────────────────────╯
📦 Staging all changes...
🔍 Analyzing staged changes...
🤖 Using model: gpt-3.5-turbo
✨ Generating commit message...
📋 Commit command:
git commit -m "feat: add new feature X"

Execute this commit? [Y/m/n]:

Usage

Basic Commands

# Generate commit message (requires staged changes)
aic

# Stage all changes and generate commit message
aic -a

# Generate and commit automatically
aic -c

# Stage all changes and commit automatically
aic -ac

# Generate commit message and push after committing
aic -p

# Stage all changes, generate commit message and push after committing
aic -ap

# Generate, commit, and push automatically
aic -cp

# Stage all changes, commit, and push automatically 
aic -acp

# Test API connection
aic ping

Note: The -a flag will stage ALL changes in your working directory with git add .. The -c flag will commit directly without confirmation. The -p flag will push changes to remote after a successful commit (either automatic or manual). Use these flags with caution, especially in repositories with multiple changes.

Configuration Management

# Quick setup
aic config setup --api-token <TOKEN> --api-base-url https://api.openai.com --model gpt-4-turbo

# View current settings
aic config list

# View active configuration (global + project)
aic config show

# Get specific setting
aic config get api_token

# Update setting
aic config set model gpt-4-turbo
aic config set default_prompt "Write detailed commit messages"

You can also create a project-specific .aic.toml file in your repository root. See Project-level Configuration for details.

Configuration Files

Global Configuration

The global configuration is stored in TOML format at:

• Linux/macOS: ~/.config/aic/config.toml
• Windows: %APPDATA%\aic\config.toml

Example config.toml:

api_token = "your_api_token_here"
api_base_url = "https://api.openai.com"
model = "gpt-3.5-turbo"
system_prompt = """You are an expert at writing clear and concise commit messages. 
Follow these rules strictly:

1. Start with a type: feat, fix, docs, style, refactor, perf, test, build, ci, chore, or revert
2. Add a scope in parentheses when the change affects a specific component/module
3. Write a brief description in imperative mood (e.g., 'add' not 'added')
4. Keep the first line under 72 characters
5. For simple changes (single file, small modifications), use only the subject line
6. For complex changes (multiple files, new features, breaking changes):
   - Add a body explaining what and why
   - Use numbered points (1., 2., 3., etc.) to list distinct changes
   - Organize points in order of importance"""
user_prompt = """Generate a commit message for the following changes. First analyze the complexity of the diff.

For simple changes, provide only a subject line.

For complex changes, include a body with numbered points (1., 2., 3.) that clearly outline
each distinct modification or feature. Organize these points by importance.

Look for patterns like new features, bug fixes, or configuration changes to determine
the appropriate type and scope:

```diff
{}
```"""

Configuration Options

• api_token: Your API authentication token
• api_base_url: API endpoint (default: OpenAI)
• model: AI model to use (default: gpt-3.5-turbo)
• system_prompt: System prompt that defines the AI's role and commit message format
• user_prompt: User prompt that provides context about the git changes

Project-level Configuration

In addition to global settings, you can create a project-specific configuration file:

# Check current active configuration (global + project)
aic config show

1. Create a .aic.toml file in your Git repository root
2. Project settings will override global settings when running aic in that repository
3. The search for project config will stop at the Git repository root (directory with .git folder)

Example .aic.toml:

# Project-specific configuration (.aic.toml)
# All fields are optional - only specify what you want to override

# API settings
api_token = "your_api_token_here"  # Only add if different from global config
api_base_url = "https://api.openai.com"
model = "gpt-4-turbo"  # Use a different model for this project

# Customized prompts for project-specific commit conventions
system_prompt = """You are a commit message expert for our project.
Use our project conventions:
1. feat: for new features
2. fix: for bug fixes 
3. docs: for documentation
4. refactor: for code changes that neither fix bugs nor add features
5. style: for changes that do not affect the meaning of the code
6. test: for adding or modifying tests
7. chore: for routine tasks, dependency updates, etc.

Always include the scope in parentheses when possible.
Example: feat(auth): implement OAuth login

For complex changes, use bullet points to describe the details."""

user_prompt = """Generate a commit message following our project conventions.
Analyze the complexity of the diff and provide appropriate detail:

```diff
{}
```"""

You can view the active configuration and which files are being used with:

aic config show

Output example:

📋 Active Configuration:

🔍 Configuration Sources:
   Global config: /home/user/.config/aic/config.toml
   Project config: /path/to/your/project/.aic.toml
   ℹ️ Project settings override global settings
...

Environment Variables

• EDITOR: Preferred editor for modifying commit messages
  • Falls back to: vim → vi → nano

Examples

Basic Usage

# Stage changes and generate commit message
git add .
aic

# Stage and commit automatically
aic -ac

# Stage changes and push after manual commit
aic -ap

# Stage, commit and push automatically (all-in-one)
aic -acp

# Commit and push changes that are already staged
aic -cp

Configuration Examples

# Set up OpenAI
aic config setup --api-token sk-... --model gpt-4-turbo

# Set up DeepSeek
aic config setup --api-token ds-... --api-base-url https://api.deepseek.com --model deepseek-chat

# Customize commit message style
aic config set system_prompt "You are an expert at writing clear and concise commit messages..."
aic config set user_prompt "Here is the git diff of the staged changes. Generate a commit message..."

Troubleshooting

1. No Changes Detected

   • Ensure changes are staged with git add
   • Check if you're in a git repository

2. API Errors

   • Verify your API token is set correctly
   • Check API endpoint accessibility
   • Confirm you have sufficient API credits

3. Editor Issues

   • Set your preferred editor: export EDITOR=vim
   • Ensure the editor is installed and accessible

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

References

• The Lost Art of Commit Messages
• Conventional Commits 1.0.0