claude-auto-commit

Claude Auto-Commit

🤖 AI-powered Git commit message generator using Claude Code SDK

Claude Auto-Commit is an open-source tool that automatically generates intelligent Git commit messages by analyzing your code changes using Claude Code SDK. It integrates seamlessly into your development workflow with enhanced performance, reliability, and modern JavaScript architecture.

🌟 Transform Your Commit History

Say goodbye to vague commit messages. Let Claude AI write meaningful commits that tell the story of your code.

⚠️ Important Notes:

• Requires ANTHROPIC_API_KEY environment variable
• By default, this tool will automatically stage all changes and commit
• Use --push flag to enable auto-push to remote repository
• Use --dry-run flag to preview commit messages without committing

🚀 Quick Start

Installation Options

Method 1: One-liner installation (recommended)

curl -fsSL https://raw.githubusercontent.com/0xkaz/claude-auto-commit/main/scripts/install.sh | bash

Method 2: NPM global installation

npm install -g claude-auto-commit

Method 3: One-time execution (no installation)

curl -fsSL https://raw.githubusercontent.com/0xkaz/claude-auto-commit/main/scripts/run-once.sh | bash

Basic Usage

# Analyze changes and generate commit message
claude-auto-commit

# Japanese with emojis and conventional commits
claude-auto-commit -l ja -e -c

# Custom commit type with auto-push
claude-auto-commit -t feat --push

✨ Features

• 🧠 AI Analysis: Leverages Claude Code SDK for intelligent code change understanding
• 🌍 Multi-language: Interface available in English and Japanese
• 📝 Conventional Commits: Optional support for conventional commit format
• 😊 Emoji Support: Add contextual emojis to commit messages
• 🔍 Dry Run Mode: Preview commit messages without making actual commits
• 📝 Template System: Save and reuse common commit message patterns
• ⚙️ Configuration: JSON-based configuration file support
• 🔄 Retry Mechanism: Enhanced error handling with exponential backoff
• ⚡ Performance: Parallel processing and intelligent caching
• 🚀 Auto-push: Optional automatic push to remote repository
• 📊 Verbose Logging: Detailed execution metrics and statistics
• 🛠️ Configurable: Extensive customization through CLI options and config files
• 📦 Modern Architecture: Node.js ES modules with TypeScript support

📖 Documentation

• English Documentation
• 日本語ドキュメント
• 中文文档

Complete documentation available in this repository.

📋 Requirements

System Requirements

• Node.js 22.0.0 or later
• Git repository
• ANTHROPIC_API_KEY environment variable

Claude API Access

You need a Claude account with API access:

• Claude Pro ($20/month) - Small repositories
• Claude Max ($100/month) - Regular development
• Claude Max ($200/month) - Large projects/teams

Set your API key:

export ANTHROPIC_API_KEY="your-api-key"

Auto-Installation Dependencies

The tool automatically installs:

• Claude Code SDK (@anthropic-ai/claude-code)
• Required Node.js dependencies

🎯 Examples

See Claude Auto-Commit in action with the --summary flag for detailed change analysis

Basic Usage

# Simple commit with auto-generated message (will auto-stage, commit, and push)
claude-auto-commit

# Commit without auto-push (recommended for beginners)
claude-auto-commit -n

# Skip push confirmation prompt
claude-auto-commit -y

# Generate message without committing (dry-run)
claude-auto-commit --dry-run

# Show detailed change summary
claude-auto-commit --summary

# Manual file selection without auto-push
claude-auto-commit -s -n

# Custom branch and emoji
claude-auto-commit -b develop -e

# English with conventional commits
claude-auto-commit -l en -c -t feat

# Custom message, no push
claude-auto-commit -m "Custom commit message" -n

Advanced Options

# Manual staging with verbose output
claude-auto-commit -s -v

# Custom prefix for hotfix
claude-auto-commit -p "[HOTFIX]" -t fix

# Preview message without committing
claude-auto-commit --dry-run

# Show detailed change statistics
claude-auto-commit --summary

# Combine options for detailed preview
claude-auto-commit --dry-run --summary -v

# Template management
claude-auto-commit --save-template hotfix "🔥 HOTFIX: {description}"
claude-auto-commit --template hotfix
claude-auto-commit --list-templates

# Update tool
claude-auto-commit --update

🔧 Installation Methods

Method 1: Installation Script (Recommended)

curl -fsSL https://raw.githubusercontent.com/0xkaz/claude-auto-commit/main/scripts/install.sh | bash

Method 2: Download from GitHub Releases

# Download the latest release
curl -L -o claude-auto-commit https://github.com/0xkaz/claude-auto-commit/releases/latest/download/claude-auto-commit.sh
chmod +x claude-auto-commit
sudo mv claude-auto-commit /usr/local/bin/

Method 3: Clone and Install

git clone https://github.com/0xkaz/claude-auto-commit.git
cd claude-auto-commit
chmod +x src/claude-auto-commit.sh
sudo ln -s $(pwd)/src/claude-auto-commit.sh /usr/local/bin/claude-auto-commit

Method 4: Direct Script Usage

# For development or testing
git clone https://github.com/0xkaz/claude-auto-commit.git
cd claude-auto-commit
./src/claude-auto-commit.sh [options]

⚙️ Configuration

Create ~/.claude-auto-commit/config.yml:

auto_update:
  enabled: true
  frequency: daily  # daily/weekly/manual/always
  silent: false

defaults:
  language: en
  branch: main
  emoji: false
  conventional: false

git:
  auto_stage: true
  auto_push: true

🚀 What's New in v0.0.5

• Template System: Save and reuse commit message templates
  • Save templates: --save-template <name> "<template>"
  • Use templates: --template <name> or -T <name>
  • List templates: --list-templates
  • Delete templates: --delete-template <name>
• Smart placeholders: Use {variable} in templates for dynamic values

🤝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details.

📄 License

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

🙏 Acknowledgments

• Anthropic for Claude CLI
• Conventional Commits specification
• Open source community for inspiration

Made with ❤️ for the developer community

Report Issues | Request Features | Documentation