claude-auto-commit
Version:
AI-powered Git commit message generator using Claude Code SDK
263 lines (190 loc) β’ 8.4 kB
Markdown
# Claude Auto-Commit
<div align="center">
π€ **AI-powered Git commit message generator using Claude Code SDK**
[](https://opensource.org/licenses/MIT)
[](https://github.com/0xkaz/claude-auto-commit/releases)
[](https://www.npmjs.com/package/claude-auto-commit)
[](https://github.com/0xkaz/claude-auto-commit/stargazers)
[](https://github.com/0xkaz/claude-auto-commit/network)
[](https://github.com/0xkaz/claude-auto-commit/issues)
[](https://github.com/0xkaz/claude-auto-commit)
[](https://nodejs.org)
[](https://docs.anthropic.com/en/docs/claude-code)
</div>
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
<div align="center">
*Say goodbye to vague commit messages. Let Claude AI write meaningful commits that tell the story of your code.*
</div>
β οΈ **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)**
```bash
curl -fsSL https://raw.githubusercontent.com/0xkaz/claude-auto-commit/main/scripts/install.sh | bash
```
**Method 2: NPM global installation**
```bash
npm install -g claude-auto-commit
```
**Method 3: One-time execution (no installation)**
```bash
curl -fsSL https://raw.githubusercontent.com/0xkaz/claude-auto-commit/main/scripts/run-once.sh | bash
```
### Basic Usage
```bash
# 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](./docs/en/README.md)
- [ζ₯ζ¬θͺγγγ₯γ‘γ³γ](./docs/ja/README.md)
- [δΈζζζ‘£](./docs/zh/README.md)
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:
```bash
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
<div align="center">
*See Claude Auto-Commit in action with the `--summary` flag for detailed change analysis*
</div>
### Basic Usage
```bash
# 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
```bash
# 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)
```bash
curl -fsSL https://raw.githubusercontent.com/0xkaz/claude-auto-commit/main/scripts/install.sh | bash
```
### Method 2: Download from GitHub Releases
```bash
# 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
```bash
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
```bash
# 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`:
```yaml
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](./CONTRIBUTING.md) for details.
## π License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
## π Acknowledgments
- [Anthropic](https://anthropic.com) for Claude CLI
- [Conventional Commits](https://conventionalcommits.org) specification
- Open source community for inspiration
---
**Made with β€οΈ for the developer community**
[Report Issues](https://github.com/0xkaz/claude-auto-commit/issues) | [Request Features](https://github.com/0xkaz/claude-auto-commit/issues/new?template=feature_request.md) | [Documentation](https://github.com/0xkaz/claude-auto-commit)