Overview of AI Commits
AI Commits is an innovative plugin designed for those using IntelliJ-based IDEs and Android Studio. This tool is perfect for developers who want to streamline their workflow by generating meaningful commit messages with minimal effort. The plugin leverages the power of git diff and Large Language Models (LLMs) to create commit messages.
Key Features
-
Intelligent Commit Message Generation: AI Commits uses git diff and LLMs to generate accurate and relevant commit messages automatically. This minimizes the time developers spend writing messages manually.
-
Selective Diff Analysis: The plugin allows users to compute diffs from selected files and lines in the commit dialog. This feature provides greater control over the content included in commit messages.
-
Customizable Prompts: Users can create their own prompts for commit message generation. By using predefined variables and hints, developers can customize these prompts to better fit their particular project needs.
Supported Models
AI Commits supports an array of LLMs, enhancing its versatility and utility. The supported models include:
- Anthropic
- Azure Open AI
- Gemini
- Hugging Face
- Open AI
- Ollama
- Qianfan (Ernie)
The plugin is implemented in a generic way and relies on langchain4j for creating LLM API clients. This means users can easily request other models supported by langchain4j if they aren't already included.
Compatibility
AI Commits is compatible with a wide range of IntelliJ-based IDEs, including:
- IntelliJ IDEA
- PhpStorm
- WebStorm
- PyCharm
- RubyMine
- AppCode
- CLion
- GoLand
- DataGrip
- Rider
- MPS
- Android Studio
- DataSpell
- Code With Me
Installation Guide
Direct Installation
To install AI Commits directly from the marketplace, follow these steps:
-
For Windows & Linux: Navigate to File > Settings > Plugins > Marketplace, search for "AI Commits", install the plugin, and restart IntelliJ IDEA.
-
For Mac: Go to IntelliJ IDEA > Preferences > Plugins > Marketplace, search for "AI Commits", install, and restart IntelliJ IDEA.
Installation from Zip
- Download the zip file from the plugin's releases page.
- Import it into IntelliJ: Go to Settings > Plugins > Cog > Install plugin from disk....
- Set the LLM client configuration in the plugin's settings: Settings > Tools > AI Commits.
Support and Contributions
To support AI Commits, users are encouraged to star the repository, rate the plugin, and share it with others. They can also contribute financially through platforms like Ko-fi or GitHub Sponsorships. Detailed contribution instructions can be found in the CONTRIBUTING guide.
Recognition
AI Commits draws inspiration from Nutlope's AICommits and uses openai-kotlin for the OpenAI API client and langchain4j for the LLM API clients.
For the latest updates and changes, users are advised to check the CHANGELOG.
AI Commits stands as a powerful tool for developers aiming to integrate AI capabilities into their development workflows, simplifying the task of writing commit messages with intelligent automation.