AIM：用 AI 写 Git 提交信息

前言

每次提交代码都要想半天写什么？赶项目的时候随手写个"update"、"fix bug"就提交了？回头看提交历史，满屏都是"修改文件"这种废话？

AIM（AI-powered Git Intelligence Message） 就是为了解决这个问题而生的。它是个命令行工具，直接分析你的代码改动，自动生成规范的提交信息。

安装

 dotnet tool install --global huiyuanai709.aim

主要功能

???? AI 分析代码改动

接入了 OpenAI API（也支持其他兼容接口），会：

• 看你的 git diff 改了啥
• 理解这次改动是干什么的
• 生成符合规范的提交信息

⚡ 跑得快

• 用 .NET 10.0 写的，支持 AOT 编译
• 启动快，占内存少
• 命令行用起来简单

???? 符合规范

生成的提交信息会遵循常见的最佳实践：

• 用祈使语气："Add feature" 不是 "Added feature"
• 标题不超过 72 字符
• 标题和正文之间空一行

⚙️ 可以定制

能改的地方挺多：

• API 地址和模型（GPT-4、GPT-4o 等）
• 提交信息长度
• 要不要自动提交
• diff 显示方式

快速上手指南

安装步骤

# 1. 克隆仓库
git clone https://github.com/huiyuanai709/Aim.git
cd Aim

# 2. 构建项目
dotnet build

# 3. （可选）发布为原生二进制文件
dotnet publish -c Release

配置 API 密钥

先准备一个 OpenAI API key：

aim config --set apikey=YOUR_API_KEY

用其他兼容 OpenAI 接口的服务（比如 Azure OpenAI、国内的 AI 服务）也行，改一下地址：

aim config --set apiendpoint=https://your-custom-endpoint.com/v1

怎么用

# 1. 改完代码，暂存
git add .

# 2. 生成提交信息
aim commit

# 3. 看一眼没问题就提交

就这样。AIM 分析完代码会给你一条提交信息，看着没问题就确认。

更多用法

一步到位：

aim commit -a

改上次的提交：

aim commit --amend

自动提交不用确认：

aim config --set autocommit=true

实际效果

比如你这次改动：

• 给登录加了邮箱验证
• 修了密码重置页面的显示问题
• 更新了单元测试

自己写可能是：

fix: 修复登录相关问题

用 AIM 生成的：

Add email validation to user login module

- Implement email format validation on login form
- Fix password reset page display issue
- Update related unit tests for new validation logic

技术细节

.NET 10.0 + AOT 编译

用了最新的 .NET 平台，支持 AOT 编译：

• 启动快：不用 JIT 编译
• 占内存少：不需要完整的运行时
• 跨平台：Windows、Linux、macOS 都能用

依赖库

• OpenAI SDK (v2.7.0)：官方 SDK
• System.CommandLine (v2.0.0)：微软官方的命令行库
• Microsoft.Extensions.Configuration：配置管理

代码结构

设计比较简单：

• 配置文件用标准 INI 格式
• 命令行接口规范
• 模块化，好改

配置说明

配置文件在：

• Windows：%APPDATA%\aim\config.ini
• Linux/Mac：~/.config/aim/config.ini

示例：

[General]
ApiKey = sk-your-api-key-here
ApiEndpoint = https://api.openai.com/v1
Model = gpt-4o

[Behavior]
AutoCommit = false
AutoPush = false

[Rules]
MaxSubjectLength = 72
DiffNameOnly = false

常用配置

适合什么场景

用起来不错的场景

1. 个人项目：快速生成规范的提交
2. 小团队：统一提交风格
3. 开源项目：让提交历史看起来更专业

要注意的地方

1. 敏感代码：AI 要读你的代码，注意公司规定
2. 没网络：要联网调 API
3. 大改动：改了特别多文件，可能要自己润色一下

开源参与

这是个开源项目，欢迎参与：

• ???? 报 bug
• ???? 提建议
• ???? 写文档
• ???? 提代码

GitHub：https://github.com/huiyuanai709/Aim

最后

写代码已经够累了，提交信息这种事交给工具就行。AIM 不是要替你思考，而是帮你把时间花在更值得做的事上。

项目作者：huiyuanai709
觉得有用的话，给个 Star ⭐