aicommit

aicommit is a tool that generates git commit messages using OpenAI's GPT models. It supports multiple profiles, enabling different configurations for API keys, models, and system messages.

Features

• Generate Commit Messages: Automatically generate commit messages using OpenAI's GPT models.
• Multiple Profiles: Manage multiple profiles, each with its own API key, model, and system message.
• Interactive Message Review: Option to review and refine the commit message before committing.
• Profile Management: Commands to add, list, and switch profiles.

Installation

To install aicommit, use npm:

npm install -g aicommit

Usage

Adding and Managing Profiles

Add a New Profile

aicommit --add-profile <name>

List All Profiles

aicommit --list-profiles

Set the Active Profile

aicommit --set-active-profile <name>

Switch Profile Interactively

aicommit --switch-profile

Configuring Profiles

Set OpenAI API Key

aicommit --set-api-key YOUR_OPENAI_API_KEY

Set OpenAI Model

aicommit --set-model YOUR_CHOSEN_MODEL

Set OpenAI System Message

aicommit --set-system-message "Your custom system message"

Enable Commit Message Review

aicommit --enable-review

Disable Commit Message Review

aicommit --disable-review

Printing Profile Information

Print Current OpenAI API Key

aicommit --print-api-key

Print Current OpenAI Model

aicommit --print-model

Print Current OpenAI System Message

aicommit --print-system-message

Committing Changes

Simply run the command without any options to stage, generate a commit message, review (if enabled), commit, and push the changes.

aicommit

Example Workflow

1. Add a Profile:

   aicommit --add-profile myprofile

2. Set API Key:

   aicommit --set-api-key YOUR_OPENAI_API_KEY

3. Set Model:

   aicommit --set-model gpt-4o-mini

4. Set System Message:

   aicommit --set-system-message "You are a helpful assistant."

5. Enable/Disable Review:

   aicommit --enable-review

6. Generate and Commit Changes:

   aicommit

Contributing

Contributions are welcome! Please read the contributing guide to get started.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you have any questions or need help, feel free to open an issue on GitHub.

Acknowledgments

• OpenAI for providing the API.
• simple-git for making Git integration easy.
• commander for command-line argument parsing.
• @inquirer/prompts for the interactive prompts.