aicommits 1.1.0 → 1.2.0
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 -16
- package/dist/cli.mjs +59 -52
- package/package.json +21 -4
package/README.md
CHANGED
|
@@ -5,34 +5,36 @@
|
|
|
5
5
|
</div>
|
|
6
6
|
<p>A CLI that writes your git commit messages for you with AI. Never write a commit message again.</p>
|
|
7
7
|
<a href="https://www.npmjs.com/package/aicommits"><img src="https://img.shields.io/npm/v/aicommits" alt="Current version"></a>
|
|
8
|
-
<a href="https://twitter.com/nutlope">
|
|
9
|
-
<img src="https://img.shields.io/twitter/follow/nutlope?style=flat&label=nutlope&logo=twitter&color=0bf&logoColor=fff" alt="Hassan Twitter follower count" />
|
|
10
|
-
</a>
|
|
11
8
|
</div>
|
|
12
9
|
|
|
13
10
|
---
|
|
14
11
|
|
|
15
|
-
##
|
|
12
|
+
## Setup
|
|
16
13
|
|
|
17
|
-
|
|
14
|
+
> The minimum supported version of Node.js is the latest v14. Check your Node.js version with `node --version`.
|
|
18
15
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
16
|
+
|
|
17
|
+
1. Install _aicommits_:
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npm install -g aicommits
|
|
21
|
+
```
|
|
22
22
|
|
|
23
23
|
2. Retrieve your API key from [OpenAI](https://platform.openai.com/account/api-keys)
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
> Note: If you haven't already, you'll have to create an account and set up billing.
|
|
26
26
|
|
|
27
27
|
3. Set the key so aicommits can use it:
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
29
|
+
```sh
|
|
30
|
+
aicommits config set OPENAI_KEY=<your token>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
This will create a `.aicommits` file in your home directory.
|
|
32
34
|
|
|
33
|
-
4.
|
|
35
|
+
4. Start committing!
|
|
34
36
|
|
|
35
|
-
|
|
37
|
+
Go make some changes in any Git repo, stage them, run `aicommits`, and see your AI generated message!
|
|
36
38
|
|
|
37
39
|
## How it works
|
|
38
40
|
|
|
@@ -55,5 +57,7 @@ Video coming soon where I rebuild it from scratch to show you how to easily buil
|
|
|
55
57
|
|
|
56
58
|
## Maintainers
|
|
57
59
|
|
|
58
|
-
- **Hassan El Mghari**: [
|
|
59
|
-
|
|
60
|
+
- **Hassan El Mghari**: [@Nutlope](https://github.com/Nutlope) [<img src="https://img.shields.io/twitter/follow/nutlope?style=flat&label=nutlope&logo=twitter&color=0bf&logoColor=fff" align="center">](https://twitter.com/nutlope)
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
- **Hiroki Osame**: [@privatenumber](https://github.com/privatenumber) [<img src="https://img.shields.io/twitter/follow/privatenumbr?style=flat&label=privatenumbr&logo=twitter&color=0bf&logoColor=fff" align="center">](https://twitter.com/privatenumbr)
|