https://github.com/gabrielchaves1/easycommit
a Go CLI tool that uses AI to generate concise, descriptive, and conventional Git commit messages
https://github.com/gabrielchaves1/easycommit
ai cli git golang open-source
Last synced: about 1 year ago
JSON representation
a Go CLI tool that uses AI to generate concise, descriptive, and conventional Git commit messages
- Host: GitHub
- URL: https://github.com/gabrielchaves1/easycommit
- Owner: GabrielChaves1
- License: mit
- Created: 2025-05-06T23:07:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-07T01:11:08.000Z (about 1 year ago)
- Last Synced: 2025-05-07T01:37:00.687Z (about 1 year ago)
- Topics: ai, cli, git, golang, open-source
- Language: Go
- Homepage:
- Size: 24.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🚀 EasyCommit
**EasyCommit** is a Golang command-line tool that uses AI to generate concise, descriptive, and conventional Git commit messages for you, you just need to run a single command `easycommit` after staging your changes.
## 📜 Features
- **AI-Powered**: Uses OpenAI to generate commit messages.
- **Multi-Agent Support**: Choose between multiple AI agents to generate commit messages.
- **Easy to Use**: Just run `easycommit` after staging your changes.
- **Supports Multiple Languages**: Works with any programming language.
## 📦 Installation
Requires Go 1.20+ and Git.
```bash
go install github.com/GabrielChaves1/easycommit@latest
```
Or download the binary from [Releases](https://github.com/GabrielChaves1/easycommit/releases).
## 🛠️ Configuration Commands
### Set the AI Agent
Configure which AI agent will be used to generate commit messages.
Now you can choose between OpenAI and Gemini.
```bash
# Set the AI agent to OpenAI
easycommit config set-agent openai --api-key YOUR_OPENAI_API_KEY
# Set the AI agent to Gemini
easycommit config set-agent gemini --api-key YOUR_GEMINI_API_KEY
```
### Set the Commit Message Language
Set the language in which commit messages will be generated.
```bash
easycommit config language en
```
**en**: The language for the commit message.
- Replace en with your preferred language (e.g., pt for Portuguese, es for Spanish, etc).
You can change this at any time to generate commit messages in a different language.
## 🖥️ Example Workflow
Generate a commit message:
```bash
easycommit config set-agent openai --api-key YOUR_OPENAI_API_KEY
easycommit config language en
git add .
easycommit
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please read the [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on how to contribute to this project.