# git-commit-agent

**Repository Path**: pinxue/git-commit-agent

## Basic Information

- **Project Name**: git-commit-agent
- **Description**: An agent that automatically generates Git commit information and updates the change log | 一个用来自动产生 Git commit 信息并更新 change log 的代理


- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-27
- **Last Updated**: 2025-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

> [!NOTE]  
> 自有自用项目。不是面向客户，只为了减少自己在 commit 上的时间。


1. 用户输入:

```bash
git add .
git commit -m "feat:/fix:/ ABCD一二三四1234"
git push
```

2. 简化为：

```bash
git-commit .
```


# 安装
目前的想法是使用 `Pip Cli`进行安装、运行，但是考虑到多种项目，所以后面考虑使用 Rust 重构，编译成多平台可执行文件。

```bash
pip install git-commit-agent
```

# 使用
## 初始化
需要设置你的LLM环境变量，可以是直接 export 相应的变量；也可以在 .env 文件中编写变量。

```bash
OPENAI_API_KEY="sk-xxx"
OPENAI_ENDPOINT="https://api.openai.com/v1"
USE_MODEL="deepseek-r1"
```

## 执行
传给 `git-commit`的变量全部传给了 `git add`命令：

```bash
git-commit .
```