Comitty

AI-powered commit message generator for Git. Comitty analyzes your staged Git changes and automatically generates high-quality commit messages using AI.

Features

• AI-powered commit message generation
• Style support for conventional and natural commit styles
• Multiple providers - OpenRouter, OpenAI, Anthropic
• Fast startup with Bun runtime
• Safe analysis - only staged changes, never unstaged
• Smart context - branch name, recent commits, changed files
• Interactive editing and regeneration
• Flexible config - global and project-specific settings

Installation

npm (recommended)

npm install -g comitty

Note: Comitty is currently being prepared for npm publishing. For now, install from source.

Install from source

git clone https://github.com/your-username/comitty.git
cd comitty
npm install
npm run build
npm link

Quick Start

1. Stage your changes:

git add .

2. Generate and commit:

comitty

That's it! Comitty will analyze your staged changes, generate a commit message, and ask for your confirmation before committing.

Configuration

Global Configuration

Comitty creates a global config file at ~/.config/comitty/config.json on first run:

{
  "style": "conventional",
  "provider": "openrouter",
  "autoCommit": false,
  "explain": false,
  "maxDiffSize": 10000,
  "_comment": "Edit this file to configure Comitty"
}

Project Configuration

Create a .comittyrc file in your project root to override global settings:

{
  "style": "natural",
  "provider": "openai",
  "model": "gpt-4"
}

Environment Variables

Set API keys via environment variables:

# OpenRouter (recommended)
export OPENROUTER_API_KEY="your-api-key-here"

# OpenAI
export OPENAI_API_KEY="your-api-key-here"

# Anthropic
export ANTHROPIC_API_KEY="your-api-key-here"

Usage

Basic Usage

# Generate commit message interactively
comitty

# Auto-commit without confirmation
comitty --auto-commit

# Use natural language style
comitty --style natural

# Use different AI provider
comitty --provider openai

Command Line Options

| Option | Description | Default | |--------|-------------|---------| | -s, --style <style> | Commit message style | conventional | | -p, --provider <provider> | AI provider to use | openrouter | | -m, --model <model> | Specific AI model to use | provider default | | -k, --api-key <key> | API key for the provider | - | | --auto-commit | Skip confirmation and auto-commit | false | | --explain | Include AI reasoning in output | false | | -r, --regenerate | Regenerate commit message | false | | -h, --help | Show help message | - |

Interactive Workflow

1. Generate: Comitty analyzes staged changes and generates a commit message
2. Review: See the generated message with context
3. Choose:
   • [Accept] Accept and commit
   • [Edit] Edit the message
   • [Regenerate] Generate a new message
   • [Cancel] Cancel operation

Commit Styles

Conventional Commits

feat: add user authentication system
fix: resolve memory leak in data processing
chore: update dependencies and cleanup imports

Natural Language

Add user authentication system
Fix memory leak in data processing
Update dependencies and cleanup imports

AI Providers

OpenRouter (Recommended)

• Best for flexibility and cost-effectiveness
• Supports multiple models (Claude, GPT, Llama, etc.)
• Get API key: https://openrouter.ai/keys

export OPENROUTER_API_KEY="your-openrouter-key"
comitty --provider openrouter --model anthropic/claude-3-haiku

OpenAI

• GPT-3.5 and GPT-4 models
• Get API key: https://platform.openai.com/api-keys

export OPENAI_API_KEY="your-openai-key"
comitty --provider openai --model gpt-4

Anthropic

• Claude models
• Get API key: https://console.anthropic.com/

export ANTHROPIC_API_KEY="your-anthropic-key"
comitty --provider anthropic --model claude-3-opus

Configuration Examples

TypeScript Project (.comittyrc)

{
  "style": "conventional",
  "provider": "openrouter",
  "model": "anthropic/claude-3-haiku",
  "autoCommit": false
}

Python Project (.comittyrc)

{
  "style": "natural",
  "provider": "openai",
  "model": "gpt-4",
  "explain": true
}

Global Setup

# Set your preferred provider globally
cat ~/.config/comitty/config.json

Troubleshooting

"No staged changes found"

git add .  # Stage your changes first

"API key not found"

export OPENROUTER_API_KEY="your-key"
# or configure in ~/.config/comitty/config.json

"Not in a git repository"

cd /path/to/your/git/repo

Large diffs get truncated

{
  "maxDiffSize": 20000  // Increase limit in config
}

Development

# Install dependencies
bun install

# Run in development
bun run dev

# Build for production
bun run build

# Test
bun test

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

License

MIT License - see LICENSE file for details.

Support

• Report bugs: https://github.com/your-username/comitty/issues
• Feature requests: https://github.com/your-username/comitty/discussions
• Documentation: https://github.com/your-username/comitty/wiki

Made with love by the Comitty team