Gptcommit 是一個基於自然語言生成模型 GPT 的 Git 提交消息生成工具。它可以幫助開發者以更加自然的方式編寫 Git 提交消息，從而提高程式碼可讀性和可維護性。在本文中，我們將介紹如何安裝和使用 Gptcommit。
官方演示#
安裝#
安裝 Gptcommit 非常簡單，您只需按照以下步驟進行操作即可。
- 本地安裝
Gptcommit 是一個 Rust 應用程式，因此您需要先安裝 Rust 工具鏈。您可以從 Rust 官網 下載並安裝 Rust。一旦 Rust 工具鏈安裝完成，您就可以使用 Cargo 命令來安裝 Gptcommit。在終端機或命令行視窗中輸入以下命令：
cargo install --locked gptcommit
此命令會下載 Gptcommit 的原始碼並構建可執行檔。構建完成後，Gptcommit 會被安裝到您的系統預設路徑下。
在 macOS 上安裝
brew install zurawiki/brews/gptcommit
- 在您的 git 存儲庫中，執行以下命令以安裝 gptcommit 為
git prepare-commit-msg挂鉤。您需要提供 OpenAI API 密鑰才能完成安裝。
gptcommit install
如果您遇到任何安裝問題，請參考 Gptcommit 官方文檔 以獲取更多信息。
使用#
要使用 gptcommit，只需git commit照常運行即可。該挂鉤將使用 GPT 等大型語言模型自動為您生成提交消息。如果您對生成的消息不滿意，您可以在提交之前隨時對其進行編輯。
注意：預設情況下，gptcommit 使用 GPT-3 模型。請確保您的 OpenAI 帳戶中有足夠的信用額度來使用它。
設置 OpenAI API 密鑰和 URL#
- 全局設置
#api
gptcommit config set openai.api_key sk-...
#url
gptcommit config set openai.api_base https://...
- repo 局部設置
#api
gptcommit config set --local openai.api_key sk-...
#url
gptcommit config set --local openai.api_base https://...
設置 commit 語言#
預設語言為 en 英語，可自行設置語言
gptcommit config set output.lang zh-cn
支持的語言：
| code | language |
|---|---|
en | English |
zh-cn | 簡體中文 |
zh-tw | 繁體中文 |
ja | 日本語 |
Gptcommit 還具有許多其他功能和選項，您可以通過輸入以下命令來查看它們：
gptcommit --help
此命令將顯示 Gptcommit 的幫助信息，其中包含有關如何使用內容、控制生成消息長度和設置預設配置等方面的詳細信息。
優點#
使用 Gptcommit 的一個主要優點是它可以減少手動輸入提交消息所需的時間和精力。相較於手動編寫提交消息，Gptcommit 可以大大縮短編寫提交消息的時間，並且能夠保證每個提交消息都符合語法規範。同時，由於 Gptcommit 會生成易於閱讀和理解的提交消息，因此它也可以提高程式碼的可讀性和可維護性。
另外，Gptcommit 還基於強大的自然語言生成模型 GPT，因此可以生成高品質的自然語言文本。無論是在編寫提交消息還是其他文本內容時，Gptcommit 都可以提供有用的幫助。
派生項目#
vscode-gptcommit 使用 GPT 模型通過 VS Code 的 gptcommit 實現自動化 git 提交 commit 插件。