shiyue/aicommits
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
79aec65a08ff226cedfce89179e998c407c08545
aicommits/README.md
Hassan El Mghari 79aec65a08 edited README
2023-02-13 18:39:58 -05:00

1.2 KiB
Raw Blame History

AI Commits

AI Commits is a tool that writes your git commit messages for you. Never write a commit message again.

AI Commit Screenshot]

Installation and Usage

Install the CLI then grab your OpenAI key and add it as an environment variable.

  1. npm install -g aicommits
  2. export OPENAI_KEY=sk-xxxxxxxxxxxxxxxx

Then after running a git add . command in a git repo, use this CLI by simply running aicommits to generate your commit.

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. 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
  • Experiment with openai curie and codex as opposed to dacinvi
  • Build landing page for the 2.0 launch