git-commit-message 0.6.0

Generate Git commit messages from staged changes using OpenAI GPT

git-commit-message

Staged changes -> GPT commit message generator.

Install (PyPI)

Install the latest released version from PyPI:

# User environment (recommended)
python -m pip install --user git-commit-message

# Or system/virtualenv as appropriate
python -m pip install git-commit-message

# Or with pipx for isolated CLI installs
pipx install git-commit-message

# Upgrade to the newest version
python -m pip install --upgrade git-commit-message

Quick check:

git-commit-message --help

Set your API key (POSIX sh):

export OPENAI_API_KEY="sk-..."

Note (fish): In fish, set it as follows.

set -x OPENAI_API_KEY "sk-..."

Install (editable)

python -m pip install -e .

Usage

• Print commit message only:

git add -A
git-commit-message "optional extra context about the change"

• Force single-line subject only:

git-commit-message --one-line "optional context"

• Limit subject length (default 72):

git-commit-message --one-line --max-length 50 "optional context"

• Chunk long diffs by token budget (0 = single chunk + summary, -1 = disable chunking):

# force a single summary pass over the whole diff (default)
git-commit-message --chunk-tokens 0 "optional context"

# chunk the diff into ~4000-token pieces before summarising
git-commit-message --chunk-tokens 4000 "optional context"

# disable summarisation and use the legacy one-shot prompt
git-commit-message --chunk-tokens -1 "optional context"

• Commit immediately with editor:

git-commit-message --commit --edit "refactor parser for speed"

• Select output language/locale (default: en-GB):

# American English
git-commit-message --language en-US "optional context"

# Korean
git-commit-message --language ko-KR

# Japanese
git-commit-message --language ja-JP

Notes:

• The model is instructed to write using the selected language/locale.
• In multi-line mode, the only allowed label ("Rationale:") is also translated into the target language.

Environment:

• OPENAI_API_KEY: required
• GIT_COMMIT_MESSAGE_MODEL or OPENAI_MODEL: optional (default: gpt-5-mini)
• GIT_COMMIT_MESSAGE_LANGUAGE: optional (default: en-GB)
• GIT_COMMIT_MESSAGE_CHUNK_TOKENS: optional token budget per diff chunk (default: 0 = single chunk + summary; -1 disables summarisation)

AI‑generated code notice

Parts of this project were created with assistance from AI tools (e.g. large language models). All AI‑assisted contributions were reviewed and adapted by maintainers before inclusion. If you need provenance for specific changes, please refer to the Git history and commit messages.