gptcommit

一個用於使用LLM撰寫提交訊息的git prepare-commit-msg鉤子。

gptcommit 是什麼?

一個用於使用LLM撰寫提交訊息的git prepare-commit-msg鉤子。

gptcommit 概覽

這是什麼

gptcommit 是一個命令列工具,可安裝為 git 的 prepare-commit-msg 鉤子。它使用 OpenAI 語言模型,根據儲存庫中的暫存變更自動產生提交訊息。此工具以 Rust 撰寫,採用 MIT 授權的開源軟體。

主要功能

  • 使用 OpenAI 語言模型自動產生提交訊息(預設模型為 gpt-6-luna,低推理努力,2,048 token 限制)。
  • 支援透過 $HOME/.config/gptcommit/config.toml、每個儲存庫的 $GIT_ROOT/.git/gptcommit.toml 以及 GPTCOMMIT__* 環境變數進行設定。
  • 可使用 Git 風格的模式在 file_ignore 設定中忽略特定檔案,不納入差異分析。
  • 支援自訂 OpenAI API 金鑰、基礎 URL、模型、代理設定及輸出語言(英文、簡體中文、繁體中文、日文)。
  • 提供 config set、config get 和 config delete 子命令來管理設定。
  • 預設安靜執行;可使用 --verbose 啟用詳細記錄。

使用情境

使用 gptcommit 自動為 git 儲存庫產生描述性的提交訊息,減少撰寫提交訊息的時間。適合希望專注於編寫程式碼,同時仍能維持清晰且完整的提交歷史的開發者。此工具可設定不同的 OpenAI 模型和語言,適應各種工作流程和團隊偏好。

快速開始

使用 Cargo 安裝 gptcommit:shcargo install --locked gptcommit在 macOS 上,可透過 Homebrew 安裝:shbrew install zurawiki/brews/gptcommit在您的 git 儲存庫中,安裝鉤子並提供 OpenAI API 金鑰:gptcommit install

授權與價格

此專案採用 MIT 授權。此工具為開源且免費使用。使用 OpenAI API 需要 API 金鑰,並可能根據 OpenAI 的定價產生費用。

內容整理自該專案公開的 README 與儲存庫資訊。

將此徽章加入你的 README

Featured on YunoDB 徽章樣式與說明

你是這個專案的維護者嗎?展示它已收錄於 YunoDB。

Markdown[![Featured on YunoDB](https://yunodb.com/badge/zurawikigptcommit.svg)](https://yunodb.com/tools/zurawikigptcommit?utm_source=github&utm_medium=badge)
HTML<a href="https://yunodb.com/tools/zurawikigptcommit?utm_source=github&utm_medium=badge"><img src="https://yunodb.com/badge/zurawikigptcommit.svg" alt="Featured on YunoDB" height="20"></a>