commit-ai

commit-ai is a CLI tool that automatically generates Git commit messages using AI, now with support for custom commit message templates.

Key Features

• Multiple commit message suggestions using AI
• Customizable message generation options
• Easy-to-use CLI interface
• Interactive commit message selection using arrow keys
• Visual progress indication for commit message generation and commit process
• Intelligent file filtering to exclude large files and specific file types (e.g., lock files)
• Improved handling of file paths, including support for relative paths and paths starting with '~'

Installation

You can install it globally using npm:

npm install -g @j-ho/commit-ai

Usage

Before using commit-ai, you need to set up your Anthropic API key:

commit-ai --key YOUR_API_KEY

To generate a commit message, simply run:

commit-ai

Options

• -k, --key <key>: Set Anthropic API key
• -m, --max-tokens <number>: Set max tokens for message generation (default: 300)
• -t, --temperature <number>: Set temperature for message generation (default: 0.7)
• -n, --number <number>: Number of commit message suggestions to generate (default: 3)
• --max-file-size <number>: Maximum file size in KB to include in diff (default: 100)

Example:

commit-ai -n 5 -m 400 -t 0.8 --max-file-size 200

How It Works

1. Analyzes staged changes in the current Git repository, filtering out large files and specific file types
2. Retrieves the Git commit template if available and requested
3. Uses AI to generate multiple commit message candidates (with visual progress indication)
4. Parses and processes the AI-generated commit messages
5. Displays the list of generated messages
6. Allows the user to select a message using arrow keys or cancel the commit
7. Performs the Git commit with the selected message (with visual progress indication)

Development

1. Clone the repository
2. Install dependencies: pnpm install
3. Build the project: pnpm build
4. Run tests: pnpm test

Dependencies

• @anthropic-ai/sdk: For interacting with the Anthropic AI API
• @inquirer/prompts: For interactive command-line user interfaces
• commander: For building the command-line interface
• configstore: For storing configuration data
• ora: For elegant terminal spinners

License

This project is licensed under the MIT License.

Contributing

We welcome all forms of contributions, including bug reports, feature suggestions, and pull requests. For major changes, please open an issue first to discuss what you would like to change.

Troubleshooting

If you encounter any issues with file paths or commit template detection, please ensure that:

1. Your Git commit template path is correctly set in your Git config
2. The commit template file exists and is readable
3. You're using the correct format option (-f template) when you want to use a Git commit template

For any other issues or questions, please open an issue on the GitHub repository.