Commit AI - Pieces for Developers is a Visual Studio Code extension that uses the Pieces for Developers to enhance the code commit process.
Configuration
To use Commit Pieces for Developers AI, you need to install Pieces for Developers. Follow these steps:
- You don't need any API key to use Commit Pieces for Developers.
- Click on the Sparkle icon in the Source Control icon in the VS Code toolbar for use it.
- Open the VS Code settings (File > Preferences > Settings).
- Search for "Commit Pieces for Developers" in the settings to customize it.
- Enjoy!
Features
- Automatic generation of commit messages based on modified code.
- Code analysis for improvement suggestions before committing.
- Seamless integration with Git workflow in VS Code.
- Ability to translate commit messages into multiple languages.
Usage
- Make your code changes as usual.
- When you're ready to commit, use icon "Sparkle" in the Source Control toolbar or you can use the
Commit AI - Pieces for Developers: Create Commit"
command from the command palette CTRL+SHIFT+P
or CMD+SHIFT+P
.
- The extension will generate a commit message based on your changes.
- Review and modify the message if necessary, then proceed with the commit.
Get Models
- Go to settings -> Search for "Commit AI - Pieces for Developers" -> Model
- Click on link "Get Pieces for Developers Models"
OR
CTRL+SHIFT+P
or CMD+SHIFT+P
- Type "Get Pieces for Developers Models"
Settings
This extension contributes the following settings:
- Model: You can select the model from the plugin configuration (Cloud or Local):
Local Models
For local models, actually you need to download the model from the Pieces for Developers app. Automatically the extension will check if the model is downloaded and if not.
Models |
Provider |
Type |
claude-3-5-sonnet |
Anthropic |
Cloud |
claude-3-haiku |
Anthropic |
Cloud |
claude-3-opus |
Anthropic
|
Cloud |
claude-3-sonnet |
Anthropic |
Cloud |
chat-bison |
Google |
Cloud |
codechat-bison |
Google |
Cloud |
gemini-1.5-flash |
Google |
Cloud |
gemini-1.5-pro |
Google |
Cloud |
gemini-pro |
Google |
Cloud |
gpt-3.5-turbo |
OpenAI |
Cloud |
gpt-3.5-turbo-16k |
OpenAI |
Cloud |
gpt-4 |
OpenAI |
Cloud |
gpt-4-turbo |
OpenAI |
Cloud |
gpt-4o |
OpenAI |
Cloud |
gpt-4o-mini |
OpenAI |
Cloud |
Use Emojis: It allows you to enable or disable the use of emojis in commit messages.
Custom Emojis: It allows you to write down the emojis you want to use in the next template object in the VSCode config.json.
"commit-pieces-ai.commitEmojis": {
"feat": "✨",
"fix": "🐛",
"docs": "📝",
"style": "💎",
"refactor": "♻️",
"test": "🧪",
"chore": "📦",
"revert": "⏪"
}
Custom Summary Prompt: The prompt that will be used to generate the summary of all git diff.
Custom Commit Prompt: The prompt that will be used to generate the commit message.
Use Description: It allows you to enable or disable the use of commit description.
Number of characters: It allows you to select the number of characters for the commit message.
Commit Language: It allows you to select the language for the commit message translation.
Languages |
🇬🇧 English |
🇨🇳 Mandarin Chinese |
🇮🇳 Hindi |
🇪🇸 Spanish |
🇫🇷 French |
🇮🇹 Italian |
🇸🇦 Arabic |
🇧🇩 Bengali |
🇷🇺 Russian |
🇵🇹 Portuguese |
🇯🇵 Japanese |
Force Commit Lowercase: It allows you to enable or disable the lowercase of the commit message.
Force Commit Without dot at the end: It allows you to enable or disable the commit message without dot at the end.
Known Issues
There are currently no known issues. If you encounter any problems, please open an issue on our GitHub repository.
Note
This extension is a community project and not officially supported by Pieces for Developers team.
Happy coding with Commit AI - Pieces for Developers!