version 1 is ready
This commit is contained in:
10
README.md
10
README.md
@@ -3,7 +3,7 @@
|
|||||||
<img src="https://raw.githubusercontent.com/Nutlope/aicommits/main/screenshot.png?token=GHSAT0AAAAAABPRWK4L2SO2P7OQARQ3YCF6Y7K3XWA" alt="AI Commits"/>
|
<img src="https://raw.githubusercontent.com/Nutlope/aicommits/main/screenshot.png?token=GHSAT0AAAAAABPRWK4L2SO2P7OQARQ3YCF6Y7K3XWA" alt="AI Commits"/>
|
||||||
<h1 align="center">AI Commits</h1>
|
<h1 align="center">AI Commits</h1>
|
||||||
</div>
|
</div>
|
||||||
<p>A CLI that writes your git commit messages for you. Never write a commit message again.</p>
|
<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://www.npmjs.com/package/aicommits"><img src="https://img.shields.io/npm/v/aicommits" alt="Current version"></a>
|
||||||
<a href="https://twitter.com/nutlope">
|
<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" />
|
<img src="https://img.shields.io/twitter/follow/nutlope?style=flat&label=nutlope&logo=twitter&color=0bf&logoColor=fff" alt="Hassan Twitter follower count" />
|
||||||
@@ -17,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.
|
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`
|
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`.
|
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
|
## 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.
|
Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI.
|
||||||
|
|
||||||
@@ -34,7 +34,7 @@ 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
|
- Only supports git diffs of up to 200 lines of code for now
|
||||||
- Does not support conventional commits
|
- 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
|
## Future tasks
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "aicommits",
|
"name": "aicommits",
|
||||||
"version": "0.5.0",
|
"version": "1.0.0",
|
||||||
"description": "Writes your git commit messages for you with AI",
|
"description": "Writes your git commit messages for you with AI",
|
||||||
"main": "bin/index.js",
|
"main": "bin/index.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
|
|||||||
Reference in New Issue
Block a user