 |
VOOZH | about |
|
VOOZH | about |
This page is the entry point for all user-facing documentation covering how to operate ai-commit on a day-to-day basis. It introduces the available commands and their relationships, and provides a high-level orientation before the detailed sub-pages.
ai-commit exposes four user-facing commands. Run ./ai-commit list to see them.
| Command | Description |
|---|---|
commit | Generate a conventional commit message with AI and commit it |
config | Read and write configuration options |
self-update | Update the PHAR binary to the latest release |
completion | Dump shell completion script |
thanks | Display acknowledgements |
The commit and config commands are the two commands users interact with regularly. They are covered in detail in child pages 3.1, 3.2, and 3.3.
The following diagram shows how the two primary commands map to their implementing classes and the configuration/generator systems they depend on.
Command to Code Entity Map
Sources: app/Commands/CommitCommand.php32-298 config/ai-commit.php1-260
The standard usage pattern for ai-commit involves two phases: one-time configuration, then repeated use of the commit command.
Typical User Workflow
Sources: app/Commands/CommitCommand.php52-105
The active generator is selected with --generator or by setting generator in configuration. The default is openai_chat.
| Generator Key | Type | Required Credential |
|---|---|---|
openai_chat | API | generators.openai_chat.api_key |
openai | API | generators.openai.api_key |
moonshot | API | generators.moonshot.api_key |
ernie_bot | API | generators.ernie_bot.api_key + secret_key |
ernie_bot_turbo | API | generators.ernie_bot_turbo.api_key + secret_key |
bito_cli | CLI binary | generators.bito_cli.binary (default: bito) |
github_copilot_cli | CLI binary | generators.github_copilot_cli.binary (default: gh) |
github_models_cli | CLI binary | generators.github_models_cli.binary (default: gh) |
For per-generator configuration details, see AI Generators Overview.
Sources: config/ai-commit.php78-219
When running commit, the user is prompted to select a commit type. The list is drawn from the types key in configuration.
| Key | Description |
|---|---|
auto | Let the AI decide the commit type automatically |
feat | A new feature |
fix | A bug fix |
docs | Documentation only changes |
style | Formatting changes with no logic impact |
refactor | Code change that neither fixes a bug nor adds a feature |
perf | A performance improvement |
test | Adding or correcting tests |
build | Build system or dependency changes |
ci | CI configuration changes |
chore | Other changes not modifying src or test files |
revert | Reverts a previous commit |
Selecting auto causes CommitCommand::promptFor() to reset the <type> placeholder to the raw marker and clear the type prompt, leaving the AI to infer the type from the diff.
Sources: config/ai-commit.php50-63 app/Commands/CommitCommand.php236-254
Set an API key globally (persists across repositories):
Set the default generator globally:
Generate and commit using a specific generator:
Generate a message without committing (preview only):
Skip the editor and git hooks:
Provide a custom config file for a single invocation:
View the full prompt sent to the AI (verbose mode):
Sources: app/Commands/CommitCommand.php132-190 README.md55-133
| Page | Content |
|---|---|
| 3.1 Commit Command Workflow | Step-by-step description of the commit command: staging, type selection, generation, confirmation loop, and git execution |
| 3.2 Command Options and Flags | Full reference for every CLI option accepted by commit and config |
| 3.3 Configuration Management | How to use config set/get/unset/reset/list/edit, global vs local config, and custom config files |
| 3.4 AI Generators Overview | Survey of all supported generators and how to select and configure each one |