AI Commits：再也不用自己写 Git 提交信息！

程序员的日常开发工作中，提交代码（commit）是不可或缺的一部分。而每次提交代码时，撰写简洁明了的提交信息也是一项必需但不太受欢迎的任务。

随着项目越来越复杂，提交信息的重要性愈加凸显：好的提交信息不仅能帮助团队理解变更内容，还能为日后的项目维护、代码回溯提供重要线索。

不过，作为一名开发者，写代码本身已经耗费了大量的精力，而为每次提交写“完美”的提交信息，更是让人头疼。于是，这时候你可能会想：如果有个工具能帮我自动生成这些提交信息，那就再好不过了！

AI Commits 就是为了解决这个问题而诞生的！它是一个 CLI 工具，能够利用 AI 自动生成适合的 Git 提交信息，彻底解放你的双手。

项目介绍

AI Commits 是一个开源的 CLI 工具，它通过 AI 来帮助你编写 Git 提交信息。

具体来说，AI Commits 会抓取你最新的代码更改，发送到 OpenAI 的 GPT-3 模型，然后由 AI 自动生成提交信息并返回给你。不管你的更改是简单的 bug 修复，还是大规模的功能更新，AI 都能根据代码变动的内容给出合适的提交信息。

工作原理

这个工具的工作流程其实很简单，但背后借助了强大的 AI 能力：

1. 抓取代码更改：AI Commits 运行 git diff 命令，自动抓取你所有最新的代码更改。

2. 传输到 OpenAI GPT-3：抓取的代码变更会被发送到 OpenAI 的 GPT-3 模型。

3. AI 生成提交信息：根据代码变动，GPT-3 生成简洁、准确的提交信息。

4. 返回提交信息：AI Commits 将生成的提交信息返回给你，让你只需简单确认或稍作修改，即可直接提交。

通过这个自动化过程，程序员们再也不用花时间绞尽脑汁去思考如何编写提交信息，效率大大提高。

主要功能

• 自动生成提交信息：利用 AI 生成简洁、准确的 Git 提交信息，节省你的时间和精力。

• 适应性强：无论你的项目是小型个人项目，还是复杂的大型企业项目，AI Commits 都能应对不同的代码变更，给出合适的提交信息。

• 简单易用的 CLI：无需复杂的配置，只需几个简单的命令行操作，即可生成提交信息。

使用场景

1. 效率提升：程序员的时间宝贵，而撰写详细准确的提交信息往往是个耗时的过程。AI Commits 能够自动化这一过程，减少人为出错的可能性，并节省大量时间。

2. 提升团队协作：特别是在团队开发中，提交信息的质量直接影响到代码审查和项目管理。AI 生成的提交信息能够保持一定的规范性和一致性，提升团队成员之间的沟通效率。

3. 代码审查：当你在进行代码审查时，准确、简洁的提交信息能帮助代码审查人员更好地理解每次变更的目的。而 AI Commits 的生成结果往往能够保持较高的可读性，帮助快速定位问题或改进点。

4. 适合懒人和高压环境：有时候，开发者可能会因为时间紧迫而忽略提交信息的质量，甚至用一些“update”之类的模糊提交信息来应付。这会给未来的维护工作带来不必要的麻烦。AI Commits 在这类情况下能够起到“救命稻草”的作用，让你在高压下也能保持良好的提交记录。

使用方法

1. 安装

你可以通过 npm 来安装 AI Commits：

npm install -g aicommits

2. 获取 OpenAI API 密钥

由于 AI Commits 使用的是 OpenAI 的 GPT-3 模型，你需要拥有一个 OpenAI API 密钥。你可以在 OpenAI 官方网站上注册并获取。

3. 配置 API 密钥

安装完成后，你需要将 OpenAI 的 API 密钥配置到 AI Commits 工具中：

export OPENAI_API_KEY=你的API密钥

4. 使用 AI Commits

在你的 Git 仓库中，运行以下命令即可生成提交信息：

aicommits # or aicommits --all

AI Commits 会自动运行 git diff 并生成提交信息，你可以选择接受或修改生成的内容。

结语

撰写 Git 提交信息一直以来都是程序员的“烦恼”之一。虽然它看似微不足道，但好的提交信息却能极大地提升代码的可维护性和项目管理的便利性。

AI Commits 的出现，让这一过程变得轻松愉快，自动生成的提交信息不仅省时省力，还能保持专业性和准确性。

开源地址：https://github.com/Nutlope/aicommits