HelpModule

Less than 1 minute

Built-in console help module.

class HelpModule extends \Hazaar\Console\Modules\Module

Provides general usage output, module/command-specific help text, and formatted listings of available commands, arguments, and options.

Properties

Executable name used when rendering usage examples.

private string $executable

Executes help rendering for the current input context.

public execute(Input $input, Output $output): int

Parameter	Type	Description
`$input`	`Input`	parsed command-line input
`$output`	`Output`	console output writer

Registers global help options and the help command definition.

protected configure(): void

Writes global option definitions when available.

private writeGlobalOptions(Output $output): void

Parameter	Type	Description
`$output`	`Output`	console output writer

Writes the available commands to the output.

private writeCommands(Output $output, array $commands): void

Parameter	Type	Description
`$output`	`Output`
`$commands`	`array`

Writes detailed help output for a specific command.

private writeCommand(Output $output, Command $command, ?Module $module): void

Parameter	Type	Description
`$output`	`Output`	console output writer
`$command`	`Command`	command definition to describe
`$module`	`Module`	optional module owning the command

Writes the arguments for a command to the output.

private writeArguments(Output $output, array $arguments): void

Parameter	Type	Description
`$output`	`Output`
`$arguments`	`array`

Writes the options for a command to the output.

private writeOptions(Output $output, array $options, string $label = 'Options'): void

private writeModuleHelp(Output $output, Module $module): void

Parameter	Type	Description
`$output`	`Output`
`$module`	`Module`

private writeHelp(Output $output): void

Parameter	Type	Description
`$output`	`Output`

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:25 +0000