GitAICommits

AI-Powered Git Commit Message Generator

语言 / Language: 中文 English

📖 简介 [中文]

GitAICommit 是一个智能的Git提交信息生成工具，利用AI模型自动分析代码变更内容，生成符合规范的提交信息。支持多种AI模型，包括OpenAI、DeepSeek和阿里云通义千问。同时提供代码问题自动识别功能，帮助开发者发现潜在的代码问题。

✨ 特性 [中文]

• 支持多种AI模型：OpenAI GPT、DeepSeek、阿里云通义千问
• 自动分析Git变更内容
• 生成符合规范的提交信息
• 支持命令行配置和使用
• 支持中英文输出
• 可选择自动执行git commit
• 代码问题自动识别：分析代码变更中的潜在问题
• 提交时集成问题检查：可选择在生成提交信息时同时分析代码问题
• 支持指定文件分析和提交：可精确控制要分析和提交的文件范围

🚀 安装与更新 [中文]

安装

# 全局安装
npm install -g gitaicommits

# 或在项目中安装
npm install --save-dev gitaicommits

更新

# 更新全局安装的工具
npm update -g gitaicommits

# 更新项目中的工具
npm update gitaicommits --save-dev

⚙️ 配置 [中文]

首次使用前，需要配置API密钥和模型设置：

# 设置API密钥（以OpenAI为例）
gitaicommits config --api-key sk-your-api-key

# 设置模型类型
gitaicommits config --model openai

# 设置模型名称
gitaicommits config --model-name gpt-3.5-turbo

# 设置语言（中文/英文）
gitaicommits config --language zh

# 查看当前配置
gitaicommits config --show

支持的配置项 [中文]

📝 使用方法 [中文]

一、全量操作（默认所有文件）

1. 生成提交信息（不自动提交）

在有未提交更改的Git仓库中运行：

# 简单方式
gitaicommits

# 或使用命令
gitaicommits generate
# 简写
gitaicommits g

工具会自动分析所有更改并生成提交信息，显示在终端中，然后需要手动复制使用。

2. 生成并自动提交

# 使用commit命令
gitaicommits commit
# 简写
gitaicommits c

# 或使用generate命令加参数
gitaicommits generate --commit
gitaicommits g -c

3. 代码问题检查

# 检查所有代码问题
gitaicommits check
# 简写
gitaicommits i

4. 生成提交信息并检查代码问题

# 生成提交信息并检查代码问题
gitaicommits generate --check-issues
gitaicommits g -i

# 生成并提交，同时检查代码问题
gitaicommits commit --check-issues
gitaicommits c -i

二、指定文件操作

1. 生成指定文件的提交信息

# 只基于特定文件生成提交信息
gitaicommits generate src/utils.ts
gitaicommits g src/utils.ts

# 生成多个文件的提交信息
gitaicommits generate src/index.ts src/git.ts

2. 提交指定文件的更改

# 只分析和提交特定文件
gitaicommits commit src/index.ts
gitaicommits c src/index.ts

# 提交多个文件的更改
gitaicommits commit src/index.ts src/git.ts

3. 检查指定文件的代码问题

# 只分析特定文件的问题
gitaicommits check src/cli.ts
gitaicommits i src/cli.ts

# 分析多个文件的问题
gitaicommits check src/index.ts src/models/

4. 生成提交信息并检查指定文件的代码问题

# 生成并检查特定文件
gitaicommits generate --check-issues src/index.ts
gitaicommits g -i src/index.ts

# 生成、提交并检查特定文件
gitaicommits commit --check-issues src/models/index.ts
gitaicommits c -i src/models/index.ts

三、配置与使用示例

# 配置OpenAI模型
gitaicommits config --api-key sk-123456 --model openai --model-name gpt-4

# 配置deepseek模型
gitaicommits config --api-key sk-123456 --model deepseek --model-name deepseek-chat

# 查看当前配置
gitaicommits config --show

# 更新到最新版本
npm update -g gitaicommits

# 常见操作示例
# 1. 全量生成并提交
gitaicommits c

# 2. 只分析和提交src目录中的TypeScript文件
gitaicommits c src/**/*.ts

# 3. 检查特定文件的代码问题
gitaicommits i src/cli.ts

🛠️ 模型支持 [中文]

OpenAI

• 支持模型：gpt-3.5-turbo, gpt-4 等
• API端点：https://api.openai.com/v1/chat/completions

DeepSeek

• 支持模型：deepseek-chat 等
• API端点：https://api.deepseek.com/chat/completions

阿里云通义千问

• 支持模型：qwen-turbo 等
• API端点：https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation

🔒 安全说明 [中文]

• API密钥会保存在用户主目录下的 .gitaicommit/config.json 文件中
• 请确保不要将包含API密钥的配置文件提交到代码仓库

🤝 贡献 [中文]

欢迎提交Issue和Pull Request！

📋 开发计划 (TODO) [中文]

近期计划

• 代码问题自动识别：分析提交的代码变更，自动识别潜在的bug、安全漏洞和性能问题 ✅
• 提交时集成问题检查：在生成提交信息时可选择同时分析代码问题 ✅
• 支持指定文件分析和提交：可精确控制要分析和提交的文件范围 ✅
• 改进代码问题识别算法：提高代码问题检测的准确性和覆盖面
• 支持更多编程语言：扩展对各种编程语言的问题识别支持
• 提供问题修复建议：不仅识别问题，还提供相应的修复建议

未来功能

• 集成单元测试覆盖率分析
• 支持团队协作和代码审查功能
• 添加用户自定义规则支持
• 提供代码质量趋势分析报告

📄 许可证 [中文]

MIT

📖 Introduction [English]

