Setup

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

1. Install aicommits:

   npm install -g aicommits2

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 aicommits2 can use it:

   aicommits2 config set OPENAI_KEY=<your token>

   This will create a .aicommits file in your home directory.

4. Start committing!

   Go make some changes in any Git repo, stage them, run aicommits2, and see your AI generated message!

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

• Hassan El Mghari: @Nutlope

• Hiroki Osame: @privatenumber

• Binh Nguyen: @binhapp