aicommits 0.2.0 → 0.2.2

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.
Files changed (2) hide show
  1. package/README.md +15 -19
  2. package/package.json +2 -3
package/README.md CHANGED
@@ -1,14 +1,17 @@
1
- # AI Commits - work in progress
1
+ # AI Commits
2
2
 
3
3
  AI Commits is a tool that writes your git commit messages for you. Never write a commit message again.
4
4
 
5
- [![AI Commit Screenshot](https://github.com/Nutlope/aicommits/blob/main/screenshot.png)](https://twitter.com/nutlope/status/1624646872890589184)
5
+ ![AI Commit Screenshot](https://github.com/Nutlope/aicommits/blob/main/screenshot.png)]
6
6
 
7
- ## Installation and usage
7
+ ## Installation and Usage
8
8
 
9
- 1. `npm install -g autocommit` to install the CLI
10
- 2. `export OPENAI_KEY=sk-xxxxxxxxxxxxxxxx` to specify your OpenAI API Key
11
- 3. `autocommit` after you run `git add .` to generate your commit
9
+ Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it as an environment variable.
10
+
11
+ 1. `npm install -g aicommits`
12
+ 2. `export OPENAI_KEY=sk-xxxxxxxxxxxxxxxx`
13
+
14
+ Then after running a `git add .` command in a git repo, use this CLI by simply running `aicommits` to generate your commit.
12
15
 
13
16
  ## How it works
14
17
 
@@ -16,21 +19,14 @@ This CLI tool runs a `git diff` command to grab all the latest changes, sends th
16
19
 
17
20
  ## Limitations
18
21
 
19
- It currently can only support git diffs of up to 200 lines of code. I'm working on version 2.0 which will be TypeScript-first, support conventional commits, and support long diffs.
20
-
21
- ## Remaining tasks
22
-
23
- Now:
22
+ - Only supports git diffs of up to 200 lines of code for now
23
+ - Does not support conventional commits
24
24
 
25
- - Rewrite this in node to publish as an npm package
26
- - Fix screenshot on npm
27
- - add an npm ignore and add demo to README as well
28
- - make CLI looks nicer
25
+ The next version of the CLI, v2, will address both of these limitations!
29
26
 
30
- Future tasks:
27
+ ## Future tasks
31
28
 
32
- - Experiment with openai curie and/or codex
33
- - Add conventional commit support
29
+ - Add support for conventional commits as a flag that users can enable
34
30
  - Try supporting more than 200 lines by grabbing the diff per file
35
- - Rewrite in TypeScript
31
+ - Experiment with openai curie and codex as opposed to dacinvi
36
32
  - Build landing page for the 2.0 launch
package/package.json CHANGED
@@ -1,8 +1,7 @@
1
1
  {
2
2
  "name": "aicommits",
3
- "version": "0.2.0",
3
+ "version": "0.2.2",
4
4
  "description": "Writes your git commit messages for you with AI",
5
- "type": "module",
6
5
  "main": "bin/index.js",
7
6
  "bin": {
8
7
  "aicommits": "bin/index.js"
@@ -18,7 +17,7 @@
18
17
  "build": "tsc"
19
18
  },
20
19
  "dependencies": {
21
- "chalk": "^5.2.0",
20
+ "chalk": "^4.1.2",
22
21
  "inquirer": "^9.1.4",
23
22
  "node-fetch": "^3.3.0"
24
23
  }