CodeGPT

让 AI 帮你写 Git 提交信息和代码审查，告别凑字数的 commit。

CodeGPT 是一个用 Go 语言编写的命令行工具，它利用 OpenAI 的 GPT-4.1 或 GPT-4o 模型自动生成 Git 提交信息，并能执行代码审查摘要。通过自动安装 Git 的 prepare-commit-msg 钩子，它能在每次提交时无缝介入，根据暂存区的代码差异生成符合规范的提交说明，省去手动编写 commit message 的麻烦。同时，它也支持对代码变更进行快速审查，输出简洁的审查意见，帮助开发者提前发现潜在问题。该工具旨在提升开发效率，减少琐碎工作，让开发者更专注于核心编码任务。

开源 free 对话助手

访问官网 ↗ GitHub ↗ 文档 ↗

GitHub 星标 ★ 1505

维护状态较活跃

是否开源是

定价模式 free

项目数据

分类对话助手

开发团队appleboy

所属国家

官网地址

GitHubhttps://github.com/appleboy/CodeGPT

定价模式free

价格说明开源项目，MIT许可证，完全免费，需自行部署使用。

访问状态

是否开源是

开源协议MIT

主要语言Go

技术栈/模型chatgpt,chatgpt-api,git,git-hook,golang,openai,openai-api

GitHub 星标★ 1505

30天Star增速

HF 下载量

上线时间2023-03-04 00:00:00

最近更新2026-09-05 00:00:00

维护状态较活跃

中文支持

访问方式

移动端支持

综合评分

收录时间2026-08-09

浏览次数4

使用教程

难度：入门约 10 分钟部署方式：命令行工具 6 步

环境要求

macOS、Windows 或 Linux 系统（安装脚本会自动检测 OS 与架构）
能访问 GitHub 以下载 release 二进制或安装脚本
一个 OpenAI API Key（在 OpenAI Platform 生成）
Git 仓库环境（用于调用提交信息生成与 prepare-commit-msg 钩子）

安装与启动步骤

1一键安装（推荐）

运行官方安装脚本，自动检测系统与架构、下载最新二进制并加入 PATH。
```
bash < <(curl -sSL https://raw.githubusercontent.com/appleboy/CodeGPT/main/install.sh)
```
2或下载脚本后执行

先把安装脚本下载到本地，赋执行权限后运行，效果与一键安装相同。
```
curl -LO https://raw.githubusercontent.com/appleboy/CodeGPT/main/install.sh
chmod +x install.sh
./install.sh
```
3手动安装二进制

从 release 页面下载对应平台的二进制，赋权后移动到系统 bin 目录。
```
chmod 755 codegpt
mv codegpt /usr/local/bin/
```
4验证安装

执行版本命令，能打印出版本号即说明可执行文件已就位。
```
codegpt version
```
5设置 API Key 环境变量

在 shell 中导出 OPENAI_API_KEY，CodeGPT 会自动读取该环境变量。
```
export OPENAI_API_KEY=sk-xxxxxxx
```
6或写入配置文件

也可用 config set 把密钥写进 $HOME/.config/codegpt/.codegpt.yaml，避免每次导出。
```
codegpt config set openai.api_key sk-xxxxxxx
```

关键配置

配置项	必填	说明	示例
`openai.api_key`	是	OpenAI 平台生成的 API Key	`sk-xxxxxxx`
`openai.model`	否	使用的模型，默认 gpt-4o，可换自定义模型	`gpt-4o`
`openai.base_url`	否	替换默认 base URL，便于走代理或兼容服务	`https://api.openai.com/v1`
`openai.provider`	否	服务提供方，默认 openai，可改为 azure 或 gemini	`openai`
`output.lang`	否	生成内容语言，默认 en，支持 zh-tw、zh-cn、ja	`zh-cn`
`openai.timeout`	否	HTTP 超时时间，默认 10s	`10s`

如何确认成功

执行 codegpt version，能正常输出版本号即表示安装成功；随后在 Git 仓库提交一次即可看到生成的提交信息。

常见问题

Q：安装脚本因 SSL 校验失败下载不了怎么办？

A：可用 INSECURE=1 ./install.sh 安装，忽略 curl 的 SSL 校验（README 明确支持该开关）。

Q：想装指定版本到自定义目录怎么做？

A：用环境变量覆盖，例如 VERSION=1.1.0 INSTALL_DIR=/opt/codegpt ./install.sh。

Q：不想每�次都导出环境变量怎么配密钥？

A：执行 codegpt config set openai.api_key sk-xxxxxxx，会写入 $HOME/.config/codegpt/.codegpt.yaml。

Q：如何更换模型或输出语言？

A：在配置中修改 openai.model（默认 gpt-4o）和 output.lang（默认 en，可设 zh-cn）。

Q：支持 Azure 或 Gemini 吗？

A：支持，将 openai.provider 设为 azure 或 gemini 即可切换服务提供方。

注意事项

安装脚本会自动检测操作系统与架构，下载对应二进制并加入 PATH
配置文件默认位于 $HOME/.config/codegpt/.codegpt.yaml，提示词目录默认 $HOME/.config/codegpt/prompt
API Key 属敏感信息，不要写进代码仓库或公开分享
可用 openai.proxy / openai.socks 配置代理，openai.skip_verify 控制是否忽略 SSL 校验

核心亮点

自动生成符合规范的 commit message，减少手动编写时间
集成代码审查功能，快速发现变更中的潜在问题
通过 Git 钩子实现无感集成，不改变现有工作流

不足之处

依赖 OpenAI API，需要网络和 API 密钥，可能产生费用
生成的提交信息质量受模型和 prompt 影响，有时需人工调整
文档/社区待观察

适用场景

个人开发者日常提交代码时快速生成规范提交信息
团队协作中统一 commit 风格，提升代码审查效率
CI/CD 流程中自动生成变更摘要，辅助发布说明

替代项目

commitizen、gitmoji-cli、Aider

项目介绍

CodeGPT 是编程开发领域的开源项目，由 appleboy 开发，2023 年首次发布。

在全站 13,014 个收录项目中，它的 GitHub 星标数（1,505）位列前 30%，在编程开发分类中处于中上游。

项目保持着较活跃的维护节奏，最近一次代码更新于 2026-09-05。MIT许可证，完全免费，需自行部署使用。

它主要面向的使用场景是：个人开发者日常提交代码时快速生成规范提交信息。同类可对比的替代方案包括 commitizen、gitmoji-cli、Aider。

上一篇：DevGPT

下一篇：nppopenai