easycommit

🚀 EasyCommit

EasyCommit is a 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.
• Easy to Use: Just run easycommit after staging your changes.
• Customizable: You can set your own OpenAI API key.
• Supports Multiple Languages: Works with any programming language.

📦 Installation

Requires Go 1.20+ and Git.

go install github.com/GabrielChaves1/easycommit@latest

Or download the binary from Releases.

🛠️ Configuration Commands

Set the AI Agent

Configure which AI agent will be used to generate commit messages.
Currently, only OpenAI is supported.

easycommit config set-agent openai --api-key YOUR_OPENAI_API_KEY

openai: The AI provider to use. --api-key: Your OpenAI API key (required).

Set the Commit Message Language

Set the language in which commit messages will be generated. This affects the language of the commit message text, not the programming language.

easycommit config language en

en: The language code for the commit message.

• Replace en with your preferred language code (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:

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 file for details.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md for details on how to contribute to this project.