shiyue/aicommits
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4eb240f36dc0dbc7c666718100f196db9c92a178
aicommits/README.md
Hassan El Mghari 4eb240f36d README changes
2023-02-13 19:48:30 -05:00

2.0 KiB
Raw Blame History

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

Installation and Usage

Install the CLI then grab your OpenAI key 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, 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.

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.

Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI.

Limitations

  • Only supports git diffs of up to 200 lines of code for now
  • Does not support conventional commits

The next version of the CLI, v2, will address both of these limitations!

Future tasks

  • Add support for conventional commits as a flag that users can enable
  • Try supporting more than 200 lines by grabbing the diff per file
  • Build landing page for the 2.0 launch