Repolode
zurawiki

zurawiki/gptcommit

ステージ済みの変更からOpenAIモデルでコミットメッセージを作成する、git prepare-commit-msgフックです。

スター
2,415
フォーク
81
未解決の Issue
9
最終コミット
5 日前

これは何?

gptcommitはgit prepare-commit-msgフックとしてインストールされます。いつもどおりgit commitを実行すると、ステージ済みの差分を読み取ってOpenAIモデルに送り、コミットメッセージを入力します。コミットする前にメッセージを編集できます。

ユーザー設定ファイル、リポジトリごとの設定、またはGPTCOMMIT__環境変数で設定できます。OPENAI_API_KEYとOPENAI_API_BASE環境変数にも対応しています。モデル、APIベースURL、プロキシ、リトライ回数、出力言語を変更でき、英語、簡体字中国語、繁体字中国語、日本語に対応しています。Conventional Commitsのプレフィックスを有効にしたり、プロンプトをカスタマイズしたりできます。

変更が大きい場合は、file_ignoreにGit形式のパターンを指定して、lockファイル、minify済みアセット、生成コードを差分から除外できます。ステージ済みの変更が空、またはすべて除外された場合は、メッセージに手を加えず、APIも呼び出しません。--verboseを付けて実行すると、進捗とスキップされたファイルが表示されます。cargoとHomebrewからインストールできます。

主な機能

  • 01OpenAIモデルを使い、ステージ済みの差分からコミットメッセージを生成します。
  • 021つのコマンドでgit prepare-commit-msgフックとしてインストールできます。
  • 03英語、簡体字中国語、繁体字中国語、日本語での出力に対応しています。
  • 04lockファイルやminify済みJavaScriptなどを、Git形式のignoreパターンで除外できます。
  • 05ユーザー、リポジトリ、環境変数の設定を重ねて適用でき、config get/setコマンドにも対応しています。
  • 06カスタムAPIベースURLとプロキシに対応し、Conventional Commitsのプレフィックスも有効にできます。

ユースケース

  • 日々の変更について、手作業で書かずにコミットメッセージの下書きを作成する。
  • チーム内でConventional Commitsのプレフィックスを使い、コミット履歴の一貫性を保つ。
  • 中国語や日本語など、英語以外の言語でコミットメッセージを書く。
  • カスタムAPIベースURLを使って、セルフホスト型または互換性のあるOpenAI形式のエンドポイントを利用する。

クイックスタート

  1. 1

    cargo を使って gptcommit バイナリをインストールします

    cargo install --locked gptcommit
  2. 2

    git リポジトリに prepare-commit-msg フックをインストールします(OpenAI API キーが必要です)

    gptcommit install

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

  • 利用可能なクレジットがある OpenAI API キーが必要です。使用料金は OpenAI から請求されます。
  • メッセージを生成するため、ステージ済みの差分が OpenAI API に送信されます。

収録されている特集

トピック

よくある質問

gptcommit とは?
ステージ済みの変更からOpenAIモデルでコミットメッセージを作成する、git prepare-commit-msgフックです。 gptcommitはgit prepare-commit-msgフックとしてインストールされます。いつもどおりgit commitを実行すると、ステージ済みの差分を読み取ってOpenAIモデルに送り、コミットメッセージを入力します。コミットする前にメッセージを編集できます。
gptcommit は無料で使えますか?ライセンスは?
gptcommit は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
gptcommit は今もメンテナンスされていますか?
活発にメンテナンス中。gptcommit の最終コミットは 2026年11月1日 です。
gptcommit は何に使えますか?
日々の変更について、手作業で書かずにコミットメッセージの下書きを作成する。 チーム内でConventional Commitsのプレフィックスを使い、コミット履歴の一貫性を保つ。 中国語や日本語など、英語以外の言語でコミットメッセージを書く。 カスタムAPIベースURLを使って、セルフホスト型または互換性のあるOpenAI形式のエンドポイントを利用する。
gptcommit のインストール方法は?
cargo を使って gptcommit バイナリをインストールします: cargo install --locked gptcommit git リポジトリに prepare-commit-msg フックをインストールします(OpenAI API キーが必要です): gptcommit install
gptcommit はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/zurawiki/gptcommit

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト