mirror of https://github.com/di-sukharev/opencommit.git synced 2026-01-13 15:47:58 -05:00

Files

di-sukharev d785b821ea * 📝 docs(README.md): comment out Git hook section

The Git hook section has been commented out as it is not currently relevant to the project.

2023-03-06 19:27:19 +08:00

OpenCommit

AI generates conventional commits with mind-blowing accuracy

Examples

Look into the commits to see how OpenCommit works. Emoji and long commit description text is configurable.

The minimum supported version of Node.js is the latest v14. Check your Node.js version with node --version.

Install opencommit globally to use in any repository:
```
npm install -g opencommit
```
Get your API key from OpenAI
Set the key to opencommit config:
```
opencommit config set OPENAI_API_KEY=<your token>
```
Your token isn't sent to anyone, it's saved in ~/.opencommit config file.

You can call opencommit directly to generate a commit message for your staged changes:

git add <files...>
opencommit

You can also use the oc shortcut:

git add <files...>
oc

GitMoji convention is used.

To add emoji:

opencommit config set emoji=true

To remove emoji:

opencommit config set emoji=false

To add descriptions:

opencommit config set description=true

To remove description:

opencommit config set description=false

You pay for your own requests to OpenAI API. OpenCommit uses ChatGPT official model, that is ~10x times cheaper than GPT-3.