claude-commit-msg-gen

Claude API と Lefthook を組み合わせ、git commit 時に Conventional Commits 形式のコミットメッセージを自動生成するツールです。

構造・設計の詳細は docs/ARCHITECTURE.md を参照してください。

セットアップ

# 1. 本ライブラリのインストール
# Without Node.js. バージョン更新の際もこのスクリプトを一度実行する
curl -fsSL https://raw.githubusercontent.com/Himenon/claude-commit-msg-gen/main/scripts/install.sh | sh
# With Node.js
pnpm install -g @himenon/claude-commit-msg-gen

# Installできているか確認する
claude-commit-msg-gen --version

## 2. lefthookのインストール
brew install lefthook
# または
pnpm add -g lefthook

# 3. Anthropic API キーを設定
# .bashrc, .zshrc, .fish/config.fish
export ANTHROPIC_API_KEY="sk-ant-..."

lefthookのセットアップ

lefthook.ymlに以下の内容を記述し、lefthook installを実行する。

prepare-commit-msg:
  jobs:
    - name: auto-commit-message
      run: claude-commit-msg-gen {1} {2}
      env:
        CLAUDE_MODEL: claude-haiku-4-5-20251001
        CLAUDE_MAX_TOKENS: "150"

COMMIT_PROMPT は省略可能です。省略した場合、Conventional Commits 形式のコミットメッセージを生成するデフォルトプロンプトが使用されます。

COMMIT_LANGUAGE でコミットメッセージの言語を切り替えられます。

| 値 | 言語 | | -- | ---- | | ja（デフォルト） | 日本語（subject は50文字以内） | | en | 英語（subject は72文字以内） |

      env:
        CLAUDE_MODEL: claude-haiku-4-5-20251001
        CLAUDE_MAX_TOKENS: "150"
        COMMIT_LANGUAGE: en  # 英語で生成する場合

プロジェクト固有のルールを追加したい場合は COMMIT_PROMPT で上書きできます。COMMIT_PROMPT を指定した場合、COMMIT_LANGUAGE は無視されます。

      env:
        COMMIT_PROMPT: >
          以下のgit diffを分析し、Conventional Commits形式のコミットメッセージを1行だけ生成してください。
          （プロジェクト独自のルールをここに追加）

lefthookをプロジェクトに含めたくない場合もしくは、プロジェクトのlefthookを汚染したくない場合

1. .gitignoreにlefthook-local.ymlを追加する
2. lefthook-local.ymlにlefthookのセットアップの内容を記述する
3. lefthook installを実行する。