Skip to content

A CLI that writes your git commit messages for you with AI

License

Notifications You must be signed in to change notification settings

Th3Kr4t3/aicommits

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI Commits

AI Commits

A CLI that writes your git commit messages for you with AI. Never write a commit message again.

Current version Hassan Twitter follower count

Installation and Usage

  1. Install the CLI:

    npm install -g aicommits
  2. Retrieve your API key from OpenAI

    Note: If you haven't already, you'll have to create an account and set up billing.

  3. Set the key so aicommits can use it:

    echo "OPENAI_KEY=<your token>" >> ~/.aicommits
  4. You're ready to go!

    Run aicommits in any Git repo and it will generate a commit message for you.

How it works

This CLI tool runs git diff to grab all your latest code changes, sends them 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.

Future tasks

  • Add support for conventional commits as a flag that users can enable
  • Add support for diffs greater than 200 lines by grabbing the diff per file, optional flag
  • Add ability to specify a commit message from inside aicommit if user doesn't like generated one
  • Solve latency issue (use a githook to asynchronously run gpt3 call on every git add, store the result in a temp file or in the .git folder). Put behind a flag
  • Use gpt-3-tokenizer instead of hard limit on characters as a more accurate model
  • Play around with prompt to produce optimal result
  • Add opt-in emoji flag to preface commits with an emoji, use this as a guide
  • Add opt-in languages flag where it returns the commit in different languages
  • Add automated github releases using this action
  • Build landing page for the 2.0 launch

Maintainers

About

A CLI that writes your git commit messages for you with AI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%