guanguans/ai-commit

これは何？

主な機能

• 01git diffの内容からConventional Commits形式のメッセージを生成します。
• 02コミットタイプを選択でき、コミット前にメッセージを確認できます。
• 03OpenAI、Moonshot、ERNIE Botなど、複数のAIバックエンドに対応しています。
• 04生成したメッセージを表示するだけのdry-runモードを利用できます。
• 05ダウンロード可能な単一ファイルとして提供され、Composer経由でもインストールできます。

ユースケース

• Conventional Commits形式を採用しているプロジェクトで、一貫性のあるコミットメッセージを書く。
• 変更内容が多く、手作業で要約を書くのが面倒なときに、コミット作成を効率化する。
• 既存のGitHub CopilotまたはBito CLIの環境を使ってコミットメッセージを生成する。

クイックスタート

1. 1

   Composerでグローバルにインストールします（PHP 8.2以降が必要です）

   composer global require guanguans/ai-commit --dev -v
2. 2

   AIジェネレーターのAPIキーを設定します（例ではOpenAI Chatを使用）

   ai-commit config set generators.openai_chat.api_key sk-... --global
3. 3

   変更をステージし、メッセージを生成してコミットします

   ai-commit commit

使う前に知っておきたいこと

• !PHP 8.2以降が必要です。
• !多くのジェネレーターでは、APIキーまたは別途インストールしたCLIツールが必要です。

収録されている特集

トピック

よくある質問

ai-commit とは？

AIモデルでステージ済みの差分からConventional Commits形式のメッセージを生成してコミットするCLIツール。 ai-commitは、git diffを読み取ってAI生成ツールに送信し、type、subject、bodyを含むConventional Commits形式のメッセージを作成するPHP製CLIツールです。コミット前にメッセージを確認・編集できるほか、結果を表示するだけのdry runも利用できます。

ai-commit は無料で使えますか？ライセンスは？

ai-commit は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

ai-commit は今もメンテナンスされていますか？

活発にメンテナンス中。ai-commit の最終コミットは 2026年11月3日 です。

ai-commit は何に使えますか？

Conventional Commits形式を採用しているプロジェクトで、一貫性のあるコミットメッセージを書く。 変更内容が多く、手作業で要約を書くのが面倒なときに、コミット作成を効率化する。 既存のGitHub CopilotまたはBito CLIの環境を使ってコミットメッセージを生成する。

ai-commit のインストール方法は？

Composerでグローバルにインストールします（PHP 8.2以降が必要です）: composer global require guanguans/ai-commit --dev -v AIジェネレーターのAPIキーを設定します（例ではOpenAI Chatを使用）: ai-commit config set generators.openai_chat.api_key sk-... --global 変更をステージし、メッセージを生成してコミットします: ai-commit commit

ai-commit はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/guanguans/ai-commit