cmt - AI-Powered Git Commit Message Generator

cmt is a command-line tool that generates meaningful git commit messages using AI models (Anthropic Claude or OpenAI GPT). It analyzes your staged changes and generates a well-formatted, descriptive commit message following conventional commit standards.

Features

• 🤖 Supports multiple AI models:
  • Anthropic's Claude 3.5 Sonnet (default, temperature 0.3)
  • OpenAI's GPT-4 Optimized (temperature 1.0)
• 📝 Follows conventional commit format (type: subject)
• 🎨 Beautiful colored output in interactive mode
• 📊 Optional diff statistics
• ⚙️ Configurable AI model and parameters
• 🔑 Supports environment variables for API keys

Installation

Prerequisites

• Rust and Cargo (install from rustup.rs)
• An Anthropic API key and/or OpenAI API key

Installing from crates.io

The easiest way to install cmt is directly from crates.io:

cargo install cmt

Installing from source

Alternatively, you can build from source:

# Clone the repository
git clone https://github.com/cliftonk/cmt.git
cd cmt

# Build and install
cargo install --path .

Configuration

Set your API key(s) either:

1. As environment variables:

   # For Claude (default)
   export ANTHROPIC_API_KEY='your-api-key'
   
   # For OpenAI (optional)
   export OPENAI_API_KEY='your-api-key'
   

2. Or in a .env file in your project directory:

   ANTHROPIC_API_KEY=your-api-key
   OPENAI_API_KEY=your-api-key
   

Usage

Basic Usage

# Stage your changes first
git add .

# Generate a commit message using Claude (default)
cmt

# Generate a commit message using OpenAI
cmt --openai

# Use the generated message directly with git
git commit -F <(cmt --message-only)

Command-line Options

Usage: cmt [OPTIONS]

Options:
  -m, --message-only        Only output the generated message, without formatting
  -s, --show-diff          Show the diff statistics
      --model <MODEL>      Use a specific AI model (defaults to claude-3.5-sonnet-latest or gpt-4o)
      --openai            Use OpenAI instead of Claude (which is default)
  -t, --temperature <TEMP> Adjust the creativity of the message (0.0 to 2.0)
                          [default: 0.3 for Claude, 1.0 for OpenAI]
  -h, --help              Show this help message
  -V, --version           Show version information

Examples

# Show diff statistics along with the message
cmt --show-diff

# Use OpenAI with a specific model
cmt --openai --model gpt-4

# Use Claude with a specific model
cmt --model claude-3-opus-20240229

# Override default temperature
cmt --temperature 0.7
cmt --openai --temperature 0.5

# Generate just the message (useful for scripts)
cmt --message-only

Commit Message Format

The generated commit messages follow the conventional commit format:

type: subject

- Detailed change 1
- Detailed change 2

Where type is one of:

• feat: New features
• fix: Bug fixes
• docs: Documentation changes
• style: Code style changes (formatting, etc.)
• refactor: Code refactoring
• test: Adding or modifying tests
• chore: Maintenance tasks

Development

Building from source

# Clone the repository
git clone https://github.com/yourusername/cmt.git
cd cmt

# Build
cargo build

# Run tests
cargo test

# Run in development
cargo run

Dependencies

• git2: Git operations
• reqwest: HTTP client for OpenAI API
• clap: Command-line argument parsing
• colored: Terminal colors
• serde: JSON serialization
• dotenv: Environment variable management

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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