1-
2-
31<div align =" center " >
42 <a href="https://plugins.jetbrains.com/plugin/21335-ai-commits">
53 <img src="./src/main/resources/META-INF/pluginIcon.svg" width="200" height="200" alt="logo"/>
2523[ // ] : # ( - [Demo]( ; #demo) ; )
2624
2725## Description
28- AI Commits is a plugin that generates your commit messages with AI. To get started,
29- install the plugin and set OpenAI private token in plugin's settings:
30- <kbd >Settings</kbd > > <kbd >Tools</kbd > > <kbd >AI Commits</kbd >
26+
27+ AI Commits is a plugin that generates your commit messages by using git diff and OpenAI. To get started, install the
28+ plugin and set OpenAI private token in plugin's settings: <kbd >Settings</kbd > > <kbd >Tools</kbd > > <kbd >AI Commits</kbd >
3129
3230## Features
31+
3332- Generate commit message from diff using OpenAI API
3433- Compute diff only from the selected files and lines in the commit dialog
3534- Create your own prompt for commit message generation
3635- Choose any of the models available in OpenAI API
3736- Set OpenAI network proxy
37+ - Set custom OpenAI compatible API endpoint
3838
3939## Demo
40+
4041![ demo.gif] ( ./screenshots/plugin.gif )
4142
4243## Compatibility
43- IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, GoLand, DataGrip, Rider, MPS, Android Studio, DataSpell, Code With Me
44+
45+ IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, GoLand, DataGrip, Rider, MPS, Android Studio,
46+ DataSpell, Code With Me
4447
4548## Install
4649
@@ -50,19 +53,23 @@ IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, GoLand, Da
5053
5154Or you could install it inside your IDE:
5255
53- For Windows & Linux: <kbd >File</kbd > > <kbd >Settings</kbd > > <kbd >Plugins</kbd > > <kbd >Marketplace</kbd > > <kbd >Search for "AI Commits"</kbd > > <kbd >Install Plugin</kbd > > <kbd >Restart IntelliJ IDEA</kbd >
54-
55- For Mac: <kbd >IntelliJ IDEA</kbd > > <kbd >Preferences</kbd > > <kbd >Plugins</kbd > > <kbd >Marketplace</kbd > > <kbd >Search for "AI Commits"</kbd > > <kbd >Install Plugin</kbd > > <kbd >Restart IntelliJ IDEA</kbd >
56+ For Windows & Linux: <kbd >File</kbd > > <kbd >Settings</kbd > > <kbd >Plugins</kbd > > <kbd >Marketplace</kbd > > <kbd >Search
57+ for "AI Commits"</kbd > > <kbd >Install Plugin</kbd > > <kbd >Restart IntelliJ IDEA</kbd >
5658
59+ For Mac: <kbd >IntelliJ IDEA</kbd > > <kbd >Preferences</kbd > > <kbd >Plugins</kbd > > <kbd >Marketplace</kbd > > <kbd >Search
60+ for "AI Commits"</kbd > > <kbd >Install Plugin</kbd > > <kbd >Restart IntelliJ IDEA</kbd >
5761
5862### Installation from zip
63+
59641 . Download zip from [ releases] ( https://github.com/Blarc/ai-commits-intellij-plugin/releases )
60- 2 . Import to IntelliJ: <kbd >Settings</kbd > > <kbd >Plugins</kbd > > <kbd >Cog</kbd > > <kbd >Install plugin from disk...</kbd >
65+ 2 . Import to IntelliJ: <kbd >Settings</kbd > > <kbd >Plugins</kbd > > <kbd >Cog</kbd > > <kbd >Install plugin from
66+ disk...</kbd >
61673 . Set OpenAI private token in plugin's settings: <kbd >Settings</kbd > > <kbd >Tools</kbd > > <kbd >AI Commits</kbd >
6268
6369[ // ] : # ( ## Demo )
6470
6571[ // ] : # ( )
72+
6673[ // ] : # (  ; )
6774
6875## Support
0 commit comments