describe-commit/describe-commit.example.yml at master · tarampampam/describe-commit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# This is an example configuration file for describe-commit.
#
# By default, this file is searched for in the user's configuration directory:
# - For Linux: `~/.config/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://aistudio.google.com/app/api-keys, as of February 2025 it's free)
  # @type {string}
  apiKey: <gemini-api-key>

  # Gemini model name (https://ai.google.dev/gemini-api/docs/models)
  # @type {string}
  #modelName: gemini-2.5-flash

  # Gemini API base URL (overrides the default endpoint; useful for proxies or Gemini-compatible services)
  # @type {string}
  #baseUrl: https://generativelanguage.googleapis.com

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

  # OpenAI model name (https://developers.openai.com/api/docs/models)
  # @type {string}
  #modelName: gpt-4.1-nano

  # OpenAI API base URL (overrides the default endpoint; useful for OpenAI-compatible services such as Ollama)
  # @type {string}
  #baseUrl: https://api.openai.com

# OpenRouter provider configuration
openrouter:
  # OpenRouter API key (issue your own at https://openrouter.ai/workspaces/default/keys)
  # @type {string}
  apiKey: <openrouter-api-key>

  # OpenRouter model name (https://openrouter.ai/models?order=pricing-low-to-high)
  # @type {string}
  #modelName: google/gemma-4-31b-it:free

  # OpenRouter API base URL (overrides the default endpoint; useful for proxies or OpenRouter-compatible services)
  # @type {string}
  #baseUrl: https://openrouter.ai

# Anthropic provider configuration
anthropic:
  # Anthropic API key (issue your own at https://platform.claude.com/settings/keys, you need to add funds to your account)
  # @type {string}
  apiKey: <anthropic-api-key>

  # Anthropic model name (https://platform.claude.com/docs/en/about-claude/models/overview)
  # @type {string}
  #modelName: claude-haiku-4-5-20251001

  # Anthropic API base URL (overrides the default endpoint; useful for proxies or Anthropic-compatible services)
  # @type {string}
  #baseUrl: https://api.anthropic.com