Console Command System

Purpose and Scope

The Console Command System provides the CLI interface for Hypervel applications. It handles command discovery, registration, execution, and scheduling through the Hypervel\Foundation\Console\Kernel class. The system discovers commands from multiple sources (directories, annotations, configuration, closures) and executes them through a Hypervel\Console\Application instance (the "Artisan" application).

This page provides an overview of the console system architecture and components. For detailed subsystem information, see:

• Command execution flow and the Artisan application: Console Kernel and Command Execution
• Command discovery mechanisms and registration logic: Command Discovery and Registration
• Task scheduling configuration: Task Scheduling
• Built-in server management utilities: Server Management Commands

Sources: src/Console/Kernel.php1-438 src/Console/Contracts/Kernel.php1-97

System Architecture

The console system is built around the Hypervel\Foundation\Console\Kernel class, which implements Hypervel\Foundation\Console\Contracts\Kernel. The kernel coordinates command discovery from multiple sources, registers them with a Hypervel\Console\Application instance, and manages the command execution lifecycle.

System Architecture

The console system is built around the Hypervel\Foundation\Console\Kernel class, which coordinates command discovery, registration, and execution. Commands can be defined through multiple mechanisms: class-based commands in directories, annotations, configuration arrays, command route files, and closure-based commands.

Console System Component Architecture

Sources: src/Console/Kernel.php32-438 src/Console/Contracts/Kernel.php13-97

Core Components

Console Kernel

The Hypervel\Foundation\Console\Kernel class serves as the central coordinator for the console system. It implements the Hypervel\Foundation\Console\Contracts\Kernel interface and manages the complete command lifecycle from discovery to execution.

Component	Type	Description
Kernel class	Main implementation	Central console coordinator
$artisan property	ApplicationContract	Artisan console application instance
$commands property	array	Explicitly registered command classes
$closureCommands property	array	Closure-based commands
$commandPaths property	array	Directories for command auto-discovery
$commandRoutePaths property	array	Command route files to load
$bootstrappers property	array	Application bootstrapping classes

Sources: src/Console/Kernel.php32-76

Built-in Commands

The Foundation package provides several built-in commands registered through ConfigProvider. These commands are registered in the commands() method of the config provider, making them available to all Hypervel applications.

Command Class	Signature	Description
AboutCommand	about	Display application information
ConfigShowCommand	config:show	Display configuration values
ServerReloadCommand	server:reload	Reload all workers gracefully
VendorPublishCommand	vendor:publish	Publish vendor assets

These commands are automatically discovered and registered by Hyperf's command collection system through the config provider.

Sources: src/ConfigProvider.php31-36 </old_str>

<old_str>

Bootstrappers

The console kernel bootstraps the application before executing commands using three core bootstrapper classes:

The bootstrapper array is defined at src/Console/Kernel.php71-75 and executed during the bootstrap() method at src/Console/Kernel.php103-120

Sources: src/Console/Kernel.php71-75 src/Console/Kernel.php103-120 </old_str> <new_str>

Bootstrappers

The console kernel bootstraps the application before executing commands using three core bootstrapper classes defined in the $bootstrappers property:

The bootstrapper array is defined at src/Console/Kernel.php71-75 and executed during the bootstrap() method at src/Console/Kernel.php105-107 These are the same bootstrappers used by the HTTP kernel, ensuring consistent application initialization across both contexts.

Sources: src/Console/Kernel.php71-75 src/Console/Kernel.php103-120

Artisan Application

The console kernel creates and manages a Hypervel\Console\Application instance (the "Artisan" application), which is responsible for parsing input, finding commands, and executing them. This is accessed via the getArtisan() method.

Sources: src/Console/Kernel.php36 src/Console/Kernel.php402-417

Command Lifecycle

Console Command Execution Flow

Sources: src/Console/Kernel.php95-120 src/Console/Kernel.php149-214 src/Console/Kernel.php402-417 src/Console/Kernel.php434-437

Key Lifecycle Methods

Method	Purpose	File Reference
run()	Execute the console application	src/Console/Kernel.php434-437
handle()	Process input/output through Artisan	src/Console/Kernel.php95-98
bootstrap()	Initialize application for commands	src/Console/Kernel.php103-120
discoverCommands()	Auto-discover commands from paths	src/Console/Kernel.php133-144
collectCommands()	Gather commands from all sources	src/Console/Kernel.php149-192
loadCommands()	Register collected commands	src/Console/Kernel.php194-214
registerCommand()	Add command to Artisan app	src/Console/Kernel.php219-226

Sources: src/Console/Kernel.php95-226

