Metadata-Version: 2.4
Name: git-commit-message
Version: 0.7.0
Summary: Generate Git commit messages from staged changes using LLM
Maintainer-email: Mina Her <minacle@live.com>
License: This is free and unencumbered software released into the public domain.
        
        Anyone is free to copy, modify, publish, use, compile, sell, or
        distribute this software, either in source code form or as a compiled
        binary, for any purpose, commercial or non-commercial, and by any
        means.
        
        In jurisdictions that recognize copyright laws, the author or authors
        of this software dedicate any and all copyright interest in the
        software to the public domain. We make this dedication for the benefit
        of the public at large and to the detriment of our heirs and
        successors. We intend this dedication to be an overt act of
        relinquishment in perpetuity of all present and future rights to this
        software under copyright law.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
        IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
        OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
        ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
        OTHER DEALINGS IN THE SOFTWARE.
        
        For more information, please refer to <https://unlicense.org/>
        
Project-URL: Homepage, https://github.com/minacle/git-commit-message
Project-URL: Repository, https://github.com/minacle/git-commit-message
Project-URL: Issues, https://github.com/minacle/git-commit-message/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.13
Description-Content-Type: text/markdown
Requires-Dist: babel>=2.17.0
Requires-Dist: google-genai>=1.56.0
Requires-Dist: openai>=2.6.1
Requires-Dist: tiktoken>=0.12.0

# git-commit-message

Staged changes -> GPT commit message generator.

[![asciicast](https://asciinema.org/a/jk0phFqNnc5vaCiIZEYBwZOyN.svg)](https://asciinema.org/a/jk0phFqNnc5vaCiIZEYBwZOyN)

## Install (PyPI)

Install the latest released version from PyPI:

```sh
# 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:

```sh
git-commit-message --help
```

Set your API key (POSIX sh):

```sh
export OPENAI_API_KEY="sk-..."
```

Or for the Google provider:

```sh
export GOOGLE_API_KEY="..."
```

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

```fish
set -x OPENAI_API_KEY "sk-..."
```

## Install (editable)

```sh
python -m pip install -e .
```

## Usage

- Print commit message only:

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

- Force single-line subject only:

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

- Select provider (default: openai):

```sh
git-commit-message --provider openai "optional context"
```

- Select provider (Google Gemini via google-genai):

```sh
git-commit-message --provider google "optional context"
```

- Limit subject length (default 72):

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

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

```sh
# 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:

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

- Print debug info (prompt/response + token usage):

```sh
git-commit-message --debug "optional context"
```

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

```sh
# 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 when provider is `openai`
- `GOOGLE_API_KEY`: required when provider is `google`
- `GIT_COMMIT_MESSAGE_PROVIDER`: optional (default: `openai`). `--provider` overrides this value.
- `GIT_COMMIT_MESSAGE_MODEL`: optional model override (defaults: `openai` -> `gpt-5-mini`, `google` -> `gemini-2.5-flash`)
- `OPENAI_MODEL`: optional OpenAI-only model override
- `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)

Notes:

- If token counting fails for your provider while chunking, try `--chunk-tokens 0` (default) or `--chunk-tokens -1`.

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