AI Commit

English | 简体中文 | 日本語 | 한국어 | Español | العربية

A powerful CLI tool that generates Conventional Commits messages from your git changes using OpenAI-compatible APIs. Stop struggling with commit messages. Let AI write them for you—concise, standardized, and meaningful. 🔒 Absolutely Secure | 🛡️ Privacy First | 🆓 100% Free & Open Source

Features

• 🔒 Privacy First: Your code is sent directly to your configured API provider. No intermediate servers, no tracking. 100% Open Source—audit it yourself. Configuration is stored locally.
• 🤖 AI-Powered Generation: Analyzes your git diff to generate accurate and descriptive commit messages.
• 📏 Conventional Commits: Follows the standard format (feat, fix, chore, etc.) out of the box.
• 🎯 Multiple Options: Generates multiple commit message variations for you to choose from.
• 🌍 Multi-Language Support: Fully localized in English, Chinese, Japanese, Korean, Spanish, and Arabic.
• 🔧 Highly Configurable: Support for custom OpenAI-compatible APIs (DeepSeek, Azure, etc.), custom models, and prompts.
• 📊 Cost Tracking: Built-in usage statistics to track your token consumption and costs.
• 🚀 Interactive Mode: Review, edit, regenerate, or commit directly from the CLI.
• 🧠 Smart Context: Automatically compresses large diffs to fit within token limits while preserving context.
• 🎨 Fun ASCII Art: Customizable startup banner (Psyduck, Totoro, Cat, etc.).
• 🪝 Git Hook Support: Can be used as a prepare-commit-msg hook or with other git tools.

Installation

Ensure you have Node.js (>= 18.0.0) installed.

# Install globally via npm
npm install -g @alekschen/ai-commit

Updating

This tool automatically checks for updates and will notify you if a new version is available. To update manually:

npm install -g @alekschen/ai-commit@latest

Quick Start

1. Initialize Configuration Run the config command to set up your API key (OpenAI or compatible provider).

   ai-commit config

   

2. Generate a Commit Stage your changes and run:

   git add .
   ai-commit

   Or simply run ai-commit and let it stage changes for you (if configured).

   

3. Review & Commit The tool will generate options. You can:

   • Select: Choose your preferred message.
   • Edit: Modify the message in your default editor.
   • Regenerate: Ask AI to try again.

Usage

Basic Commands

# Generate commit message for staged changes
ai-commit

# Provide a hint to guide the generation
ai-commit "refactor authentication logic"

# Print the message to stdout without interactive menu (useful for scripts)
ai-commit --print

# Write message to a file (useful for git hooks like prepare-commit-msg)
ai-commit --write .git/COMMIT_EDITMSG

# Run in quiet mode (suppress banners/logs)
ai-commit --quiet

Configuration

Manage your settings via the interactive menu:

ai-commit config

You can configure:

• API Provider: Base URL (default: https://api.openai.com/v1) and API Key.
• Model: Choose any chat model (default: gpt-3.5-turbo).
• Prompt Style: Choose from Default, Emoji, Simple, or Custom templates.
• ASCII Art: Customize the startup banner.
• Language: Switch UI language.

View Usage Statistics

Check your API usage, token count, and model performance:

ai-commit cost

Environment Variables

You can override configuration using environment variables, useful for CI/CD pipelines:

| Variable | Description | | ---------------------------- | ------------------------------------------------------ | | AI_COMMIT_API_KEY | Your API Key | | AI_COMMIT_BASE_URL | Custom API Base URL | | AI_COMMIT_MODEL | Model name (e.g., gpt-4, deepseek-chat) | | AI_COMMIT_MAX_CHARS | Max characters for diff context (default: 200000) | | AI_COMMIT_MAX_FILES | Max files to process (default: 50) | | AI_COMMIT_MAX_LINES | Max lines per file to include (default: 15) | | AI_COMMIT_INCLUDE_SNIPPETS | Set to 0 to disable code snippets in prompt | | AI_COMMIT_AUTO_STAGE | Set to 1 to auto-stage changes, 0 to fail if empty | | AI_COMMIT_SIGN | Set to 1 to sign commits (git commit -S) | | AI_COMMIT_AMEND | Set to 1 to amend commits (git commit --amend) |

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

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

License

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