AI Commits

AI Commits是一款开源命令行工具，利用AI自动分析代码差异并生成规范的Git提交信息，帮助开发者告别手写commit message的烦恼。 一、快速开始 1. 安装工具：确保已安装Node.js环境，在终端执行npm install -g ai-commits完成全局安装。 2. 配置API密钥：执行aicommits config set API_KEY=你的OpenAI密钥，将密钥保存到本地配置文件中。 3. 验证安装：在任意Git仓库中修改并暂存文件后，执行aicommits命令，工具会自动生成提交信息。 二、核心功能演示 功能1：自动生成提交信息 完成代码修改后，先用git add将文件加入暂存区，然后直接运行aicommits命令。工具会读取暂存区的代码差异，调用AI分析变更内容，自动生成一条符合约定式提交规范的提交信息。你可以直接使用或按y确认提交。 功能2：多方案选择 运行aicommits --generate 3命令，工具会一次性生成3条不同的提交信息供你选择。每条信息会从不同角度描述代码变更，你可以挑选最准确的一条使用。这在变更内容复杂时特别有用，能帮你找到最精准的描述。 功能3：自定义模型和语言 在配置文件中可以指定使用的AI模型，例如设置MODEL=gpt-4来使用更强大的模型。还支持设置LANG=chinese让生成的提交信息使用中文，满足不同团队的语言偏好和项目规范要求。 三、实际使用案例 案例1：日常开发提效 全栈开发者小刘每天要提交十几次代码。以前每次都要花一两分钟构思提交信息，现在用AI Commits，只需执行一条命令就能得到规范的提交信息，每天节省近20分钟，而且提交记录的质量和规范性明显提升。 案例2：开源项目贡献 小张在参与开源项目时，需要遵循严格的Conventional Commits规范。AI Commits能自动识别变更类型（feat、fix、refactor等）并生成符合项目规范的提交信息，帮助他顺利通过代码审查，提高了贡献效率。 四、常见问题 Q1：AI Commits需要联网吗？ A：是的，工具需要调用AI模型的API接口，因此需要网络连接。代码差异会在本地读取后发送到API进行分析，不会上传整个代码库。 Q2：支持哪些AI模型？ A：支持OpenAI的GPT系列模型，也兼容其他提供OpenAI格式API的服务。可以在配置文件中自由切换模型。 Q3：提交信息安全吗？ A：工具只将暂存区的代码差异（diff）发送给AI模型，不会传输完整源代码。如果涉及敏感信息，建议先检查暂存内容再执行命令。 五、小贴士 1. 在.gitignore中添加配置文件路径，避免误将API密钥提交到代码仓库中。 2. 对于大型变更，建议拆分为多次小提交后再使用AI Commits，这样生成的提交信息会更精准、更有意义。