git-repo-comitter 0.5.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -33
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,27 +8,29 @@
|
|
|
8
8
|
## 特性
|
|
9
9
|
|
|
10
10
|
- **自动差异收集** — 自动检测暂存/未暂存的变更，合并为完整 diff 提交给 LLM
|
|
11
|
-
- **模型无关** — 兼容任何 OpenAI 兼容 API（OpenAI、DeepSeek、通义千问等）
|
|
12
11
|
- **一站式配置** — 交互式初始化向导，配置持久化到 `~/.grc/config.json`
|
|
13
|
-
- **多层配置覆盖** — 环境变量 `.env`、用户配置、系统环境变量三层覆盖
|
|
14
|
-
- **零操作提交** — 无暂存变更时自动 `git add -A`
|
|
15
12
|
- **中文提交信息** — 内置 Conventional Commits 中文 prompt，生成中文描述
|
|
16
13
|
|
|
17
|
-
##
|
|
14
|
+
## 使用示例
|
|
15
|
+
```text
|
|
16
|
+
D:\path\to\repo> grc
|
|
17
|
+
暂存所有变更...
|
|
18
|
+
正在生成提交信息...
|
|
18
19
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
```
|
|
20
|
+
提交信息：
|
|
21
|
+
docs(readme): 更新 README 文档结构和配置优先级说明
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
- 移除“模型无关”特性描述
|
|
24
|
+
- 简化配置优先级为两层：用户配置和系统环境变量
|
|
25
|
+
- 调整环境变量表格格式，默认端点改为 localhost
|
|
26
|
+
- 将“快速开始”章节提前，移除“技术栈”和“许可”章节
|
|
24
27
|
|
|
25
|
-
|
|
26
|
-
pnpm build && node dist/index.cjs
|
|
27
|
-
```
|
|
28
|
+
提交成功！
|
|
28
29
|
|
|
29
|
-
|
|
30
|
+
D:\path\to\repo>
|
|
31
|
+
```
|
|
30
32
|
|
|
31
|
-
|
|
33
|
+
## 快速开始
|
|
32
34
|
|
|
33
35
|
```bash
|
|
34
36
|
# 交互式配置
|
|
@@ -38,19 +40,32 @@ npx grc init
|
|
|
38
40
|
npx grc
|
|
39
41
|
```
|
|
40
42
|
|
|
43
|
+
## 安装
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npx grc --version
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
本地开发：
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
pnpm build && node dist/index.cjs
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## 使用
|
|
56
|
+
|
|
41
57
|
### 配置优先级
|
|
42
58
|
|
|
43
|
-
1.
|
|
44
|
-
2.
|
|
45
|
-
3. 系统环境变量
|
|
59
|
+
1. 用户配置文件 `~/.grc/config.json`
|
|
60
|
+
2. 系统环境变量
|
|
46
61
|
|
|
47
62
|
### 环境变量
|
|
48
63
|
|
|
49
|
-
| 变量
|
|
50
|
-
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
64
|
+
| 变量 | 说明 | 默认值 |
|
|
65
|
+
|----------------|----------|----------------------------|
|
|
66
|
+
| `LLM_ENDPOINT` | API 端点 | `https://localhost/api/v1` |
|
|
67
|
+
| `LLM_MODEL` | 模型名称 | `deepseek-v4-flash` |
|
|
68
|
+
| `LLM_API_KEY` | API 密钥 | |
|
|
54
69
|
|
|
55
70
|
### 交互式初始化
|
|
56
71
|
|
|
@@ -63,15 +78,3 @@ grc init
|
|
|
63
78
|
## 提交信息风格
|
|
64
79
|
|
|
65
80
|
遵循 Conventional Commits 规范，中文描述。支持 `feat`、`fix`、`refactor`、`docs` 等类型，scope 可选，正文支持分条陈述。
|
|
66
|
-
|
|
67
|
-
## 技术栈
|
|
68
|
-
|
|
69
|
-
- **运行时** — Node.js (TypeScript + Vite，产物为 CommonJS)
|
|
70
|
-
- **CLI 框架** — commander
|
|
71
|
-
- **LLM SDK** — OpenAI SDK
|
|
72
|
-
- **配置** — YAML + dotenv
|
|
73
|
-
- **工程化** — Husky + lint-staged + ESLint + Prettier
|
|
74
|
-
|
|
75
|
-
## 许可
|
|
76
|
-
|
|
77
|
-
[Unlicense](LICENSE) — 公有领域贡献。
|