 |
VOOZH | about |
|
VOOZH | about |
This page provides an overview of the AI generator subsystem in ai-commit: its purpose, the types of generators available, and how the pieces relate to each other. It is the parent page for:
AbstractGenerator, GeneratorContract, and GeneratorManagerFor configuration of individual generators (API keys, model parameters, binary paths), see Generator-Specific Configuration. For how the CommitCommand selects and invokes a generator at runtime, see Commit Command Workflow.
The generator subsystem is responsible for taking a formatted prompt string (containing the git diff and commit type instructions) and returning a raw AI-generated commit message string. Every generator implements a single method contract: generate(string $prompt): string.
The system supports two categories of generators:
| Category | Mechanism | Examples |
|---|---|---|
| API-based | HTTP requests via a custom client | OpenAI, OpenAI Chat, Moonshot, ErnieBot, ErnieBotTurbo |
| CLI-based | Shell subprocess via Symfony Process | Bito CLI, GitHub Copilot CLI, GitHub Models CLI |
| Component | File | Role |
|---|---|---|
GeneratorContract | app/Contracts/GeneratorContract.php | Interface: defines generate(string $prompt): string |
AbstractGenerator | app/Generators/AbstractGenerator.php | Base class: config injection, output, process helpers |
GeneratorManager | app/GeneratorManager.php | Laravel Manager: resolves and instantiates generator drivers |
OpenAIGenerator | app/Generators/OpenAIGenerator.php | API generator for OpenAI completions endpoint |
OpenAIChatGenerator | app/Generators/OpenAIChatGenerator.php | API generator for OpenAI chat completions endpoint |
MoonshotGenerator | app/Generators/MoonshotGenerator.php | API generator for Moonshot AI |
ErnieBotGenerator | app/Generators/ErnieBotGenerator.php | API generator for Baidu ErnieBot |
ErnieBotTurboGenerator | app/Generators/ErnieBotTurboGenerator.php | API generator for ErnieBot Turbo variant |
BitoCliGenerator | app/Generators/BitoCliGenerator.php | CLI generator using Bito CLI (stdin prompt) |
GithubCopilotCliGenerator | app/Generators/GithubCopilotCliGenerator.php | CLI generator using GitHub Copilot CLI (argument prompt) |
GithubModelsCliGenerator | app/Generators/GithubModelsCliGenerator.php | CLI generator using GitHub Models CLI (stdin prompt) |
Sources: app/GeneratorManager.php1-78 app/Generators/AbstractGenerator.php1-106 app/Generators/BitoCliGenerator.php1-33 app/Generators/GithubCopilotCliGenerator.php1-29 app/Generators/GithubModelsCliGenerator.php1-33 app/Generators/OpenAIChatGenerator.php1-52
Class hierarchy of the generator subsystem:
Sources: app/GeneratorManager.php32-78 app/Generators/AbstractGenerator.php28-106 app/Generators/OpenAIChatGenerator.php19-52 app/Generators/BitoCliGenerator.php18-33 app/Generators/GithubCopilotCliGenerator.php18-29 app/Generators/GithubModelsCliGenerator.php18-33
GeneratorManager extends Illuminate\Support\Manager. When generate() is called, it delegates to the active driver, which is resolved by createDriver().
Driver resolution flow from config key to generator instance:
The class name is built in app/GeneratorManager.php70-73 using:
$studlyName = str($config->get('driver', $driver))->replace('openai', 'OpenAI')->studly();
$class = "App\\Generators\\{$studlyName}Generator";
The driver name (e.g., openai_chat) comes from either the --generator CLI option or the ai-commit.generator config key.
Sources: app/GeneratorManager.php41-77
Data flow for API-based vs CLI-based generators:
Sources: app/Generators/BitoCliGenerator.php22-32 app/Generators/GithubCopilotCliGenerator.php22-28 app/Generators/GithubModelsCliGenerator.php22-32 app/Generators/OpenAIChatGenerator.php29-41
The three CLI-based generators differ in how the prompt is passed to the subprocess:
| Generator | Binary config key | Prompt delivery | Method |
|---|---|---|---|
BitoCliGenerator | binary | stdin (setInput($prompt)) | mustRunProcess() |
GithubCopilotCliGenerator | binary | command argument | mustRun($callback) |
GithubModelsCliGenerator | binary + model | stdin (setInput($prompt)) | mustRunProcess() |
BitoCliGenerator app/Generators/BitoCliGenerator.php22-32 pipes the prompt as stdin using Process::setInput().GithubCopilotCliGenerator app/Generators/GithubCopilotCliGenerator.php22-28 passes the prompt as a direct CLI argument: ['binary', 'copilot', 'explain', $prompt].GithubModelsCliGenerator app/Generators/GithubModelsCliGenerator.php22-32 pipes the prompt as stdin and also includes the model name in the command: ['binary', 'models', 'run', $model].All three use ensureWithOptions() app/Generators/AbstractGenerator.php89-92 to append any configured CLI options from options in their config block.
AbstractGenerator app/Generators/AbstractGenerator.php28-106 provides shared infrastructure that all generators rely on:
| Method / Property | Description |
|---|---|
$config (Repository) | Illuminate config repository scoped to the generator's config block |
$output (OutputStyle) | Console output stream set to VERBOSITY_DEBUG |
$helperSet (HelperSet) | Symfony console helper set from the Artisan kernel |
mustRunProcess() | Runs a Process via ProcessHelper, throws ProcessFailedException on non-zero exit |
runProcess() | Runs a Process via ProcessHelper without throwing on failure |
runningCallback() | Returns a callback that writes stdout/stderr to the output stream |
ensureWithOptions() | Appends hydratedOptions() to a command array |
hydratedOptions() | Converts the options config map to a flat CLI option list |
The constructor app/Generators/AbstractGenerator.php36-40 clones the global OutputStyle instance and retrieves the HelperSet from the running Artisan instance.
Sources: app/Generators/AbstractGenerator.php28-106
| Topic | Page |
|---|---|
AbstractGenerator, GeneratorContract, GeneratorManager internals | Generator Architecture |
| OpenAI, Moonshot, ErnieBot HTTP generators | API-Based Generators |
| Bito, GitHub Copilot, GitHub Models CLI generators | CLI-Based Generators |
| How to implement a new generator | Adding New Generators |
| Config keys per generator (API key, model, binary) | Generator-Specific Configuration |
How GeneratorManager is registered as a singleton | Application Foundation |
| Architecture overview of the full driver resolution system | Generator System Architecture |