Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ali-hv/comsu
A CLI tool for generating commit messages using Google Generative AI
https://github.com/ali-hv/comsu
ai bash commit gemini generative-ai git google
Last synced: 7 days ago
JSON representation
A CLI tool for generating commit messages using Google Generative AI
- Host: GitHub
- URL: https://github.com/ali-hv/comsu
- Owner: ali-hv
- License: gpl-3.0
- Created: 2024-09-02T09:11:35.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-22T08:40:55.000Z (16 days ago)
- Last Synced: 2024-10-23T12:43:39.605Z (15 days ago)
- Topics: ai, bash, commit, gemini, generative-ai, git, google
- Language: PowerShell
- Homepage:
- Size: 377 KB
- Stars: 67
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🚀 AI-Powered(wrapper) Commit Message Generator
**Comsu** is a simple yet powerful command-line tool that leverages Google Generative AI to suggest high-quality, concise commit messages based on your staged changes in Git. Automate the process of writing meaningful commit messages and ensure consistency across your project.
---
## Table of Contents
* [Features](#-features)
* [Installation](#-installation)
* [Usage](#-usage)
* [Contributing](#-contributing)
* [Show your support](#-show-your-support)
---
## 🌟 Features
- **Automated Commit Messages**: Generate commit messages based on your staged changes using Google's AI model.
- **Auto Commit**: It can automatically commit your changes with your selected commit message.
- **Supports Conventional Commit Types**: Suggestions follow the standard commit types (`feat`, `fix`, `build`, `chore`, etc.).
- **Easy Setup**: One-command installation to get started.
- **Customizable Prompts**: Modify the prompt file to tailor the AI suggestions to your specific project needs.
---
## 📦 Installation
Linux
To set up **Comsu** on your Linux system, follow these steps:
1. **Clone the Repository**:
```bash
git clone https://github.com/ali-hv/comsu.git
cd comsu
```
2. **Run the Installation Script**:
```bash
chmod +x install.sh
sudo ./install.sh
```
3. **Set Your API Key**:
Make sure you have your Google AI Studio API key set as an environment variable. If you don’t have one, you can create a free API key [here](https://aistudio.google.com/app/apikey).
```bash
export GOOGLE_AI_STUDIO_API_KEY="your_api_key_here"
```
You can add this line to your `~/.bashrc` or `~/.zshrc` to make it persistent.
Windows
To set up **Comsu** on your Windows system, follow these steps:
1. **Clone the Repository**:
open powershell as administrator, then write these commands:
```powershell
git clone https://github.com/ali-hv/comsu.git
cd comsu
```
3. **Run the Installation Script**:
```powershell
powershell -ExecutionPolicy Bypass -File install.ps1
```
4. **Set Your API Key**:
Make sure you have your Google AI Studio API key set as an environment variable. If you don’t have one, you can create a free API key [here](https://aistudio.google.com/app/apikey).
```powershell
set GOOGLE_AI_STUDIO_API_KEY=your_api_key_here
```
You can add this line to your $PATH to make it persistent.
---
## 🚀 Usage
Once installed, you can run **Comsu** from any directory where you have staged changes:
Linux
```bash
git comsu
```
Windows
Run this in the cmd:
```cmd
git-comsu
```
**If you live in countries restricted by Google, you may want to use a VPN or change your DNS.**
This will generate a list of suggested commit messages based on your changes and you can choose the message you want, then it will automatically commit your changes with that message. If you don't like any of the messages, you can type 'x' to exit.
**Example**
```bash
git add .
git comsu
```
**Output**:
```
Generating the commit messages based on your changes ...
1. ref: Refactor the send_email function for efficiency
2. ref: Update the send_email to reduce processing time
3. feat: Use new method for getting the changes in send_email
Write the message number you want to use (write 'x' to exit): 1
[main 6b25961] ref: Refactor the send_email function for efficiency
1 file changed, 1 deletion(-)
Committed successfully.
```
---
## ⚙️ Configuration
The prompt used to generate the commit messages is stored in a file named prompt located at /usr/local/share/git-comsu/prompt. You can modify this file to change the way AI generates the commit messages.
---
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
1. Fork the repository.
2. Create your feature branch (git checkout -b feature/new-feature).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/new-feature).
5. Open a Pull Request.
---
## 🌟 Show your support
If you find this tool helpful, please give a ⭐ to the repository!