minor changes

This commit is contained in:
Hassan El Mghari
2023-02-13 19:11:23 -05:00
parent 9079639704
commit 59fb2288ca
4 changed files with 20 additions and 9 deletions

View File

@@ -1,17 +1,26 @@
# AI Commits
<div align="center">
<div>
<img src="/screenshot.png" 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>
<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>
</div>
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

View File

@@ -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);
}

View File

@@ -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": {

Binary file not shown.

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 606 KiB