waxmard-git-ai 5.0.0

Provider-agnostic prompt/styling toolkit for LLM-powered git workflow tools (commit messages, MR descriptions)

git-ai

LLM-powered git workflow tools. Generate commit messages and PR titles using explicit auth methods and model IDs from the CLI, Lazygit, and other git environments that expose normal Git state.

Install

npm install -g @waxmard/git-ai

Or clone and symlink for local development:

make install   # symlinks to ~/.local/bin and ~/.local/lib; edits are live
make uninstall

Prerequisites

At least one auth method must be available:

Auth Method	Runtime	Auth
vertex-gemini	curl + python3 + gcloud	Google ADC / Vertex credentials
vertex-anthropic	curl + python3 + gcloud	Google ADC / Vertex credentials

Vertex AI support is limited to Gemini (vertex-gemini) and Anthropic (vertex-anthropic) model families. Other publishers available on Vertex (Meta Llama, Mistral, etc.) are not yet supported.

| gemini-api | Gemini CLI | GEMINI_API_KEY or system keychain | | claude-code | Claude Code CLI | Claude Code CLI session | | anthropic-api | curl + python3 | ANTHROPIC_API_KEY | | codex | Codex CLI | Codex CLI session | | openai-api | curl + python3 | OPENAI_API_KEY |

anthropic-api and openai-api require curl and python3, both standard on macOS and most Linux systems.

Gemini API auth

git-ai tries these in order until one succeeds:

1. GEMINI_API_KEY environment variable
2. System keychain — store the key as gemini-api-key:
   • macOS: security add-generic-password -s gemini-api-key -a "$USER" -w YOUR_KEY
   • GNOME / libsecret: secret-tool store --label="Gemini API Key" service gemini-api-key
   • pass: pass insert gemini-api-key
   • KDE Wallet: kwallet-query kdewallet -w gemini-api-key
3. Google Application Default Credentials (ADC):
   • gcloud auth application-default login
   • or set GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json

Commands

Both git-ai and aigit work identically — use whichever you prefer.

commit

Generate a commit message from staged changes.

git-ai commit [auth-method] [model-id]

• Reads git diff --staged and produces a Conventional Commits message
• Includes a description body for non-trivial changes
• No default auth method on a fresh repo; choose one explicitly
• All auth methods default to a lightweight model when model-id is omitted
• Pass last as the provider to reuse the previously generated message

pr

Generate a PR title and body from the current branch.

git-ai pr [auth-method] [model-id] [--base <branch>] [--fresh] [--from-sha <commit>]
git-ai mr [...]   # alias for pr

• Reads the commit log and diff against the base branch
• Produces a Conventional Commits title + markdown body with a ### Test Plan section
• Auto-detects the base branch from the remote default (falls back to main)
• Use --base to override (e.g. --base dev)
• Saves the generated output per current-branch/base-branch pair under .git/pr-cache/; subsequent runs with the same pair refine the previous result automatically
• Use --fresh to ignore the saved output and regenerate from scratch
• Use --from-sha to override the saved HEAD and regenerate only from commits after a specific prior generated commit
• No default auth method on a fresh repo; choose one explicitly
• All auth methods default to a stronger model when model-id is omitted

options

List every auth-method / model combo as a flat pipe-delimited list, LRU-sorted. Primary input for the fzf-based Lazygit integration; also useful for custom pickers.

git-ai options [commit|pr]

• Emits one provider:model|<label> line per selectable combo
• For commit, also emits last|reuse saved message when a saved message exists
• Most-recent picks (from .git/{tool}-choice-history) float to the top; remaining combos follow in default order
• git-ai commit <provider:model> and git-ai pr <provider:model> accept the emitted value directly

providers / models

List available auth methods and models, ordered by last-used. Kept for scripting and as a fallback when options isn't a fit.

last is only a commit provider option; PR refinement reuses cached prior output automatically.

git-ai providers [commit|pr]
git-ai models <auth-method> [commit|pr]

Python library

git-ai is also distributed as a Python package (waxmard-git-ai) so other tools can reuse the same commit-message and MR-description generation without shelling out.

pip install waxmard-git-ai
# or: uv add waxmard-git-ai

The Python package is provider-agnostic: it owns prompt assembly, diff-stat derivation, fence-stripping, and cache management, but not the LLM call. Consumers pass a generate: Callable[[str, str], str] that takes (system_prompt, user_input) and returns raw model text. Bring your own Claude / Gemini / OpenAI / anything.

