 |
VOOZH | about |
|
VOOZH | about |
This page is the top-level reference for all configuration options in ai-commit. It covers the complete set of keys accepted in config/ai-commit.php (the built-in defaults), as well as how those keys carry over into JSON user configuration files.
config CLI subcommands (set, get, list, edit, etc.), see Configuration Management.commit command flags that map to config keys, see Command Options and Flags.ConfigManager class implementation, see Configuration System Implementation.Configuration Layers and Their Sources
Sources: config/ai-commit.php1-260 app/Commands/CommitCommand.php198-216
The following table lists every top-level key present in the default configuration. All keys may be overridden in the global or local JSON files.
| Key | Type | Default Value | Description |
|---|---|---|---|
commit_options | string[] | ["--edit"] | Extra flags appended to git commit |
diff_options | string[] | [":!*-lock.json", ":!*.lock", ":!*.sum"] | Extra flags appended to git diff --cached |
http_options | object | {verify: false, connect_timeout: 30, timeout: 120} | Guzzle request options applied to all HTTP generators |
diff_mark | string | "<diff>" | Placeholder substituted with the actual diff in prompt templates |
type_mark | string | "<type>" | Placeholder substituted with the selected commit type |
type_prompt_mark | string | "<type-prompt>" | Placeholder substituted with the formatted type directive |
type_prompt | string | "- Use commit type \%s`."` | sprintf format string used to build the type directive |
types | object | See Commit Types | Map of commit type keys to human-readable descriptions |
no_edit | bool | false | Permanently enables --no-edit on every git commit call |
no_verify | bool | false | Permanently enables --no-verify on every git commit call |
prompt | string | "conventional" | Name of the prompt template to use by default |
generator | string | "openai_chat" | Name of the generator driver to use by default |
generators | object | See Generator Config | Map of generator name → generator config block |
prompts | object | See Prompt Templates | Map of prompt name → prompt template string |
Sources: config/ai-commit.php14-260
The diagram below maps each configuration key to the code location that reads it.
Config Keys Resolved at Runtime
Sources: app/Commands/CommitCommand.php132-253
Understanding how the marks (diff_mark, type_mark, type_prompt_mark) interact is essential for writing custom prompt templates.
Prompt Assembly Flow in CommitCommand::promptFor()
Sources: app/Commands/CommitCommand.php236-253 config/ai-commit.php39-48
Each entry under generators follows this shape. Fields differ slightly for API-based vs CLI-based generators.
API-based generator block (e.g. openai_chat):
generators.openai_chat:
driver → string (maps to GeneratorManager driver name)
http_options → object (per-generator Guzzle overrides)
api_key → string (env: OPENAI_API_KEY)
parameters → object (passed directly in the API request body)
model → string
max_tokens → int
temperature → float
top_p → float
n → int
stream → bool
stop → null|string
presence_penalty → int
frequency_penalty → int
CLI-based generator block (e.g. bito_cli):
generators.bito_cli:
driver → string (maps to GeneratorManager driver name)
binary → string (env: BITO_CLI_BINARY, default: 'bito')
prompt_filename → string (temp file name written before invocation)
options → object (CLI flags passed to the binary)
parameters → object (Symfony Process constructor arguments)
cwd → null|string
env → null|array
input → null|string
timeout → int
Sources: config/ai-commit.php79-218
The generator key (top-level) and each entry's driver key must match one of these registered names.
| Config key / driver name | Backed by | API key env var |
|---|---|---|
openai | OpenAI Completions API | OPENAI_API_KEY |
openai_chat | OpenAI Chat API | OPENAI_API_KEY |
moonshot | Moonshot API | MOONSHOT_API_KEY |
ernie_bot | Baidu Ernie Bot API | ERNIE_API_KEY, ERNIE_SECRET_KEY |
ernie_bot_turbo | Baidu Ernie Bot Turbo API | ERNIE_API_KEY, ERNIE_SECRET_KEY |
bito_cli | Bito CLI binary | BITO_CLI_BINARY (binary path) |
github_copilot_cli | GitHub CLI (gh copilot) | GITHUB_COPILOT_CLI_BINARY (binary path) |
github_models_cli | GitHub CLI (gh models) | GITHUB_MODELS_CLI_BINARY, GITHUB_MODELS_CLI_MODEL |
Sources: config/ai-commit.php78-219
commit_options and diff_optionscommit_optionsAppended verbatim to the git commit command. The default ["--edit"] opens the editor after generation (equivalent to the standard git behavior).
To disable the editor globally, set no_edit: true or change commit_options to [].
diff_optionsAppended verbatim to git diff --cached. The defaults exclude lock files and checksum files from the diff sent to the AI:
| Exclusion pattern | Purpose |
|---|---|
:!*-lock.json | Excludes npm/yarn lock files |
:!*.lock | Excludes Composer, Cargo, etc. lock files |
:!*.sum | Excludes Go module checksums |
Sources: config/ai-commit.php15-25 app/Commands/CommitCommand.php218-221
The top-level http_options block is passed to Guzzle for all API-based generators. Generator-specific http_options blocks are merged on top of this. The keys follow Guzzle request option names.
| Option constant | Default | Description |
|---|---|---|
GuzzleHttp\RequestOptions::VERIFY | false | Disable SSL certificate verification |
GuzzleHttp\RequestOptions::CONNECT_TIMEOUT | 30 | Seconds to wait for a connection |
GuzzleHttp\RequestOptions::TIMEOUT | 120 | Total request timeout in seconds |
Sources: config/ai-commit.php30-36
Detailed reference for each major configuration section is in the following sub-pages:
| Page | Topic |
|---|---|
| 7.1 Configuration File Format and Precedence | JSON format, file locations, three-layer merge |
| 7.2 Commit Types Configuration | types map, type_mark, type_prompt_mark, type_prompt |
| 7.3 Prompt Templates Configuration | prompts map, placeholder substitution, custom templates |
| 7.4 Generator-Specific Configuration | Full per-generator config key reference |
Refresh this wiki