easycommit

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2025 License: MIT Imports: 1 Imported by: 0

README

🚀 EasyCommit

image

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.

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.
Now you can choose between OpenAI and Gemini.

# 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.

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:

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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
ai
git

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL