commit-msg

module
v1.0.2 Latest Latest
Warning

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

Go to latest
Published: Mar 11, 2025 License: MIT

README

commit-msg

commit-msg is a command-line tool that generates commit messages using LLM. It is designed to help developers create clear and concise commit messages for their Git repositories. - btw i accept this from auto-complete

Screenshot

Below is a sample execution of commit-msg:

Commit-msg Screenshot

Before running the application, ensure you have set the system environment variables. and add commit.exe to path variables (same for linux macOS)

You can Use Gemini or Grok as the LLM to Generate Commit Messages

Add COMMIT_LLM value are gemini or grok
Add GROK_API_KEY to System Variables (if use grok)
Add GEMINI_API_KEY to System Variables (if use gemini)

Setup

Download the latest release and set the in the path variables then you can use commit . in any git repo

To set up commit-msg, run the following command: (Use the you git repo path)

go run src/main.go .

Usage

To run commit-msg, use: (Use the you git repo path)

go run src/main.go .

This will execute commit-msg in the current directory:

go run src/main.go .

Download

To download the latest release of commit-msg, visit the GitHub Releases page and follow the installation instructions for your platform.

Directories

Path Synopsis
src

Jump to

Keyboard shortcuts

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