Repolode
提交项目
appleboy

appleboy/CodeGPT

一个用 Go 编写的命令行工具，借助大模型生成 git 提交信息和代码审查摘要，并可自动安装 prepare-commit-msg 钩子。

在 GitHub 查看
Star
1,504
Fork
132
未关闭 Issue
10
最近提交
上个月

这是什么？

CodeGPT 是一个用 Go 编写的命令行工具，可以根据暂存区的改动生成 git 提交信息，也能输出简要的代码审查摘要。既可以直接运行 `codegpt commit` 或 `codegpt review`，也可以安装为 prepare-commit-msg 钩子，让生成的提交信息在提交时直接出现在编辑器中。

默认使用 OpenAI API，模型可配置为 gpt-4o 等。项目还支持 Azure OpenAI、Gemini（Gemini API 与 VertexAI）、Anthropic、Groq、Ollama、OpenRouter 以及 LiteLLM 代理。API 密钥可以保存在系统密钥环中，也可以通过辅助命令动态获取，例如从密码管理器或云端密钥服务读取。

输出可遵循 Conventional Commits 格式，并支持翻译为英文、繁体中文、简体中文或日文。提交信息模板、自定义模板变量、流式输出、diff 上下文行数、文件排除规则以及 SOCKS 或 HTTP 代理都可以配置。

核心功能

  • 01根据暂存区的 git 改动生成遵循 Conventional Commits 格式的提交信息。
  • 02通过一条命令安装或卸载 prepare-commit-msg git 钩子。
  • 03为暂存的改动生成简要的代码审查摘要。
  • 04支持 OpenAI、Azure OpenAI、Gemini、Anthropic、Groq、Ollama、OpenRouter 和 LiteLLM。
  • 05可将生成的信息翻译为中文、日文等多种语言。
  • 06支持自定义提交信息模板和提示词模板。

适用场景

  • 不必花时间斟酌措辞，就能为改动写出规范的提交信息。
  • 在提交 pull request 前，快速审视暂存区的改动。
  • 通过 Ollama 使用本地模型生成提交信息。
  • 借助共享模板统一团队的提交历史格式。

快速上手

  1. 1

    添加 Homebrew tap

    brew tap appleboy/tap
  2. 2

    使用 Homebrew 安装 CodeGPT

    brew install codegpt
  3. 3

    设置你的 OpenAI API 密钥

    export OPENAI_API_KEY=sk-xxxxxxx

使用前须知

  • 默认的 OpenAI 提供商需要付费 LLM 服务的 API 密钥，或使用 Ollama 等自托管替代方案。

收录于专题

AI 编程助手与编码 Agent命令行与终端工具

标签

#git#openai#llm#commit-message#code-review#cli#git-hook#golang#chatgpt#chatgpt-api

常见问题

CodeGPT 是什么？
一个用 Go 编写的命令行工具，借助大模型生成 git 提交信息和代码审查摘要，并可自动安装 prepare-commit-msg 钩子。 CodeGPT 是一个用 Go 编写的命令行工具，可以根据暂存区的改动生成 git 提交信息，也能输出简要的代码审查摘要。既可以直接运行 `codegpt commit` 或 `codegpt review`，也可以安装为 prepare-commit-msg 钩子，让生成的提交信息在提交时直接出现在编辑器中。
CodeGPT 可以免费使用吗？用的什么许可证？
CodeGPT 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
CodeGPT 还在维护吗？
半年内有更新。CodeGPT 最近一次提交是在 2026年9月29日。
CodeGPT 适合用来做什么？
不必花时间斟酌措辞，就能为改动写出规范的提交信息。 在提交 pull request 前，快速审视暂存区的改动。 通过 Ollama 使用本地模型生成提交信息。 借助共享模板统一团队的提交历史格式。
CodeGPT 怎么安装和运行？
添加 Homebrew tap: brew tap appleboy/tap 使用 Homebrew 安装 CodeGPT: brew install codegpt 设置你的 OpenAI API 密钥: export OPENAI_API_KEY=sk-xxxxxxx
在哪里获取 CodeGPT？
源代码和安装说明在 GitHub 上：https://github.com/appleboy/CodeGPT

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目