Configuration Reference
This page describes environment variables
and CLI options for ai-prepare-commit-msg.
The hook reads only environment variables.
Set variables in the environment where the hook runs:
your shell,
pre-commit,
or CI.
Environment Variables
Core variables
| Variable |
Description |
LITELLM_PROXY_MODEL |
LiteLLM model ID for commit generation. |
LITELLM_PROXY_API_BASE |
LiteLLM proxy base URL. |
LITELLM_PROXY_API_KEY |
LiteLLM proxy API key, if required. |
Provider-specific keys
When you use a provider through the proxy,
set the matching API key:
| Variable |
Provider |
OPENAI_API_KEY |
OpenAI |
ANTHROPIC_API_KEY |
Anthropic |
XAI_API_KEY |
xAI |
REPLICATE_API_KEY |
Replicate |
TOGETHERAI_API_KEY |
Together AI |
Azure OpenAI
| Variable |
Description |
AZURE_API_BASE |
Azure OpenAI endpoint URL. |
AZURE_API_VERSION |
Azure OpenAI API version, such as 2023-05-15. |
AZURE_API_TYPE |
Set this value to azure. |
Custom OpenAI base URL
| Variable |
Description |
OPENAI_BASE_URL |
Base URL for a self-hosted OpenAI-compatible endpoint. |
CLI Options
| Option |
Description |
--model |
Model ID. Overrides LITELLM_PROXY_MODEL. |
--prompt-file |
YAML prompt file path. Default is prompts/default.yml. |
--log-level |
Logging level. Default is WARNING. |
The package exposes a prepare-commit console script:
prepare-commit --model "$LITELLM_PROXY_MODEL"
Examples
LiteLLM proxy
export LITELLM_PROXY_MODEL=litellm_proxy/mistral
export LITELLM_PROXY_API_BASE=https://your-litellm-proxy.example
export LITELLM_PROXY_API_KEY="your-proxy-api-key"
GitHub Copilot
export LITELLM_PROXY_MODEL=github_copilot/gpt-4
OpenAI GPT-4
export LITELLM_PROXY_MODEL=openai/gpt-4
export OPENAI_API_KEY="your-openai-api-key"
Custom OpenAI base URL example
export OPENAI_BASE_URL="https://your_host/v1"