aicommits 0.3.2 → 1.0.0

package/README.md

@@ -1,11 +1,10 @@
 <div align="center">
   <div>
-    <img src="/screenshot.png" alt="AI Commits"/>
+    <img src="https://raw.githubusercontent.com/Nutlope/aicommits/main/screenshot.png?token=GHSAT0AAAAAABPRWK4LSHNE654RA5GMMKYMY7K4MWQ" alt="AI Commits"/>
     <h1 align="center">AI Commits</h1>
   </div>
-	<p>A CLI that writes your git commit messages for you. Never write a commit message again.</p>
-	<a href="https://packagephobia.com/result?p=aicommits"><img src="https://badgen.net/packagephobia/install/aicommits" alt="Current version"></a>
-	<a href="https://www.npmjs.com/package/aicommits"><img src="https://img.shields.io/npm/v/aicommits" alt="Install size"></a>
+	<p>A CLI that writes your git commit messages for you with AI. Never write a commit message again.</p>
+	<a href="https://www.npmjs.com/package/aicommits"><img src="https://img.shields.io/npm/v/aicommits" alt="Current version"></a>
   <a href="https://twitter.com/nutlope">
     <img src="https://img.shields.io/twitter/follow/nutlope?style=flat&label=nutlope&logo=twitter&color=0bf&logoColor=fff" alt="Hassan Twitter follower count" />
   </a>
@@ -18,15 +17,15 @@
 Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it as an env variable with the two commands below.
 
 1. `npm install -g aicommits`
-2. `export OPENAI_KEY=sk-xxxxxxxxxxxxxxxx`
+2. `export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx`
 
 After that, generate your commit running `aicommits`.
 
-> 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.
+> Note: If you get a EACCESS error on mac/linux when running the first command, try running it with `sudo npm install -g aicommits`.
 
 ## How it works
 
-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 data gets sent to OpenAI for a commit message to be generated. However, OpenAI gives folks $18 of free credits and commit message generations are cheap so it should be free for a long time.
+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.
 
 Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI.
 
@@ -35,10 +34,11 @@ Video coming soon where I rebuild it from scratch to show you how to easily buil
 - Only supports git diffs of up to 200 lines of code for now
 - Does not support conventional commits
 
-The next version of the CLI, v2, will address both of these limitations!
+The next version of the CLI, version 2, will address both of these limitations!
 
 ## Future tasks
 
 - Add support for conventional commits as a flag that users can enable
-- Try supporting more than 200 lines by grabbing the diff per file
+- Add support for diffs greater than 200 lines by grabbing the diff per file
+- Add support for a flag that can auto-accept
 - Build landing page for the 2.0 launch

package/bin/aicommits.js

@@ -21,10 +21,10 @@ const node_fetch_1 = __importDefault(require("node-fetch"));
 let OPENAI_API_KEY = process.env.OPENAI_API_KEY;
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
-        console.log(chalk_1.default.white("▲ ") + chalk_1.default.green("Welcome to AICommit!"));
+        console.log(chalk_1.default.white("▲ ") + chalk_1.default.green("Welcome to AICommits!"));
         if (!OPENAI_API_KEY) {
             console.error(chalk_1.default.white("▲ ") +
-                "Please specify an OpenAI key using export OPENAI_API_KEY='YOUR_API_KEY'");
+                "Please save your OpenAI API key as an env variable by doing 'export OPENAI_API_KEY=YOUR_API_KEY'");
             process.exit(1);
         }
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aicommits",
-  "version": "0.3.2",
+  "version": "1.0.0",
   "description": "Writes your git commit messages for you with AI",
   "main": "bin/index.js",
   "bin": {
@@ -20,5 +20,10 @@
     "chalk": "^4.1.2",
     "inquirer": "^8.0.0",
     "node-fetch": "^2.6.9"
-  }
+  },
+  "keywords": [
+    "ai",
+    "git",
+    "commit"
+  ]
 }