Commiti 🤖

Claude APIを使用したAI駆動のGitコミットメッセージ生成ツール（Conventional Commits形式対応）

特徴

• 🧠 AI駆動: Claude APIを使用してステージされた変更を分析し、意味のあるコミットメッセージを生成
• 📝 Conventional Commits: Conventional Commits仕様に準拠
• 🎯 複数の候補: 選択できる複数のコミットメッセージ候補を生成
• ✏️ 編集可能: 生成されたメッセージをコミット前に編集可能
• ⚙️ 設定可能: .commitirc.jsonファイルでカスタマイズ可能
• 🚫 ファイル除外: 特定のファイル/パターンを分析から除外
• 🌐 多言語対応: 日本語と英語をサポート

インストール

npm install

セットアップ

1. 設定ファイルを作成:

npm run dev -- --config

2. .commitirc.jsonを編集してClaude APIキーを設定:

{
  "apiKey": "your-claude-api-key-here"
}

または環境変数を設定:

export CLAUDE_API_KEY="your-claude-api-key-here"

使用方法

1. 変更をステージ:

git add .

2. 生成してコミット:

npm run dev

開発用コマンド

# 開発モードで実行
npm run dev

# プロジェクトをビルド
npm run build

# 設定ファイルを作成
npm run dev -- --config

# ヘルプを表示
npm run dev -- --help

設定

.commitirc.jsonファイルでカスタマイズできる項目:

{
  "apiKey": "your-claude-api-key",
  "model": "claude-3-haiku-20240307",
  "conventionalCommits": {
    "types": ["feat", "fix", "docs", "style", "refactor", "test", "chore"],
    "scopes": ["api", "ui", "db", "auth"],
    "maxLength": 50
  },
  "exclude": [
    "*.log",
    "node_modules/**",
    "dist/**",
    "build/**",
    "*.lock"
  ],
  "language": "ja",
  "generateCount": 3
}

ワークフロー例

# 変更を加える
echo "console.log('Hello, World!');" > hello.js

# 変更をステージ
git add hello.js

# commitiを実行
npm run dev

出力例:

🤖 Commiti - ステージされた変更を分析中...

📋 ステージされた変更:
1 file changed, 1 insertion(+), 0 deletions(-)

  ✅ hello.js (+1/-0)

ℹ️  コミットメッセージ候補を生成中...

🤖 生成されたコミットメッセージ候補:

  1. feat: add hello world example script
  2. chore: create initial hello.js file
  3. feat(example): implement basic hello world output

✨ コミットメッセージを選択: 1

📝 コミットメッセージを編集（そのまま使用する場合はEnterを押下）:
feat: add hello world example script

📄 最終コミットメッセージ:
"feat: add hello world example script"

✅ このメッセージでコミットしますか？ (y/N): y

🎉 変更が正常にコミットされました！

開発

# 依存関係をインストール
npm install

# 開発モードで実行
npm run dev

# 本番用にビルド
npm run build

ライセンス

MIT