zurawiki/gptcommit

A git prepare-commit-msg hook for authoring commit messages with LLMs.

解決する課題

gitのコミットメッセージ作成を自動化し、コード変更の記述的な要約を手動で作成する手間を省きます。開発者のワークフローを妨げることなく、コミット履歴を明確かつ包括的に保つことができます。

仕組み

このツールは prepare-commit-msg gitフックとしてインストールされます。ユーザーが git commit を実行すると、ツールはステージングされた変更 (diffs) を分析し、OpenAIの言語モデルに送信して、簡潔な命令形のタイトルと事実に基づいた箇条書きを生成します。ユーザーはデフォルトのモデルを上書きしたり、カスタムプロンプトを設定したり、Gitスタイルのパターンを使用して無視するファイルを構成したりできます。

対象ユーザー

高品質なコミットメッセージを維持したいが、技術的な変更の要約をAIで自動化したい開発者。

ハイライト

  • Gitフック統合: prepare-commit-msg フックとしてシームレスに動作し、コミットメッセージフィールドを自動的に入力します。
  • 柔軟な設定: TOML設定ファイルを通じて、ユーザーレベル、リポジトリレベル、および環境変数の設定をサポートします。
  • カスタマイズ可能なAI: OpenAIモデル、APIベースURL、および出力言語 (英語、簡体字中国語、繁体字中国語、日本語をサポート) を変更できます。
  • スマートフィルタリング: file_ignore システムが含まれており、不要なファイル (lockファイルなど) がAIに送信されるのを防ぎます。
  • 多言語サポート: 複数の言語でコミットメッセージを生成できます。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト