aicommits 0.2.5 → 0.2.7
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 +19 -8
- package/bin/aicommits.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,17 +1,26 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<div>
|
|
3
|
+
<img src="/screenshot.png" alt="AI Commits"/>
|
|
4
|
+
<h1 align="center">AI Commits</h1>
|
|
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://packagephobia.com/result?p=aicommits"><img src="https://badgen.net/packagephobia/install/aicommits" alt="Current version"></a>
|
|
8
|
+
<a href="https://www.npmjs.com/package/aicommits"><img src="https://img.shields.io/npm/v/aicommits" alt="Install size"></a>
|
|
9
|
+
<a href="https://twitter.com/nutlope">
|
|
10
|
+
<img src="https://img.shields.io/twitter/follow/nutlope?style=flat&label=nutlope&logo=twitter&color=0bf&logoColor=fff" alt="Hassan Twitter follower count" />
|
|
11
|
+
</a>
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
6
15
|
|
|
7
16
|
## Installation and Usage
|
|
8
17
|
|
|
9
|
-
Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it as an
|
|
18
|
+
Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it as an env variable with the two commands below.
|
|
10
19
|
|
|
11
20
|
1. `npm install -g aicommits`
|
|
12
21
|
2. `export OPENAI_KEY=sk-xxxxxxxxxxxxxxxx`
|
|
13
22
|
|
|
14
|
-
|
|
23
|
+
After that, generate your commit running `aicommits`.
|
|
15
24
|
|
|
16
25
|
> Note: If you get a EACCESS error on mac/linux when running the first command, try running it with `sudo npm install -g aicommits` and putting in your password.
|
|
17
26
|
|
|
@@ -28,7 +37,9 @@ The next version of the CLI, v2, will address both of these limitations!
|
|
|
28
37
|
|
|
29
38
|
## Future tasks
|
|
30
39
|
|
|
40
|
+
- Ignore package-lock and yarn.lock files
|
|
41
|
+
- Experiment with openai curie and codex as opposed to dacinvi
|
|
42
|
+
- Figure out the price per commit
|
|
31
43
|
- Add support for conventional commits as a flag that users can enable
|
|
32
44
|
- Try supporting more than 200 lines by grabbing the diff per file
|
|
33
|
-
- Experiment with openai curie and codex as opposed to dacinvi
|
|
34
45
|
- Build landing page for the 2.0 launch
|
package/bin/aicommits.js
CHANGED
|
@@ -24,7 +24,7 @@ function main() {
|
|
|
24
24
|
console.log(chalk_1.default.white("▲ ") + chalk_1.default.green("Welcome to AICommit!"));
|
|
25
25
|
if (!OPENAI_API_KEY) {
|
|
26
26
|
console.error(chalk_1.default.white("▲ ") +
|
|
27
|
-
"Please specify an OpenAI key using export
|
|
27
|
+
"Please specify an OpenAI key using export OPENAI_API_KEY='YOUR_API_KEY'");
|
|
28
28
|
process.exit(1);
|
|
29
29
|
}
|
|
30
30
|
try {
|