Command Sources and Discovery

The console kernel discovers and collects commands from six distinct sources, which are then merged and registered with the Artisan application.

Command Collection Sources

Sources: src/Console/Kernel.php149-192

Discovery Configuration

Commands can be configured for automatic discovery through several kernel properties and methods:

Property/Method	Type	Description
$commandPaths	array	Directories to scan for command classes
$commandRoutePaths	array	PHP files containing command route definitions
addCommandPaths()	method	Add directories for command discovery
addCommandRoutePaths()	method	Add command route files
load()	method	Add paths to the loaded paths array

Sources: src/Console/Kernel.php49-56 src/Console/Kernel.php332-389

Command Registration Methods

Explicit Command Registration

Commands can be registered explicitly through the addCommands() method:

$kernel->addCommands([
 MyCommand::class,
 AnotherCommand::class,
]);

Sources: src/Console/Kernel.php360-369

Closure-Based Commands

The kernel supports registering commands using closures through the command() method:

$kernel->command('signature {argument}', function ($argument) {
 // Command implementation
});

This creates a Hypervel\Console\ClosureCommand instance, which is either immediately registered (if commands are already loaded) or stored in $closureCommands for later registration.

Sources: src/Console/Kernel.php311-327

Command Prioritization

When loading commands, the kernel ensures Hyperf framework commands are registered first, allowing application commands to override them:

Sources: src/Console/Kernel.php194-214

Command Sources and Discovery

The console kernel discovers and collects commands from six distinct sources, which are then merged and registered with the Artisan application.

Command Source Summary

Source	Property/Method	Discovery Mechanism	File Reference
Loaded paths	$loadedPaths via load()	ReflectionManager::getAllClasses() scans directories	src/Console/Kernel.php152-155
Config array	config('commands')	ConfigInterface::get('commands', [])	src/Console/Kernel.php158-160
Annotations	@Command annotations	AnnotationCollector::getClassesByAnnotation()	src/Console/Kernel.php163-169
Explicit commands	$commands property	Direct class name array	src/Console/Kernel.php41 src/Console/Kernel.php190
Closure commands	$closureCommands property	Registered via command() method	src/Console/Kernel.php46 src/Console/Kernel.php183-187
Command paths	$commandPaths property	Auto-discovered during discoverCommands()	src/Console/Kernel.php51 src/Console/Kernel.php135-137

Task Scheduling

The console kernel integrates with the Hypervel\Console\Scheduling\Schedule class to support scheduled task execution. The scheduling system is initialized during application boot.

Schedule Configuration

The schedule() method can be overridden in application kernels to define scheduled tasks:

protected function schedule(Schedule $schedule): void
{
 $schedule->command('emails:send')->daily();
}

Sources: src/Console/Kernel.php87-89 src/Console/Kernel.php257-299

Scheduling Methods

Method	Purpose	File Reference
schedule()	Define scheduled tasks (override in subclasses)	src/Console/Kernel.php257-259
resolveConsoleSchedule()	Create Schedule instance	src/Console/Kernel.php264-269
defineConsoleSchedule()	Bind Schedule to container	src/Console/Kernel.php274-281
scheduleTimezone()	Get timezone for scheduled events	src/Console/Kernel.php286-291
scheduleCache()	Get cache store for schedule mutexes	src/Console/Kernel.php296-299

Sources: src/Console/Kernel.php257-299

Integration with Application

The console kernel is tightly integrated with the application container and lifecycle:

Container Integration

Sources: src/Console/Kernel.php77-90 src/Console/Kernel.php402-417

Kernel Contract Methods

The Hypervel\Foundation\Console\Contracts\Kernel interface defines the public API for console kernel operations:

Method	Return Type	Description
bootstrap()	void	Bootstrap application for commands
schedule()	void	Define command schedule
commands()	void	Register application commands
command()	ClosureCommand	Register closure-based command
load()	void	Add command discovery paths
addCommands()	static	Set explicit commands
addCommandPaths()	static	Set command discovery paths
addCommandRoutePaths()	static	Set command route paths
getLoadedPaths()	array	Get loaded command paths
registerCommand()	void	Register single command
call()	mixed	Execute command by name
all()	array	Get all registered commands
output()	string	Get output from last command
getArtisan()	ApplicationContract	Get Artisan instance
setArtisan()	void	Set Artisan instance

Sources: src/Console/Contracts/Kernel.php13-97

Configuration Provider Registration

The ConfigProvider registers the console kernel's dependencies and built-in commands with Hyperf's dependency injection system:

Sources: src/ConfigProvider.php20-46