generate_mr_description handles both repo-mode and data-mode through one entry point and returns an MrDescription(text, diff) — text is the full PR, diff is a marker-style rendering of what changed vs. existing_pr (or None when there's no prior PR or the output matches it).

Bring-your-own provider — example with the Google Gemini SDK:

from google import genai
from google.genai import types
from git_ai import generate_mr_description

client = genai.Client()

def generate(system_prompt: str, user_input: str) -> str:
    resp = client.models.generate_content(
        model="gemini-3.1-pro-preview",
        contents=user_input,
        config=types.GenerateContentConfig(system_instruction=system_prompt),
    )
    return resp.text or ""

Swap the body for anthropic, openai, vertexai, or any other SDK — git_ai never imports them.

Repo-mode (reads staged diff / base..HEAD from a local checkout):

from git_ai import generate_commit_message, generate_mr_description

msg = generate_commit_message(".", generate=generate)
pr = generate_mr_description(".", base_branch="main", generate=generate)
pr = generate_mr_description(".", base_branch="main", fresh=True, generate=generate)
pr = generate_mr_description(
    ".",
    base_branch="main",
    existing_pr=existing_pr_text,
    previous_head_sha=last_generated_head_sha,
    generate=generate,
)
print(pr.text)       # full PR (title line + body)
print(pr.diff or "") # marker-style delta vs existing_pr, if any

Data-mode (no local checkout required — pass raw diff strings, e.g. fetched from the GitHub/GitLab API):

from git_ai import (
    format_commit_log,
    generate_commit_message_from_diff,
    generate_mr_description,
)

commit_msg = generate_commit_message_from_diff(diff_text, generate=generate)

log = format_commit_log((c.title, c.message) for c in mr_commits)
pr = generate_mr_description(
    diff=diff_text,
    commit_log=log,
    existing_pr=current_pr_body or None,
    generate=generate,
)
# pr.text -> full updated PR to post as title + description
# pr.diff -> compact "what changed since last PR" markers, or None

diff_stat and release_context are optional — when omitted, the diff-stat is derived from the diff and a generic "no release tags found" context is used. Model selection, retries, auth, and error handling are the consumer's responsibility (inside generate).

Repo-mode uses the same incremental PR efficiency path as the CLI: it reuses .git/pr-cache/ automatically, returns the cached PR unchanged when HEAD has not advanced, and narrows generation to commits after the last generated HEAD when possible. Pass fresh=True to disable that behavior for one call, or previous_head_sha= to override the cached incremental base explicitly.

Data-mode is stateless by design. To get the same efficiency in remote consumers, persist the prior PR text and prior generated head SHA yourself, fetch only the incremental diff/log since that SHA from your SCM, then call generate_mr_description(diff=..., existing_pr=..., generate=...).

Excluding noisy files (.git-ai-ignore)

Lockfiles and other generated artifacts can dominate a diff and push it past the LLM provider's input cap. git-ai always excludes the following filenames from git diff --staged (commit) and git diff base...HEAD (pr):

package-lock.json    yarn.lock         pnpm-lock.yaml      npm-shrinkwrap.json
Gemfile.lock         Cargo.lock        go.sum              poetry.lock
uv.lock              composer.lock     Pipfile.lock        pubspec.lock
mix.lock             flake.lock

Drop a .git-ai-ignore file at the repo root to add more patterns (one per line, # comments and blank lines ignored). Patterns are Git pathspec glob fragments that git-ai prefixes with **/, so generated/**/*.ts matches TypeScript files under any generated/ directory; leading / is not .gitignore root syntax. Lines starting with ! re-include a pattern, useful when you actually want to review a built-in default:

build/dist.js
generated/**/*.ts

# Re-include this lockfile when you want to review it
!package-lock.json

If the post-exclude diff is still over GIT_AI_MAX_DIFF_BYTES (default 900000, set 0 to disable), git-ai aborts with a "Largest changed files" hint pointing at what to ignore or unstage.

Narrowing the picker list

By default git-ai options enumerates every supported provider/model combo. Most users only have access to a couple. To restrict the picker to just the providers and models you actually use, drop a config file at $XDG_CONFIG_HOME/git-ai/options.conf (usually ~/.config/git-ai/options.conf):

[claude-code]
claude-haiku-4-5-20251001
claude-sonnet-4-6

[codex]
gpt-5.4-mini

# Empty sections hide these providers entirely
[vertex-gemini]

[vertex-anthropic]

• [provider] headers must be one of: vertex-gemini, vertex-anthropic, gemini-api, claude-code, anthropic-api, codex, openai-api. Unknown headers are silently dropped.
• Model IDs under a header are passed through to the provider verbatim, so you can list future model IDs (e.g. a newly released claude-sonnet-5-0) without waiting for a git-ai release.
• Delete the file to restore the full shipped catalog.
• See examples/options.conf for a starter.

Terminal picker

Running git-ai commit or git-ai pr without a provider argument launches an inline fzf picker over the same provider/model combos Lazygit uses. History entries float to the top. Pass provider or provider:model to skip the picker. Flags still parse, so git-ai pr --base staging opens the picker then runs against the chosen base.

Set GIT_AI_NO_FZF=1 (or pipe stdout) to disable the picker for scripting. If fzf isn't installed, the tools fall back to the last saved choice.

Lazygit integration

Requires fzf on your PATH. Add the following under customCommands: in ~/.config/lazygit/config.yml:

customCommands:
  - key: "<c-g>"
    description: "AI commit message (git-ai + fzf)"
    context: "files"
    command: |
      choice=$(git-ai options commit | fzf --delimiter='|' --with-nth=2 --no-sort --tiebreak=index --prompt='git-ai> ') || exit 0
      git commit -m "$(git-ai commit "${choice%%|*}")" --edit
    output: terminal

Pressing <c-g> in the files panel opens an fzf picker showing every auth+model combo (plus reuse saved message when available). Typeahead narrows instantly; Enter commits with the generated message. Selections float to the top of the list on subsequent invocations.

Compatibility

git-ai does not depend on a specific terminal UI. It works in the CLI, in Lazygit, and in similar git environments as long as Git exposes the required repository state:

• git-ai commit needs staged changes (git diff --staged)
• git-ai pr needs commits and diff data relative to a base branch