GitAICommit is an intelligent Git commit message generator that automatically analyzes code changes and generates standardized commit messages using AI models. It supports multiple AI models, including OpenAI, DeepSeek, and Alibaba Tongyi Qianwen. Additionally, it provides automatic code issue identification to help developers discover potential problems in their code.

✨ Features [English]

• Support for multiple AI models: OpenAI GPT, DeepSeek, Alibaba Tongyi Qianwen
• Automatic analysis of Git change contents
• Generation of standardized commit messages
• Command-line configuration and usage
• Support for Chinese and English output
• Optional automatic git commit execution
• Automatic code issue identification: Analyze potential issues in code changes
• Integrated issue checking during commit: Option to analyze code issues while generating commit messages

🚀 Installation and Update [English]

Installation

# Global installation
npm install -g gitaicommits

# Or install in project
npm install --save-dev gitaicommits

Update

# Update globally installed tool
npm update -g gitaicommits

# Update project tool
npm update gitaicommits --save-dev

⚙️ Configuration [English]

Before first use, you need to configure the API key and model settings:

# Set API key (example for OpenAI)
gitaicommits config --api-key sk-your-api-key

# Set model type
gitaicommits config --model openai

# Set model name
gitaicommits config --model-name gpt-3.5-turbo

# Set language (Chinese/English)
gitaicommits config --language en

# View current configuration
gitaicommits config --show

Supported Configuration Options [English]

✨ Features [English]

• Support for multiple AI models: OpenAI GPT, DeepSeek, Alibaba Tongyi Qianwen
• Automatic analysis of Git change content
• Generate standardized commit messages
• Command-line configuration and usage
• Support for Chinese and English output
• Optional automatic git commit execution
• Automatic code issue identification: Analyze potential issues in code changes
• Integrated issue checking during commit: Option to analyze code issues while generating commit messages
• Support for analyzing and committing specific files: Precisely control the file range for analysis and commit

📝 Usage [English]

I. Full Repository Operations (Default - All Files)

1. Generate commit message (without auto commit)

Run in a Git repository with uncommitted changes:

# Simple way
gitaicommits

# Or use command
gitaicommits generate
# Shorthand
gitaicommits g

The tool will automatically analyze all changes and generate a commit message, displaying it in the terminal for manual copying.

2. Generate and automatically commit

# Use commit command
gitaicommits commit
# Shorthand
gitaicommits c

# Or use generate command with parameter
gitaicommits generate --commit
gitaicommits g -c

3. Check code issues

# Check all code issues
gitaicommits check
# Shorthand
gitaicommits i

4. Generate commit message and check code issues

# Generate commit message and check code issues
gitaicommits generate --check-issues
gitaicommits g -i

# Generate, commit, and check code issues
gitaicommits commit --check-issues
gitaicommits c -i

II. Specific File Operations

1. Generate commit message for specific files

# Generate commit message based only on specific file
gitaicommits generate src/utils.ts
gitaicommits g src/utils.ts

# Generate commit message for multiple files
gitaicommits generate src/index.ts src/git.ts

2. Commit changes in specific files

# Only analyze and commit specific file
gitaicommits commit src/index.ts
gitaicommits c src/index.ts

# Commit changes in multiple files
gitaicommits commit src/index.ts src/git.ts

3. Check code issues in specific files

# Only analyze issues in specific file
gitaicommits check src/cli.ts
gitaicommits i src/cli.ts

# Analyze issues in multiple files
gitaicommits check src/index.ts src/models/

4. Generate commit message and check code issues for specific files

# Generate and check specific file
gitaicommits generate --check-issues src/index.ts
gitaicommits g -i src/index.ts

# Generate, commit, and check specific file
gitaicommits commit --check-issues src/models/index.ts
gitaicommits c -i src/models/index.ts

III. Configuration and Usage Examples

# Configure OpenAI model
gitaicommits config --api-key sk-123456 --model openai --model-name gpt-4

# Configure DeepSeek model
gitaicommits config --api-key sk-123456 --model deepseek --model-name deepseek-chat

# View current configuration
gitaicommits config --show

# Update to latest version
npm update -g gitaicommits

# Common operation examples
# 1. Generate and commit all changes
gitaicommits c

# 2. Only analyze and commit TypeScript files in src directory
gitaicommits c src/**/*.ts

# 3. Check code issues in specific file
gitaicommits i src/cli.ts

🛠️ Model Support [English]

OpenAI

• Supported models: gpt-3.5-turbo, gpt-4, etc.
• API endpoint: https://api.openai.com/v1/chat/completions

DeepSeek

• Supported models: deepseek-coder, etc.
• API endpoint: https://api.deepseek.com/chat/completions

Alibaba Tongyi Qianwen

• Supported models: qwen-turbo, etc.
• API endpoint: https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation

🔒 Security Notes [English]

• API keys are stored in .gitaicommit/config.json in the user's home directory
• Please ensure not to commit configuration files containing API keys to code repositories

🤝 Contributions [English]

Pull requests and issues are welcome!

📋 Development Plan (TODO) [English]

Near-term Plans

• Automatic code issue identification: Analyze code changes to identify potential bugs, security vulnerabilities, and performance issues ✅
• Integrated issue checking during commit: Option to analyze code issues while generating commit messages ✅
• Improve code issue identification algorithms: Increase accuracy and coverage of code problem detection
• Support more programming languages: Expand issue identification support for various programming languages
• Provide issue fixing suggestions: Not only identify issues but also provide corresponding fixing suggestions

Future Features

• Integration with unit test coverage analysis
• Support for team collaboration and code review features
• Add support for user-defined rules
• Provide code quality trend analysis reports

📄 License [English]

MIT