JSPM – auto-commit-ai@1.4.4

Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (auto-commit-ai) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Setup

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

Install autoCommit:
```
npm install -g auto-commit-ai
```
Retrieve your API key from AutoCommit
Set the key so autoCommit can use it:
```
autoCommit config
```
This will start an interactive configuration to set your authtoken and other options.

Upgrading

Check the installed version with:

npm update -g auto-commit-ai

Authentication Setup

Run the authentication setup to configure your API key:

aca auth

Other Configuration

Run the interactive configuration to set other options:

aca config

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

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"
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.
Save and close the editor to commit!

Configuration

Interactive Configuration

Use the interactive configuration to set all options:

autoCommit config

This will start an interactive interface that lets you set authtoken, model, locale, and other configuration options.

Development Mode Configuration

If you're using the development version, you can use:

aca config

Options

authtoken

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: 30000 (30 seconds)

max-length

The maximum character length of the generated commit message.

Default: 50

model

Default: deepseek-v3

The AI model to use for generating commit messages. Supported models:

deepseek-v3 - DeepSeek V3 model
deepseek-r1 - DeepSeek R1 model
gemini-2.0 - Google Gemini 2.0 model
gpt-3.5-turbo - OpenAI GPT-3.5 Turbo model

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.

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

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.