diff --git a/README.md b/README.md index da8f33e..deaafa1 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,26 @@ -# AI Commits +
+
+ AI Commits +

AI Commits

+
+

A CLI that writes your git commit messages for you. Never write a commit message again.

+ Current version + Install size + + Hassan Twitter follower count + +
-AI Commits is a tool that writes your git commit messages for you. Never write a commit message again. - -![AI Commit Screenshot](https://github.com/Nutlope/aicommits/blob/main/screenshot.png) +--- ## Installation and Usage -Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it as an environment variable. +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` -After that, use this CLI by simply running `aicommits` to generate your commit. +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. @@ -28,7 +37,9 @@ The next version of the CLI, v2, will address both of these limitations! ## Future tasks +- Ignore package-lock and yarn.lock files +- Experiment with openai curie and codex as opposed to dacinvi + - Figure out the price per commit - Add support for conventional commits as a flag that users can enable - Try supporting more than 200 lines by grabbing the diff per file -- Experiment with openai curie and codex as opposed to dacinvi - Build landing page for the 2.0 launch diff --git a/aicommits.ts b/aicommits.ts index 0dc3a9c..2619fe8 100644 --- a/aicommits.ts +++ b/aicommits.ts @@ -13,7 +13,7 @@ export async function main() { if (!OPENAI_API_KEY) { console.error( chalk.white("▲ ") + - "Please specify an OpenAI key using export OPEN_AI_KEY='YOUR_API_KEY'" + "Please specify an OpenAI key using export OPENAI_API_KEY='YOUR_API_KEY'" ); process.exit(1); } diff --git a/package.json b/package.json index dbde0f7..0cc0f6a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "aicommits", - "version": "0.2.5", + "version": "0.2.7", "description": "Writes your git commit messages for you with AI", "main": "bin/index.js", "bin": { diff --git a/screenshot.png b/screenshot.png index 847dcef..aed0acb 100644 Binary files a/screenshot.png and b/screenshot.png differ