@vibelint/vibelint-commit 0.1.19 → 0.1.20
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 +20 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @vibelint/vibelint-commit
|
|
2
2
|
|
|
3
|
-
AI-powered commit message generator using Ollama.
|
|
3
|
+
AI-powered commit message generator using Ollama, because writing good commit messages is apparently too hard.
|
|
4
|
+
|
|
5
|
+
This tool looks at your staged changes and generates a commit message for you. Because "fix stuff" and "update things" aren't exactly professional, are they?
|
|
4
6
|
|
|
5
7
|
## Install
|
|
6
8
|
|
|
@@ -8,6 +10,8 @@ AI-powered commit message generator using Ollama.
|
|
|
8
10
|
npm install -D @vibelint/vibelint-commit
|
|
9
11
|
```
|
|
10
12
|
|
|
13
|
+
Or use `lintmyvibe` if you want someone to hold your hand through the setup.
|
|
14
|
+
|
|
11
15
|
## Usage
|
|
12
16
|
|
|
13
17
|
```json
|
|
@@ -22,15 +26,23 @@ npm install -D @vibelint/vibelint-commit
|
|
|
22
26
|
npm run commit
|
|
23
27
|
```
|
|
24
28
|
|
|
29
|
+
This will:
|
|
30
|
+
|
|
31
|
+
1. Check if you have staged changes, and tell you to stage something first if you haven't, genius
|
|
32
|
+
2. Connect to Ollama, if it's running, which it probably isn't
|
|
33
|
+
3. Generate a commit message based on your changes
|
|
34
|
+
4. Let you edit it if you want, because the AI isn't perfect, shockingly
|
|
35
|
+
5. Commit your changes with the generated message
|
|
36
|
+
|
|
25
37
|
## Requirements
|
|
26
38
|
|
|
27
|
-
- Ollama running locally
|
|
28
|
-
- Recommended model: `ollama pull deepseek-v3.1:671b-cloud
|
|
29
|
-
- Staged git changes
|
|
39
|
+
- Ollama running locally, good luck with that
|
|
40
|
+
- Recommended model: `ollama pull deepseek-v3.1:671b-cloud`, or use whatever model you have, we're not picky
|
|
41
|
+
- Staged git changes, because we can't commit nothing, obviously
|
|
30
42
|
|
|
31
43
|
## Config
|
|
32
44
|
|
|
33
|
-
- `VIBELINT_OLLAMA_URL` - Ollama URL
|
|
34
|
-
- Will automatically use `deepseek-v3.1:671b-cloud` if installed
|
|
35
|
-
- Otherwise, prompts to install it or select from available models
|
|
36
|
-
- Config and cache stored in `node_modules/.cache/vibelint
|
|
45
|
+
- `VIBELINT_OLLAMA_URL` - Ollama URL, defaults to `http://127.0.0.1:11434` which is probably wrong if you're using Docker or something
|
|
46
|
+
- Will automatically use `deepseek-v3.1:671b-cloud` if installed, because it's the best one, obviously
|
|
47
|
+
- Otherwise, prompts to install it or select from available models, because we're helpful like that
|
|
48
|
+
- Config and cache stored in `node_modules/.cache/vibelint/`, automatically gitignored because we're not monsters
|