CodeGPT

CodeGPT 项目介绍

代码生成与审查工具

CodeGPT 是一个以 Go 语言编写的命令行工具，能够借助 ChatGPT AI（如 gpt-3.5-turbo 和 gpt-4 模型）为您生成 Git 提交消息或代码审查摘要。它还可以自动安装一个 git prepare-commit-msg 钩子，以简化提交过程。

功能亮点

• 支持多种 AI 服务：包括 Azure OpenAI 服务、OpenAI API、Gemini、Ollama、Groq 和 OpenRouter。
• 遵循规范：支持常规提交规范，确保提交信息清晰简洁。
• 灵活的配置：您可以自定义生成差异的上下文行数（默认为三行），也可排除特定文件。
• 多语言支持：支持提交信息翻译，包括英语、繁体中文和简体中文。
• 网络代理支持：可以使用 socks 代理或自定义 HTTP 代理。
• 模型多样性：支持多种 AI 模型，如 gpt-4 和 gpt-3.5-turbo。
• 代码审查功能：能够为代码变更生成简要的审查信息。

安装方法

MacOS 系统

通过 Homebrew 安装：

brew tap appleboy/tap
brew install codegpt

Windows 系统

使用 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 设置为环境变量：

export OPENAI_API_KEY=sk-xxxxxxx

或者将 API Key 存储在自定义配置文件中：

codegpt config set openai.api_key sk-xxxxxxx

这会在您的主目录中生成 .codegpt.yaml 文件。文件中提供了丰富的自定义选项，例如 openai.base_url、openai.model、git.diff_unified 等。

使用方法

CodeGPT 提供了两种生成提交消息的方法：CLI 模式和 Git 钩子。

CLI 模式

直接调用 codegpt 生成提交消息：

git add <files...>
codegpt commit --preview

也可以将所有提交消息翻译为不同语言：

codegpt commit --lang zh-tw --preview

Git 钩子

通过安装钩子将 CodeGPT 集成至 Git：

安装钩子：

codegpt hook install

卸载钩子：

codegpt hook uninstall

在安装后，按通常方式阶段文件并提交：

git add <files...>
git commit

CodeGPT 将为您生成提交消息并返回给 Git，您可以在编辑器中查看并编辑。

代码审查

使用 CodeGPT 为您的变更生成代码审查信息：

codegpt review

可翻译代码审查信息为其他语言：

codegpt review --lang zh-tw

测试

运行以下命令进行代码测试：

make test

参考资料

• OpenAI Chat completions documentation
• Introducing ChatGPT and Whisper APIs

以上是 CodeGPT 项目的详细介绍，旨在帮助开发者更便捷地编写且规范化提交信息，并有效进行代码审查。