describe-commit.example.yml

# This is an example configuration file for describe-commit.
#
# By default, this file is searched for in the user's configuration directory:
# - For Linux: `~/.configs/describe-commit.yml`
# - For Windows: `%APPDATA%\describe-commit.yml`
# - For macOS: `~/Library/Application Support/describe-commit.yml`
#
# You can override this behavior by specifying the path to the configuration file using the `--config-file` flag
# or by setting the `CONFIG_FILE` environment variable.

# Generate a short commit message (subject line) only
# @type {boolean}
shortMessageOnly: false

# How many previous commits from the Git history should be considered as context for the AI model?
# Set to 0 to disable this feature.
# @type {integer}
commitHistoryLength: 15

# Enable emoji in the commit message
# @type {boolean}
enableEmoji: false

# Maximum number of tokens in the output message
# @type {integer}
maxOutputTokens: 500

# AI provider to use
# @enum {gemini|openai|openrouter|anthropic}
aiProvider: gemini

# Gemini provider configuration
gemini:
  # Gemini API key (issue your own at https://bit.ly/4jZhiKI, as of February 2025 it's free)
  # @type {string}
  apiKey: <gemini-api-key>

  # Gemini model name (https://bit.ly/4i02ARR)
  # @type {string}
  #modelName: <gemini-model-name>

# OpenAI provider configuration
openai:
  # OpenAI API key (issue your own at https://bit.ly/4i03NbR, you need to add funds to your account to access the API)
  # @type {string}
  apiKey: <openai-api-key>

  # OpenAI model name (https://bit.ly/4hXCXkL)
  # @type {string}
  #modelName: <openai-model-name>

# OpenRouter provider configuration
openrouter:
  # OpenRouter API key (issue your own at https://bit.ly/4hU1yY1)
  # @type {string}
  apiKey: <openrouter-api-key>

  # OpenAI model name (https://bit.ly/4ktktuG)
  # @type {string}
  #modelName: <openrouter-model-name>

# Anthropic provider configuration
anthropic:
  # Anthropic API key (issue your own at https://bit.ly/4klw0Mw, you need to add funds to your account)
  # @type {string}
  apiKey: <anthropic-api-key>

  # Anthropic model name (https://bit.ly/4bmQDDV)
  # @type {string}
  #modelName: <anthropic-model-name>