@negoziator/ai-commit v1.11.2

Table of Contents

• Features
• Setup
  • Installation
  • Upgrading
• Usage
  • CLI Mode
  • Git Hook Integration
• Configuration
  • Options
  • Project-Specific Configuration
• Maintainers
• Contributing

Features

• 🤖 AI-Powered Commits: Generates meaningful commit messages based on your code changes
• 🔄 Git Integration: Works seamlessly with your existing Git workflow
• 🪝 Git Hook Support: Can be installed as a Git hook for automatic message generation
• 🌐 Multiple Languages: Supports commit messages in different locales
• ⚙️ Customizable: Configure the AI model, message length, and other parameters
• 📝 Project Context: Add project-specific context to improve message relevance

Setup

A minimum of Node v20 is required. Check your Node.js version with node --version.

Installation

1. Install AI-Commit:

   npm install -g @negoziator/ai-commit

2. Retrieve your API key from OpenAI

   Note: This requires an OpenAI account. If you don't have one, you can sign up for a free trial.

3. Set the key so aicommit can use it:

   aicommit config set OPENAI_KEY=<your token>

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

Upgrading

npm update -g @negoziator/ai-commit

Usage

CLI Mode

Use aicommit directly to generate a commit message for your staged changes:

git add <files...>
aicommit

Example workflow:

$ git add .
$ aicommit
✓ Analyzing your changes...
✓ Generating commit message...

AI-generated commit message:
feat: add project-specific configuration support via .ai-commit.json

? Use this message? › (Y/n)

Git Hook Integration

You can set up AI-Commit as a Git hook to automatically generate commit messages:

# Install the prepare-commit-msg hook
aicommit hook install

This will add a Git hook that automatically suggests commit messages when you run git commit.

To uninstall the hook:

aicommit hook uninstall

Configuration

Manage configuration using the aicommit config command.

To get a configuration option value, use the command:

aicommit config get <key>

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

aicommit config get OPENAI_KEY
> sk_1234567890

To set a configuration option, use the command:

aicommit config set <key>=<value>

Options

Project-Specific Configuration

You can add a .ai-commit.json file in the root of your project to provide additional context about your project to the AI and to override global configuration settings for the specific project.

Example .ai-commit.json:

{
  "projectPrompt": "This is a Node.js CLI tool that uses OpenAI to generate meaningful git commit messages.",
  "model": "gpt-4",
  "locale": "en",
  "max-length": "100",
  "temperature": "0.5",
  "max-completion-tokens": "5000"
}

The .ai-commit.json file can contain any of the configuration options listed in the Options section. Values set in this file will take precedence over the global configuration.

The projectPrompt field should contain a brief description of your project, its purpose, and any other relevant information that would help the AI understand the context of your code changes.

Maintainers

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.