@mehmetsagir/git-ai 0.0.2 → 0.0.3
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 +30 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,23 +12,24 @@ AI-powered git commit tool. Analyzes git diffs, groups them logically, and creat
|
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
14
14
|
|
|
15
|
-
### Global Installation
|
|
15
|
+
### Global Installation
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
|
|
18
|
+
npm install -g @mehmetsagir/git-ai
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
After installation, you can use `git-ai` command directly:
|
|
22
22
|
|
|
23
23
|
```bash
|
|
24
|
-
|
|
24
|
+
git-ai setup
|
|
25
|
+
git-ai commit
|
|
25
26
|
```
|
|
26
27
|
|
|
27
|
-
|
|
28
|
+
### Using with npx (no installation required)
|
|
28
29
|
|
|
29
30
|
```bash
|
|
30
|
-
|
|
31
|
-
|
|
31
|
+
npx @mehmetsagir/git-ai setup
|
|
32
|
+
npx @mehmetsagir/git-ai commit
|
|
32
33
|
```
|
|
33
34
|
|
|
34
35
|
## Initial Setup
|
|
@@ -36,7 +37,11 @@ npm link
|
|
|
36
37
|
Run the setup command on first use:
|
|
37
38
|
|
|
38
39
|
```bash
|
|
40
|
+
# If installed globally
|
|
39
41
|
git-ai setup
|
|
42
|
+
|
|
43
|
+
# Or with npx
|
|
44
|
+
npx @mehmetsagir/git-ai setup
|
|
40
45
|
```
|
|
41
46
|
|
|
42
47
|
This command:
|
|
@@ -53,7 +58,11 @@ This command:
|
|
|
53
58
|
**With default user:**
|
|
54
59
|
|
|
55
60
|
```bash
|
|
61
|
+
# If installed globally
|
|
56
62
|
git-ai commit
|
|
63
|
+
|
|
64
|
+
# Or with npx
|
|
65
|
+
npx @mehmetsagir/git-ai commit
|
|
57
66
|
```
|
|
58
67
|
|
|
59
68
|
**With a different user:**
|
|
@@ -208,10 +217,14 @@ git-ai users
|
|
|
208
217
|
|
|
209
218
|
## Commands
|
|
210
219
|
|
|
220
|
+
All commands can be used with `git-ai` (if installed globally) or `npx @mehmetsagir/git-ai`:
|
|
221
|
+
|
|
211
222
|
### Setup
|
|
212
223
|
|
|
213
224
|
```bash
|
|
214
225
|
git-ai setup
|
|
226
|
+
# or
|
|
227
|
+
npx @mehmetsagir/git-ai setup
|
|
215
228
|
```
|
|
216
229
|
|
|
217
230
|
Initial setup - OpenAI API key and git user configuration.
|
|
@@ -220,6 +233,8 @@ Initial setup - OpenAI API key and git user configuration.
|
|
|
220
233
|
|
|
221
234
|
```bash
|
|
222
235
|
git-ai commit [--user <user>]
|
|
236
|
+
# or
|
|
237
|
+
npx @mehmetsagir/git-ai commit [--user <user>]
|
|
223
238
|
```
|
|
224
239
|
|
|
225
240
|
Analyze git diffs and create commits. Use `--user` or `-u` to specify a different git user.
|
|
@@ -267,7 +282,11 @@ Reset all configuration (deletes OpenAI key and all git users).
|
|
|
267
282
|
1. **Run setup:**
|
|
268
283
|
|
|
269
284
|
```bash
|
|
285
|
+
# If installed globally
|
|
270
286
|
git-ai setup
|
|
287
|
+
|
|
288
|
+
# Or with npx
|
|
289
|
+
npx @mehmetsagir/git-ai setup
|
|
271
290
|
```
|
|
272
291
|
|
|
273
292
|
- 3 user profiles detected
|
|
@@ -337,7 +356,11 @@ Configuration file: `~/.git-ai/config.json`
|
|
|
337
356
|
### "OpenAI API key not found" error
|
|
338
357
|
|
|
339
358
|
```bash
|
|
359
|
+
# If installed globally
|
|
340
360
|
git-ai setup
|
|
361
|
+
|
|
362
|
+
# Or with npx
|
|
363
|
+
npx @mehmetsagir/git-ai setup
|
|
341
364
|
```
|
|
342
365
|
|
|
343
366
|
### "This directory is not a git repository" error
|