auto-commit-ai v0.0.7

Setup

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

1. Install autoCommit:

   npm install -g auto-commit-ai

2. Retrieve your API key from AutoCommit

3. Set the key so autoCommit can use it:

   autoCommit config set AUTOCOMMIT_KEY=<your AUTOCOMMIT_KEY token>

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

Upgrading

Check the installed version with:

npm update -g autoCommit

Usage

CLI mode

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

git add <files...>
autoCommit

autoCommit passes down unknown flags to git commit, so you can pass in commit flags.

For example, you can stage all changes in tracked files with as you commit:

autoCommit --all # or -a

👉 Tip: Use the aca alias if autoCommit is too long for you.

Generate multiple recommendations

Sometimes the recommended commit message isn't the best so you want it to generate a few to pick from. You can generate multiple commit messages at once by passing in the --generate <i> flag, where 'i' is the number of generated messages:

autoCommit --generate <i> # or -g <i>

Warning: this uses more tokens, meaning it costs more.

Generating Conventional Commits

If you'd like to generate Conventional Commits, you can use the --type flag followed by conventional. This will prompt autoCommit to format the commit message according to the Conventional Commits specification:

autoCommit --type conventional # or -t conventional

This feature can be useful if your project follows the Conventional Commits standard or if you're using tools that rely on this commit format.

Git hook

You can also integrate autoCommit with Git via the prepare-commit-msg hook. This lets you use Git like you normally would, and edit the commit message before committing.

Install

In the Git repository you want to install the hook in:

autoCommit hook install

Uninstall

In the Git repository you want to uninstall the hook from:

autoCommit hook uninstall

Usage

1. Stage your files and commit:

   git add <files...>
   git commit # Only generates a message when it's not passed in

   If you ever want to write your own message instead of generating one, you can simply pass one in: git commit -m "My message"

2. autoCommit will generate the commit message for you and pass it back to Git. Git will open it with the configured editor for you to review/edit it.

3. Save and close the editor to commit!

Configuration

Reading a configuration value

To retrieve a configuration option, use the command:

autoCommit config get <key>

For example, to retrieve the API key, you can use:

autoCommit config get AUTOCOMMIT_KEY

You can also retrieve multiple configuration options at once by separating them with spaces:

autoCommit config get AUTOCOMMIT_KEY generate

Setting a configuration value

To set a configuration option, use the command:

autoCommit config set <key>=<value>

For example, to set the API key, you can use:

autoCommit config set AUTOCOMMIT_KEY=<your-api-key>

You can also set multiple configuration options at once by separating them with spaces, like

autoCommit config set AUTOCOMMIT_KEY=<your-api-key> generate=3 locale=en

Options

AUTOCOMMIT_KEY

Required

The AutoCommit API key. You can retrieve it from AutoCommit API Keys page.

locale

Default: en

The locale to use for the generated commit messages. Consult the list of codes in: https://wikipedia.org/wiki/List_of_ISO_639-1_codes.

generate

Default: 1

The number of commit messages to generate to pick from.

Note, this will use more tokens as it generates more results.

timeout

The timeout for network requests to the OpenAI API in milliseconds.

Default: 10000 (10 seconds)

autoCommit config set timeout=20000 # 20s

max-length

The maximum character length of the generated commit message.

Default: 50

autoCommit config set max-length=100

type

Default: "" (Empty string)

The type of commit message to generate. Set this to "conventional" to generate commit messages that follow the Conventional Commits specification:

autoCommit config set type=conventional

You can clear this option by setting it to an empty string:

autoCommit config set type=

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.