一個用 Go 編寫的 CLI 工具，使用 ChatGPT AI (gpt-4o, gpt-4 模型) 生成 git 提交訊息或提供代碼審查摘要。它還會自動安裝 git prepare-commit-msg hook。
- 支援 Azure OpenAI Service、OpenAI API、Gemini、Anthropic、Ollama、Groq 和 OpenRouter。
- 遵循 conventional commits 規範。
- 與 Git prepare-commit-msg Hook 集成，請參閱 Git Hooks 文檔。
- 允許自定義生成的差異，指定上下文行數（默認為三行）。
- 允許從 git diff 命令中排除文件。
- 將提交訊息翻譯成其他語言（支援
en、zh-tw或zh-cn）。 - 支援 SOCKS 代理或自定義網絡 HTTP 代理。
- 提供 模型列表，包括
gpt-4、gpt-4o等。 - 生成簡短的代碼審查。
- 允許自定義提示模板和變量。
通過 Homebrew 安裝：
brew tap appleboy/tap
brew install codegpt通過 Chocolatey 安裝：
choco install codegpt從 release 頁面 下載預編譯的二進制文件。將二進制文件的權限更改為 755，並將二進制文件複製到系統 bin 目錄。使用如下所示的 codegpt 命令：
$ codegpt version
version: v0.4.3 commit: xxxxxxx從源碼安裝：
go install github.com/appleboy/CodeGPT/cmd/codegpt@latest首先，創建您的 OpenAI API Key。 OpenAI 平台 允許您生成新的 API Key。
設置環境變量 OPENAI_API_KEY：
export OPENAI_API_KEY=sk-xxxxxxx或者，將您的 API key 存儲在自定義配置文件中：
codegpt config set openai.api_key sk-xxxxxxx這將在您的主目錄中創建一個 .codegpt.yaml 文件（$HOME/.config/codegpt/.codegpt.yaml）。以下選項可用：
| 選項 | 描述 |
|---|---|
| openai.base_url | 替換默認的基礎 URL (https://api.openai.com/v1)。 |
| openai.api_key | 從 openai 平台頁面 生成 API key。 |
| openai.org_id | 在 API 請求中有時使用的組織標識符。請參閱 組織設置。僅適用於 openai 服務。 |
| openai.model | 默認模型是 gpt-4o，您可以更改為其他自定義模型（Groq 或 OpenRouter 提供者）。 |
| openai.proxy | HTTP/HTTPS 客戶端代理。 |
| openai.socks | SOCKS 客戶端代理。 |
| openai.timeout | 默認 HTTP 超時為 10s（十秒）。 |
| openai.max_tokens | 默認最大 token 為 300。請參閱參考 max_tokens。 |
| openai.temperature | 默認溫度為 1。請參閱參考 temperature。 |
| git.diff_unified | 生成具有 <n> 行上下文的差異，默認為 3。 |
| git.exclude_list | 從 git diff 命令中排除文件。 |
| openai.provider | 默認服務提供者是 openai，您可以更改為 azure。 |
| output.lang | 默認語言是 en，可用語言有 zh-tw、zh-cn、ja。 |
| openai.top_p | 默認 top_p 為 1.0。請參閱參考 top_p。 |
| openai.frequency_penalty | 默認 frequency_penalty 為 0.0。請參閱參考 frequency_penalty。 |
| openai.presence_penalty | 默認 presence_penalty 炭 0.0。請參閱參考 presence_penalty。 |
| prompt.folder | 默認提示文件夾是 $HOME/.config/codegpt/prompt。 |
默認提示文件夾位於 $HOME/.config/codegpt/prompt。您可以通過執行以下命令將其更改為其他目錄：
codegpt config set prompt.folder /path/to/your/prompt要從自定義文件夾加載提示文件，請運行：
codegpt prompt --load執行後，您將看到類似以下的消息：
save code_review_file_diff.tmpl to /Users/xxxxx/.config/codegpt/prompt/code_review_file_diff.tmpl
save summarize_file_diff.tmpl to /Users/xxxxx/.config/codegpt/prompt/summarize_file_diff.tmpl
save summarize_title.tmpl to /Users/xxxxx/.config/codegpt/prompt/summarize_title.tmpl
save conventional_commit.tmpl to /Users/xxxxx/.config/codegpt/prompt/conventional_commit.tmpl從 Azure 資源管理門戶左側菜單中獲取 API key、Endpoint 和 Model deployments 列表。
更新您的配置文件：
codegpt config set openai.provider azure
codegpt config set openai.base_url https://xxxxxxxxx.openai.azure.com/
codegpt config set openai.api_key xxxxxxxxxxxxxxxx
codegpt config set openai.model xxxxx-gpt-4o支援 Gemini API 服務
使用 Gemini API 構建，您可以查看 Gemini API 文檔。在您的配置文件中更新 provider 和 api_key。請從 Gemini API 頁面創建 API key。
codegpt config set openai.provider gemini
codegpt config set openai.api_key xxxxxxx
codegpt config set openai.model gemini-1.5-flash-latest支援 Anthropic API 服務
使用 Anthropic API 構建，您可以查看 Anthropic API 文檔。在您的配置文件中更新 provider 和 api_key。請從 Anthropic API 頁面創建 API key。
codegpt config set openai.provider anthropic
codegpt config set openai.api_key xxxxxxx
codegpt config set openai.model claude-3-5-sonnet-20241022請參閱 Anthropic API 文檔 中的模型列表。
如何切換到 Groq API 服務
從 Groq API 服務獲取 API key，請訪問 此處。在您的配置文件中更新 base_url 和 api_key。
codegpt config set openai.provider openai
codegpt config set openai.base_url https://api.groq.com/openai/v1
codegpt config set openai.api_key gsk_xxxxxxxxxxxxxx
codegpt config set openai.model llama3-8b-8192GroqCloud 目前支援 以下模型：
我們可以使用 Ollama API 服務的 Llama3 模型，請訪問 此處。在您的配置文件中更新 base_url。
# pull llama3 8b model
ollama pull llama3
ollama cp llama3 gpt-4o嘗試使用 Ollama API 服務：
curl http://localhost:11434/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o",
"messages": [
{
"role": "user",
"content": "Hello!"
}
]
}'在您的配置文件中更新 base_url。您不需要在配置文件中設置 api_key。
codegpt config set openai.base_url http://localhost:11434/v1如何切換到 OpenRouter API 服務
您可以查看 支援的模型列表，模型使用可以由用戶、開發者或兩者支付，並且可能會在 可用性 上發生變化。您還可以通過 API 獲取模型、價格和限制。
以下示例使用免費模型名稱：meta-llama/llama-3-8b-instruct:free
codegpt config set openai.provider openai
codegpt config set openai.base_url https://openrouter.ai/api/v1
codegpt config set openai.api_key sk-or-v1-xxxxxxxxxxxxxxxx
codegpt config set openai.model google/learnlm-1.5-pro-experimental:free要將您的應用程序包含在 openrouter.ai 排名中並在 openrouter.ai 上顯示，您可以在配置文件中設置 openai.headers：
codegpt config set openai.headers "HTTP-Referer=https://github.com/appleboy/CodeGPT X-Title=CodeGPT"- HTTP-Referer：可選，用於將您的應用程序包含在 openrouter.ai 排名中。
- X-Title：可選，用於在 openrouter.ai 上顯示排名。
有兩種使用 codegpt 命令生成提交訊息的方法：CLI 模式和 Git Hook。
您可以直接調用 codegpt 來為您的暫存更改生成提交訊息：
git add <files...>
codegpt commit --preview提交訊息如下所示：
使用 gpt-4o 模型總結提交訊息
我們正在嘗試總結 git 差異
我們正在嘗試總結拉取請求的標題
================提交摘要====================
feat: 在 commit 命令和模板文件中添加預覽標記並移除 disableCommit 標記。
- 在 `commit` 命令中添加 `preview` 標記
- 從 `prepare-commit-msg` 模板文件中移除 `disableCommit` 標記
==================================================
將提交訊息寫入 .git/COMMIT_EDITMSG 文件或者將所有 git 提交訊息翻譯成其他語言（繁體中文、簡體中文 或 日文）：
codegpt commit --lang zh-tw --preview考慮以下結果：
使用 gpt-4o 模型總結提交訊息
我們正在嘗試總結 git 差異
我們正在嘗試總結拉取請求的標題
我們正在嘗試將 git 提交訊息翻譯成繁體中文
================提交摘要====================
功能：重構 codegpt commit 命令標記
- 將「codegpt commit」命令新增「預覽」標記
- 從「codegpt commit」命令中移除「--disableCommit」標記
==================================================
將提交訊息寫入 .git/COMMIT_EDITMSG 文件您可以使用 --amend 標記創建新提交來替換當前分支的頂端：
codegpt commit --amend默認的提交訊息模板如下：
{{ .summarize_prefix }}: {{ .summarize_title }}
{{ .summarize_message }}
使用 --template_string 參數更改格式：
codegpt commit --preview --template_string \
"[{{ .summarize_prefix }}]: {{ .summarize_title }}"使用 --template_file 參數更改格式：
codegpt commit --preview --template_file your_file_path將自定義變量添加到 git 提交訊息模板：
{{ .summarize_prefix }}: {{ .summarize_title }}
{{ .summarize_message }}
{{ if .JIRA_URL }}{{ .JIRA_URL }}{{ end }}使用 --template_vars 參數將自定義變量添加到 git 提交訊息模板：
codegpt commit --preview --template_file your_file_path --template_vars \
JIRA_URL=https://jira.example.com/ABC-123使用 --template_vars_file 參數從文件加載自定義變量：
codegpt commit --preview --template_file your_file_path --template_vars_file your_file_path請參閱 template_vars_file 格式如下：
JIRA_URL=https://jira.example.com/ABC-123你也可以使用 prepare-commit-msg 鉤子將 codegpt 與 Git 集成。這允許你正常使用 Git 並在提交之前編輯提交訊息。
你需要在 Git 儲存庫中安裝鉤子：
codegpt hook install你需要從 Git 儲存庫中移除鉤子：
codegpt hook uninstall將文件暫存並在安裝後提交：
git add <files...>
git commitcodegpt 將為你生成提交訊息並將其傳回給 Git。Git 將使用配置的編輯器打開它供你審查/編輯。然後，保存並關閉編輯器以提交！
$ git commit
Summarize the commit message use gpt-4o model
We are trying to summarize a git diff
We are trying to summarize a title for pull request
================Commit Summary====================
Improve user experience and documentation for OpenAI tools
- Add download links for pre-compiled binaries
- Include instructions for setting up OpenAI API key
- Add a CLI mode for generating commit messages
- Provide references for OpenAI Chat completions and ChatGPT/Whisper APIs
==================================================
Write the commit message to .git/COMMIT_EDITMSG file
[main 6a9e879] Improve user experience and documentation for OpenAI tools
1 file changed, 56 insertions(+)你可以使用 codegpt 為你已暫存的更改生成程式碼審查訊息：
codegpt review或將所有程式碼審查訊息翻譯成其他語言（繁體中文、簡體中文 或 日文）
codegpt review --lang zh-tw請參閱以下結果：
Code review your changes using gpt-4o model
We are trying to review code changes
PromptTokens: 1021, CompletionTokens: 200, TotalTokens: 1221
We are trying to translate core review to Traditional Chinese language
PromptTokens: 287, CompletionTokens: 199, TotalTokens: 486
================Review Summary====================
總體而言，此程式碼修補似乎在增加 Review 指令的功能，允許指定輸出語言並在必要時進行翻譯。以下是需要考慮的潛在問題：
- 輸出語言沒有進行輸入驗證。如果指定了無效的語言代碼，程式可能會崩潰或產生意外結果。
- 此使用的翻譯 API 未指定，因此不清楚是否存在任何安全漏洞。
- 無法處理翻譯 API 調用的錯誤。如果翻譯服
==================================================另一個 PHP 範例代碼：
<?php
if( isset( $_POST[ 'Submit' ] ) ) {
// Get input
$target = $_REQUEST[ 'ip' ];
// Determine OS and execute the ping command.
if( stristr( php_uname( 's' ), 'Windows NT' ) ) {
// Windows
$cmd = shell_exec( 'ping ' . $target );
}
else {
// *nix
$cmd = shell_exec( 'ping -c 4 ' . $target );
}
// Feedback for the end user
$html .= "<pre>{$cmd}</pre>";
}
?>程式碼審查結果：
================Review Summary====================
Code review:
1. Security: The code is vulnerable to command injection attacks as the user input is directly used in the shell_exec() function. An attacker can potentially execute malicious commands on the server by injecting them into the 'ip' parameter.
2. Error handling: There is no error handling in the code. If the ping command fails, the error message is not displayed to the user.
3. Input validation: There is no input validation for the 'ip' parameter. It should be validated to ensure that it is a valid IP address or domain name.
4. Cross-platform issues: The code assumes that the server is either running Windows or *nix operating systems. It may not work correctly on other platforms.
Suggestions for improvement:
1. Use escapeshellarg() function to sanitize the user input before passing it to shell_exec() function to prevent command injection.
2. Implement error handling to display error messages to the user if the ping command fails.
3. Use a regular expression to validate the 'ip' parameter to ensure that it is a valid IP address or domain name.
4. Use a more robust method to determine the operating system, such as the PHP_OS constant, which can detect a wider range of operating systems.
==================================================運行以下命令來測試代碼：
make test