aicommits 0.5.0 → 1.0.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 +7 -7
- package/package.json +7 -2
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<div>
|
|
3
|
-
<img src="https://raw.githubusercontent.com/Nutlope/aicommits/main/screenshot.png
|
|
3
|
+
<img src="https://raw.githubusercontent.com/Nutlope/aicommits/main/screenshot.png" alt="AI Commits"/>
|
|
4
4
|
<h1 align="center">AI Commits</h1>
|
|
5
5
|
</div>
|
|
6
|
-
<p>A CLI that writes your git commit messages for you. Never write a commit message again.</p>
|
|
7
|
-
<a href="https://
|
|
6
|
+
<p>A CLI that writes your git commit messages for you with AI. Never write a commit message again.</p>
|
|
7
|
+
<a href="https://www.npmjs.com/package/aicommits"><img src="https://img.shields.io/npm/v/aicommits" alt="Current version"></a>
|
|
8
8
|
<a href="https://twitter.com/nutlope">
|
|
9
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
10
|
</a>
|
|
@@ -17,15 +17,15 @@
|
|
|
17
17
|
Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it as an env variable with the two commands below.
|
|
18
18
|
|
|
19
19
|
1. `npm install -g aicommits`
|
|
20
|
-
2. `export
|
|
20
|
+
2. `export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx`
|
|
21
21
|
|
|
22
22
|
After that, generate your commit running `aicommits`.
|
|
23
23
|
|
|
24
|
-
> Note: If you get a EACCESS error on mac/linux when running the first command, try running it with `sudo npm install -g aicommits
|
|
24
|
+
> Note: If you get a EACCESS error on mac/linux when running the first command, try running it with `sudo npm install -g aicommits`.
|
|
25
25
|
|
|
26
26
|
## How it works
|
|
27
27
|
|
|
28
|
-
This CLI tool runs a `git diff` command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. I also want to note that it does cost money since
|
|
28
|
+
This CLI tool runs a `git diff` command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. I also want to note that it does cost money since GPT-3 generations aren't free. However, OpenAI gives folks $18 of free credits and commit message generations are cheap so it should be free for a long time.
|
|
29
29
|
|
|
30
30
|
Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI.
|
|
31
31
|
|
|
@@ -34,7 +34,7 @@ Video coming soon where I rebuild it from scratch to show you how to easily buil
|
|
|
34
34
|
- Only supports git diffs of up to 200 lines of code for now
|
|
35
35
|
- Does not support conventional commits
|
|
36
36
|
|
|
37
|
-
The next version of the CLI,
|
|
37
|
+
The next version of the CLI, version 2, will address both of these limitations!
|
|
38
38
|
|
|
39
39
|
## Future tasks
|
|
40
40
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "aicommits",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Writes your git commit messages for you with AI",
|
|
5
5
|
"main": "bin/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -20,5 +20,10 @@
|
|
|
20
20
|
"chalk": "^4.1.2",
|
|
21
21
|
"inquirer": "^8.0.0",
|
|
22
22
|
"node-fetch": "^2.6.9"
|
|
23
|
-
}
|
|
23
|
+
},
|
|
24
|
+
"keywords": [
|
|
25
|
+
"ai",
|
|
26
|
+
"git",
|
|
27
|
+
"commit"
|
|
28
|
+
]
|
|
24
29
|
}
|