@lucavb/aicommits v0.6.1

@lucavb/aicommits

Quick Start

Install globally:

npm install -g @lucavb/aicommits

Run the setup command to configure your environment:

aicommits setup

Stage your changes and generate a commit message:

git add <files...>
aicommits

Example output:

✔ Generating commit message...
feat: Add user authentication and update login flow

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

Setup

1. Install aicommits:

   npm install -g @lucavb/aicommits

2. Run the interactive setup:

   aicommits setup

   This will guide you through:

   • Selecting your AI provider (OpenAI, Ollama, or Anthropic)
   • Configuring the API base URL
   • Setting up your API key (if required)
   • Choosing the model to use

   You can also set up different profiles for different projects or environments:

   aicommits setup --profile development

   Note: For OpenAI, you'll need an API key from OpenAI's platform. Make sure you have an account and billing set up.

Upgrading

Upgrade to the latest version:

npm update -g @lucavb/aicommits

Usage

CLI mode

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

git add <files...>
aicommits

aicommits 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:

aicommits --stage-all # or -a

You can also use different profiles for different projects or environments:

aicommits --profile <profile-name>

👉 Tip: Use the aic alias if aicommits is too long for you.

Generating Conventional Commits

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

aicommits --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.

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. Aicommits 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!

Commit Message Standards

This project uses commitlint with Conventional Commits to ensure consistent commit message formatting. The configuration is automatically enforced via Git hooks powered by husky.

Conventional Commit Format

Commit messages must follow this format:

<type>[(optional scope)]: <description>

[optional body]

[optional footer(s)]

Types:

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code
• refactor: A code change that neither fixes a bug nor adds a feature
• perf: A code change that improves performance
• test: Adding missing tests or correcting existing tests
• chore: Changes to the build process or auxiliary tools

Examples:

feat: add user authentication
fix: resolve memory leak in data processing
docs: update installation instructions
chore: bump dependencies to latest versions

Manual Validation

You can manually check your commit messages using:

npm run commitlint

The commit message validation runs automatically when you commit, so invalid messages will be rejected before they're added to the repository.

Configuration

Reading a configuration value

To retrieve a configuration option, use the command:

aicommits config get <key>

Setting a configuration value

To set a configuration option, use the command:

aicommits config set <key>=<value>

Options

apiKey

Required for OpenAI and Anthropic providers

The API key needed for your provider.

baseUrl

Required

The base URL for your AI provider's API. Default values:

• OpenAI: https://api.openai.com/v1
• Ollama: http://localhost:11434
• Anthropic: https://api.anthropic.com

profile

Default: default

The configuration profile to use. This allows you to maintain different configurations for different projects or environments. You can switch between profiles using the --profile flag:

aicommits --profile development

To set a configuration value for a specific profile:

aicommits config set apiKey <key> --profile development

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.

model

Required

The model to use for generating commit messages. The available models depend on your chosen provider:

• OpenAI: Various GPT models (e.g., gpt-4.1, gpt-4o)
• Ollama: Local models you have pulled (e.g., llama4, mistral)
• Anthropic: Claude models (e.g., claude-3-7-sonnet-20250219)

max-length

The maximum character length of the generated commit message.

Default: 50

aicommits config set maxLength 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:

aicommits config set type conventional

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

aicommits 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.

Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI.

Maintainers

• Luca Becker: @lucavb
• Hassan El Mghari: @Nutlope
• Hiroki Osame: @privatenumber

Contributing

If you want to help fix a bug or implement a feature in Issues, checkout the Contribution Guide to learn how to setup and test the project

Support & Links

• Documentation
• Report Issues
• NPM Package
• License