README.md

gitmsg

CLI that generates Conventional Commit messages from your staged diff. The full git commit command is copied to your clipboard.

Conventional Commits

Commit messages follow this format:

<type>(<scope>): <description>

Types: feat, fix, chore, refactor, wip, docs. Scope is optional and describes what was affected.

# Examples:
feat(auth): add OAuth2 login support
fix: prevent crash on empty config file

Prerequisites

• Git and uv
• Python 3.13+
• A Groq API key

  export GROQ_API_KEY="your-api-key-here"

Installation

git clone https://github.com/edvardwd/gitmsg.git
cd gitmsg
uv tool install .

Usage

Stage your changes, then run:

git add <files>
gitmsg              # let the LLM choose the type
gitmsg <type>       # force a specific type

Options:

• --scope — include a scope: feat(api): ...
• --msg-ctx — pass extra context: --msg-ctx "fixes login bug from QA"

Shell Completions

gitmsg --install-completion

This auto-detects your shell (bash, zsh, fish) and installs completions for subcommands and options.