trying auto commit package name

This commit is contained in:
Hassan El Mghari
2023-02-13 14:49:13 -05:00
parent 569194767d
commit 5456bab0b7
3 changed files with 6 additions and 22 deletions

View File

@@ -6,10 +6,7 @@ Have AI Commit write your git commit messages for you so you never have to write
## How to install ## How to install
1. Run `npm i -g zx` (this CLI uses zx) `npm install -g autocommit`
2. Run `git clone github.com/nutlope/aicommit` in your root directory
3. Add a file called `.env.json` in the folder with your OpenAI API key. You can get this by [signing up](https://openai.com/api/)
4. [Optional] If you're on mac, add `alias aicommit="zx ~/ai-commit/aicommit.mjs"` to your `.zshrc` so you can trigger the program simply by typing `aicommit`
**Note:** The process to install this will get vastly simplified when I rewrite this CLI and publish it as an npm package to be run with `npx`. **Note:** The process to install this will get vastly simplified when I rewrite this CLI and publish it as an npm package to be run with `npx`.
@@ -35,5 +32,3 @@ After:
- [ ] Build landing page - [ ] Build landing page
# How to run new version # How to run new version
`npm install -g zx aicommit`

14
package-lock.json generated
View File

@@ -1,14 +0,0 @@
{
"name": "ai-commit",
"version": "1.0.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "ai-commit",
"version": "1.0.0",
"hasInstallScript": true,
"license": "ISC"
}
}
}

View File

@@ -1,12 +1,15 @@
{ {
"name": "commitai", "name": "autocommit",
"version": "0.0.1", "version": "0.0.3",
"description": "generates ai commit", "description": "generates ai commit",
"main": "aicommit.js", "main": "aicommit.js",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1", "test": "echo \"Error: no test specified\" && exit 1",
"start": "./aicommit.js" "start": "./aicommit.js"
}, },
"bin": {
"gpt-commit": "./aicommit.js"
},
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/Nutlope/ai-commit.git" "url": "git+https://github.com/Nutlope/ai-commit.git"