# ai-git-helper

**Repository Path**: zb_com/ai-git-helper

## Basic Information

- **Project Name**: ai-git-helper
- **Description**: AI Git Helper - 智能Git助手
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-22
- **Last Updated**: 2026-07-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI Git Helper

AI 驱动的智能代码提交工具（可视化桌面应用）。支持 Git/SVN，集成 GitHub/Gitee，AI 自动生成提交信息。

## 功能特性

- 🤖 **AI 生成 Commit Message** - 可视化选择文件，一键让 AI 分析变更生成提交信息
- 🏗️ **AI 创建远程仓库** - AI 建议仓库名称，一键创建 GitHub/Gitee 仓库并推送
- 🔀 **AI 冲突解决** - 自动分析合并冲突并给出解决方案
- 📜 **提交历史管理** - 查看、重置、还原、修改作者等多种历史操作
- 📦 **多平台支持** - Git、SVN、GitHub、Gitee
- 🖥️ **图形界面** - 无需记命令，所有操作可视化完成

## 使用方式

### 方式一：直接运行 exe（推荐）

双击 `dist/AI-Git-Helper.exe` 即可启动，无需安装 Python。

### 方式二：从源码运行

```bash
pip install -e .
python run.py
```

### 打包为 exe

```bash
pip install pyinstaller
python build.py
```

生成的 `AI-Git-Helper.exe` 在 `dist/` 目录下，可以复制到任意位置运行。

## 使用流程

1. **启动应用** → 进入「设置」页面配置 AI API Key 和平台 Token
2. **智能提交** → 选择仓库路径，查看变更文件，点击「AI 生成」自动生成 commit message，勾选需要提交的文件，点击「提交」
3. **仓库管理** → 需要创建远程仓库时，进入「仓库管理」页面操作
4. **历史记录** → 进入「历史记录」页面查看提交历史，支持重置、还原、修改作者等操作

## 配置

配置文件位于 `~/.ai-git-helper/config.yaml`，也可以在应用内「设置」页面可视化配置。

### AI 配置

本工具支持任何兼容 OpenAI API 格式的大模型服务：

| 配置项 | 说明 | 示例 |
|--------|------|------|
| API Key | 模型服务的密钥 | `sk-xxx` |
| Base URL | API 接口地址 | `https://api.openai.com/v1` |
| 模型 | 使用的模型名称 | `gpt-4o`、`deepseek-chat` |
| 语言 | 生成 commit message 的语言 | `zh`（中文）/ `en`（英文） |

**常见 AI 服务配置示例：**

| 服务商 | Base URL | 模型 |
|--------|----------|------|
| OpenAI | `https://api.openai.com/v1` | `gpt-4o` |
| DeepSeek | `https://api.deepseek.com/v1` | `deepseek-chat` |
| MiniMax | `https://api.minimaxi.com/v1` | `MiniMax-M2.7` |

也支持通过环境变量 `OPENAI_API_KEY` 设置 API Key。

### 平台 Token 配置

| 平台 | 获取方式 |
|------|----------|
| GitHub | [Settings → Developer settings → Personal access tokens](https://github.com/settings/tokens)，需要 `repo` 权限 |
| Gitee | [设置 → 私人令牌](https://gitee.com/profile/personal_access_tokens)，需要 `projects` 权限 |

## 核心模块

- `src/ai_engine.py` - AI 引擎，处理 commit message 生成、仓库命名建议、冲突分析
- `src/vcs/git_handler.py` - Git 操作封装
- `src/vcs/svn_handler.py` - SVN 操作封装
- `src/platforms/github.py` / `src/platforms/gitee.py` - 远程仓库 API 调用
- `src/config.py` - 配置管理
- `src/gui/` - 图形界面模块

## 许可证

MIT License