aicommits 2.0.0-develop.29 → 2.0.0-develop.30
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 +27 -6
- package/dist/{cli-B8ookV4e.mjs → cli-CayV1s_d.mjs} +109 -108
- package/dist/cli.mjs +1 -1
- package/dist/{token-CRGQJP5l.mjs → token-KkHT_6F9.mjs} +1 -1
- package/dist/{token-util-D5yU_rYz.mjs → token-util-CouME5QQ.mjs} +1 -1
- package/dist/{token-util-DOJmF9O_.mjs → token-util-Cx8y_cov.mjs} +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<div>
|
|
3
3
|
<img src=".github/screenshot.png" alt="AI Commits"/>
|
|
4
|
+
<img src="./aic.png" width="50" alt="AI Commits"/>
|
|
4
5
|
<h1 align="center">AI Commits</h1>
|
|
5
6
|
</div>
|
|
6
7
|
<p>A CLI that writes your git commit messages for you with AI. Never write a commit message again.</p>
|
|
@@ -17,11 +18,9 @@
|
|
|
17
18
|
1. Install _aicommits_:
|
|
18
19
|
|
|
19
20
|
```sh
|
|
20
|
-
npm install -g aicommits
|
|
21
|
+
npm install -g aicommits
|
|
21
22
|
```
|
|
22
23
|
|
|
23
|
-
> We need @develop since v2 is still not released as latest/main!
|
|
24
|
-
|
|
25
24
|
2. Run the setup command to choose your AI provider:
|
|
26
25
|
|
|
27
26
|
```sh
|
|
@@ -62,16 +61,22 @@ This will guide you through:
|
|
|
62
61
|
|
|
63
62
|
Check the installed version with:
|
|
64
63
|
|
|
64
|
+
```sh
|
|
65
|
+
aicommits --version
|
|
65
66
|
```
|
|
66
67
|
|
|
67
|
-
|
|
68
|
+
To update to the latest version, run:
|
|
68
69
|
|
|
70
|
+
```sh
|
|
71
|
+
aicommits update
|
|
69
72
|
```
|
|
70
73
|
|
|
71
|
-
|
|
74
|
+
This will automatically detect your package manager (npm, pnpm, yarn, or bun) and update using the correct command.
|
|
75
|
+
|
|
76
|
+
Alternatively, you can manually update:
|
|
72
77
|
|
|
73
78
|
```sh
|
|
74
|
-
npm install -g aicommits
|
|
79
|
+
npm install -g aicommits
|
|
75
80
|
```
|
|
76
81
|
|
|
77
82
|
## Usage
|
|
@@ -103,6 +108,7 @@ aicommits --all # or -a
|
|
|
103
108
|
- `--exclude` or `-x`: Files to exclude from AI analysis
|
|
104
109
|
- `--type` or `-t`: Git commit message format (default: **plain**). Supports `plain`, `conventional`, and `gitmoji`
|
|
105
110
|
- `--prompt` or `-p`: Custom prompt to guide the LLM behavior (e.g., specific language, style instructions)
|
|
111
|
+
- `--no-verify` or `-n`: Bypass pre-commit hooks while committing (default: **false**)
|
|
106
112
|
- `--yes` or `-y`: Skip confirmation when committing after message generation (default: **false**)
|
|
107
113
|
|
|
108
114
|
#### Generate multiple recommendations
|
|
@@ -233,6 +239,21 @@ This will:
|
|
|
233
239
|
- Let you select from available models or enter a custom model name
|
|
234
240
|
- Update your configuration automatically
|
|
235
241
|
|
|
242
|
+
### Updating aicommits
|
|
243
|
+
|
|
244
|
+
To update to the latest version, run:
|
|
245
|
+
|
|
246
|
+
```sh
|
|
247
|
+
aicommits update
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
This will:
|
|
251
|
+
|
|
252
|
+
- Check for the latest version on npm
|
|
253
|
+
- Detect your package manager (npm, pnpm, yarn, or bun)
|
|
254
|
+
- Update using the appropriate command
|
|
255
|
+
- Show progress and confirm when complete
|
|
256
|
+
|
|
236
257
|
### Reading a configuration value
|
|
237
258
|
|
|
238
259
|
To retrieve a configuration option, use the command:
|