README.md

Claude Auto-Commit

🤖 Claude Code SDKを使用したAI駆動のGitコミットメッセージ生成ツール

言語: English | 中文

Claude Auto-Commitは、AI駆動のコミットメッセージ生成をGitワークフローに統合するオープンソースのコマンドラインツールです。コードの変更を分析し、Claude Code SDKを使用して高性能で信頼性の高い、意味のある文脈に沿ったコミットメッセージを作成します。

🌟 コミット履歴を変革

曖昧なコミットメッセージにさようなら。Claude AIにコードの物語を語る意味のあるコミットを書かせましょう。

⚠️ 重要な注意事項:

• Claude Pro/MaxサブスクリプションとClaude CLI認証が必要です
• APIキーは不要 - Claude Code SDKでOAuth認証を使用
• まだ認証していない場合は claude login を実行してください
• デフォルトで全ての変更を自動ステージングしてコミットします
• リモートリポジトリへの自動プッシュは --push フラグを使用
• コミット前のプレビューは --dry-run フラグを使用

🚀 クイックスタート

インストール方法

方法1: NPX実行（推奨、インストール不要）

npx claude-auto-commit

方法2: NPMグローバルインストール

npm install -g claude-auto-commit

方法3: スクリプトインストール

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

方法4: ワンタイムスクリプト実行

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

基本的な使い方

# 変更を分析してコミットメッセージ生成
npx claude-auto-commit

# 日本語・絵文字・Conventional Commits形式
npx claude-auto-commit -l ja -e -c

# カスタムコミットタイプで自動プッシュ
npx claude-auto-commit -t feat --push

認証設定

Claude Auto-CommitはClaude Code SDKを使用し、Claude ProまたはMaxサブスクリプションが必要です：

# 初回設定: Claude CLIにログイン
claude login

# オプション選択: "2. Claude app (requires Max subscription)"
# ブラウザでOAuth認証が開きます
# APIキー不要 - 認証は自動で処理されます

初回ログイン後は認証情報が保存され、claude-auto-commitがシームレスに動作します。

✨ 機能

• 🧠 AI駆動: Claude CLIを使用して智的なコミットメッセージを生成
• 🌍 多言語対応: 日本語、英語、中国語、アラビア語、スペイン語、フランス語に対応
• 📝 Conventional Commits: オプションでConventional Commits形式に対応
• 🔄 自動更新: 毎日の自動更新（設定可能）
• 🎯 智的分析: コード変更、ファイルタイプ、パターンを分析
• ⚡ 高速・軽量: 日常的な開発ワークフローに最適化
• 🛠️ 高度な設定: 豊富なカスタマイズオプション

📋 要件

• Gitリポジトリ
• Claude CLI がインストール・設定済み
• Bashシェル（macOS、Linux、WSL）

🎯 使用例

基本的な使用方法

# 自動生成されたメッセージでシンプルなコミット
claude-auto-commit

# カスタムブランチと絵文字
claude-auto-commit -b develop -e

# 日本語でConventional Commits
claude-auto-commit -l ja -c -t feat

# カスタムメッセージ、プッシュなし
claude-auto-commit -m "カスタムコミットメッセージ" -n

高度なオプション

# 手動ステージングと詳細出力
claude-auto-commit -s -v

# ホットフィックス用のカスタムプレフィックス
claude-auto-commit -p "[HOTFIX]" -t fix

# ツールの更新
claude-auto-commit --update

🔧 インストール方法

方法1: ワンライナー（推奨）

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

方法2: 手動ダウンロード

# プラットフォーム用にダウンロード
curl -L -o claude-auto-commit https://github.com/0xkaz/claude-auto-commit/releases/latest/download/claude-auto-commit-$(uname -s)-$(uname -m)
chmod +x claude-auto-commit
sudo mv claude-auto-commit /usr/local/bin/

方法3: NPX（Node.jsユーザー向け）

npx claude-auto-commit@latest

⚙️ 設定

~/.claude-auto-commit/config.ymlを作成：

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

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

git:
  auto_stage: true
  auto_push: true

📖 全オプション

オプション	説明	デフォルト
-b, --branch <branch>	プッシュ先ブランチ	main
-l, --language <lang>	言語 (ja/en/zh/ar/es/fr)	en
-e, --emoji	絵文字使用	false
-n, --no-push	プッシュしない	false
-s, --no-stage	手動ステージング	false
-m, --message <msg>	カスタムメッセージ	Claude生成
-t, --type <type>	コミットタイプ	自動
-c, --conventional	Conventional Commits	false
-p, --prefix <prefix>	プレフィックス	なし
-v, --verbose	詳細出力	false
--update	即座に更新	-
--no-update	今回は更新をスキップ	-
--version	バージョン表示	-
-h, --help	ヘルプ表示	-

🌟 特徴

智的なコミットメッセージ生成

Claude AIがコード変更を分析し、以下を考慮してメッセージを生成：

• 変更されたファイルの種類
• 追加・修正・削除された行数
• コードの実際の差分
• プロジェクトのコンテキスト

多言語対応

各言語のプログラミングコミュニティの文化に適したメッセージを生成：

• 日本語: 丁寧で詳細な説明
• 英語: 簡潔で標準的な表現
• 中国語: 技術的で直接的な表現

自動更新システム

• 毎日の自動更新チェック
• シームレスなバックグラウンド更新
• 失敗時の自動ロールバック

🤝 コントリビューション

コントリビューションを歓迎します！詳細はCONTRIBUTING.mdをご覧ください。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています - 詳細はLICENSEファイルをご覧ください。

🙏 謝辞

• Anthropic のClaude CLI
• Conventional Commits 仕様
• オープンソースコミュニティからのインスピレーション

---

開発者コミュニティへの愛を込めて ❤️

問題を報告 | 機能要求