# HelpController

> Provides help information about console commands.

[API reference](/docs/api/index.md) › [yii](/docs/api/yii/index.md) › [console](/docs/api/yii/console/index.md) › [controllers](/docs/api/yii/console/controllers/index.md) › HelpController

| class | `yii\console\controllers\HelpController` |
| --- | --- |
| Extends | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) » [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\ViewContextInterface`](/docs/api/yii/base/viewcontextinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Since | 2.0 |
| Source | [`framework/console/controllers/HelpController.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/console/controllers/HelpController.php#L45) |

Provides help information about console commands.

This command displays the available command list in
the application or the detailed instructions about using
a specific command.

This command can be used as follows on command line:

```
yii help [command name]
```

In the above, if the command name is not provided, all
available commands will be displayed.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-action"></span>[`$action`](/docs/api/yii/base/controller/index.md#property-action) | [`yii\base\Action`](/docs/api/yii/base/action/index.md)`<static>\|null` | The action that is currently being executed. Default: `null`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-behaviors"></span>[`$behaviors`](/docs/api/yii/base/component/index.md#property-behaviors) read-only | `array<`[`yii\base\Behavior`](/docs/api/yii/base/behavior/index.md)`<static>>` | List of behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="property-color"></span>[`$color`](/docs/api/yii/console/controller/index.md#property-color) | `bool\|null` | Whether to enable ANSI color in the output. Default: `null`. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-commands"></span>`$commands` read-only | `array` | All available command names. | `HelpController` |
| <span id="property-defaultAction"></span>[`$defaultAction`](/docs/api/yii/base/controller/index.md#property-defaultAction) | `string` | The ID of the action that is used when the action ID is not specified in the request. Default: `'index'`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-help"></span>[`$help`](/docs/api/yii/console/controller/index.md#property-help) | `bool` | Whether to display help information about current command. Default: `false`. Available since 2.0.10. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-helpSummary"></span>[`$helpSummary`](/docs/api/yii/console/controller/index.md#property-helpSummary) read-only | `string` | The one-line short summary describing this controller. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-id"></span>[`$id`](/docs/api/yii/base/controller/index.md#property-id) | `string` | The ID of this controller. Default: `null`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-interactive"></span>[`$interactive`](/docs/api/yii/console/controller/index.md#property-interactive) | `bool` | Whether to run the command interactively. Default: `true`. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-layout"></span>[`$layout`](/docs/api/yii/base/controller/index.md#property-layout) | `string\|null\|false` | The name of the layout to be applied to this controller's views. Default: `null`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-module"></span>[`$module`](/docs/api/yii/base/controller/index.md#property-module) | `yii\base\T` | The module that this controller belongs to. Default: `null`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-modules"></span>[`$modules`](/docs/api/yii/base/controller/index.md#property-modules) read-only | [`yii\base\Module`](/docs/api/yii/base/module/index.md)`[]` | All ancestor modules that this controller is located within. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-passedOptions"></span>[`$passedOptions`](/docs/api/yii/console/controller/index.md#property-passedOptions) read-only | `array` | The names of the options passed during execution. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-passedOptionValues"></span>[`$passedOptionValues`](/docs/api/yii/console/controller/index.md#property-passedOptionValues) read-only | `array` | The properties corresponding to the passed options. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-request"></span>[`$request`](/docs/api/yii/console/controller/index.md#property-request) | [`yii\console\Request`](/docs/api/yii/console/request/index.md) | The request object. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-response"></span>[`$response`](/docs/api/yii/console/controller/index.md#property-response) | [`yii\console\Response`](/docs/api/yii/console/response/index.md) | The response object. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-route"></span>[`$route`](/docs/api/yii/base/controller/index.md#property-route) read-only | `string` | The route (module ID, controller ID and action ID) of the current request. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-silentExitOnException"></span>[`$silentExitOnException`](/docs/api/yii/console/controller/index.md#property-silentExitOnException) | `bool\|null` | If true - script finish with `ExitCode::OK` in case of exception. false - `ExitCode::UNSPECIFIED_ERROR`. Default: `null`. Available since 2.0.36. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="property-uniqueId"></span>[`$uniqueId`](/docs/api/yii/base/controller/index.md#property-uniqueId) read-only | `string` | The controller ID that is prefixed with the module ID (if any). | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-view"></span>[`$view`](/docs/api/yii/base/controller/index.md#property-view) | [`yii\base\View`](/docs/api/yii/base/view/index.md)`\|`[`yii\web\View`](/docs/api/yii/web/view/index.md) | The view object that can be used to render views or view files. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="property-viewPath"></span>[`$viewPath`](/docs/api/yii/base/controller/index.md#property-viewPath) | `string` | The directory containing the view files for this controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/controller/index.md#method-__construct) |  | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/component/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__clone"></span>[`__clone()`](/docs/api/yii/base/component/index.md#method-__clone) | This method is called after the object is created by cloning an existing one. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/component/index.md#method-__get) | Returns the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/component/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/component/index.md#method-__set) | Sets the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/component/index.md#method-__unset) | Sets a component property to be null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`actionIndex()`](#method-actionIndex) | Displays available commands or the detailed information about a particular command. | `HelpController` |
| [`actionList()`](#method-actionList) | List all available controllers and actions in machine readable format. | `HelpController` |
| [`actionListActionOptions()`](#method-actionListActionOptions) | List all available options for the $action in machine readable format. | `HelpController` |
| <span id="method-actions"></span>[`actions()`](/docs/api/yii/base/controller/index.md#method-actions) | Declares external actions for the controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| [`actionUsage()`](#method-actionUsage) | Displays usage information for $action. | `HelpController` |
| <span id="method-afterAction"></span>[`afterAction()`](/docs/api/yii/base/controller/index.md#method-afterAction) | This method is invoked right after an action is executed. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-ansiFormat"></span>[`ansiFormat()`](/docs/api/yii/console/controller/index.md#method-ansiFormat) | Formats a string with ANSI codes. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-attachBehavior"></span>[`attachBehavior()`](/docs/api/yii/base/component/index.md#method-attachBehavior) | Attaches a behavior to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehaviors"></span>[`attachBehaviors()`](/docs/api/yii/base/component/index.md#method-attachBehaviors) | Attaches a list of behaviors to the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-beforeAction"></span>[`beforeAction()`](/docs/api/yii/console/controller/index.md#method-beforeAction) | This method is invoked right before an action is executed. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-behaviors"></span>[`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) | Returns a list of behaviors that this component should behave as. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-bindActionParams"></span>[`bindActionParams()`](/docs/api/yii/console/controller/index.md#method-bindActionParams) | Binds the parameters to the action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/component/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/component/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-confirm"></span>[`confirm()`](/docs/api/yii/console/controller/index.md#method-confirm) | Asks user to confirm by typing y or n. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-createAction"></span>[`createAction()`](/docs/api/yii/base/controller/index.md#method-createAction) | Creates an action based on the given action ID. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-detachBehavior"></span>[`detachBehavior()`](/docs/api/yii/base/component/index.md#method-detachBehavior) | Detaches a behavior from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-detachBehaviors"></span>[`detachBehaviors()`](/docs/api/yii/base/component/index.md#method-detachBehaviors) | Detaches all behaviors from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-ensureBehaviors"></span>[`ensureBehaviors()`](/docs/api/yii/base/component/index.md#method-ensureBehaviors) | Makes sure that the behaviors declared in [`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) are attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-findLayoutFile"></span>[`findLayoutFile()`](/docs/api/yii/base/controller/index.md#method-findLayoutFile) | Finds the applicable layout file. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getActionArgsHelp"></span>[`getActionArgsHelp()`](/docs/api/yii/console/controller/index.md#method-getActionArgsHelp) | Returns the help information for the anonymous arguments for the action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getActionHelp"></span>[`getActionHelp()`](/docs/api/yii/console/controller/index.md#method-getActionHelp) | Returns the detailed help information for the specified action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getActionHelpSummary"></span>[`getActionHelpSummary()`](/docs/api/yii/console/controller/index.md#method-getActionHelpSummary) | Returns a one-line short summary describing the specified action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getActionOptionsHelp"></span>[`getActionOptionsHelp()`](/docs/api/yii/console/controller/index.md#method-getActionOptionsHelp) | Returns the help information for the options for the action. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| [`getActions()`](#method-getActions) | Returns all available actions of the specified controller. | `HelpController` |
| <span id="method-getBehavior"></span>[`getBehavior()`](/docs/api/yii/base/component/index.md#method-getBehavior) | Returns the named behavior object. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehaviors"></span>[`getBehaviors()`](/docs/api/yii/base/component/index.md#method-getBehaviors) | Returns all behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`getCommands()`](#method-getCommands) | Returns all available command names. | `HelpController` |
| <span id="method-getHelp"></span>[`getHelp()`](/docs/api/yii/console/controller/index.md#method-getHelp) | Returns help information for this controller. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getHelpSummary"></span>[`getHelpSummary()`](/docs/api/yii/console/controller/index.md#method-getHelpSummary) | Returns one-line short summary describing this controller. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getModules"></span>[`getModules()`](/docs/api/yii/base/controller/index.md#method-getModules) | Returns all ancestor modules of this controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getOptionValues"></span>[`getOptionValues()`](/docs/api/yii/console/controller/index.md#method-getOptionValues) | Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getPassedOptions"></span>[`getPassedOptions()`](/docs/api/yii/console/controller/index.md#method-getPassedOptions) | Returns the names of valid options passed during execution. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getPassedOptionValues"></span>[`getPassedOptionValues()`](/docs/api/yii/console/controller/index.md#method-getPassedOptionValues) | Returns the properties corresponding to the passed options. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-getRoute"></span>[`getRoute()`](/docs/api/yii/base/controller/index.md#method-getRoute) | Returns the route of the current request. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getUniqueId"></span>[`getUniqueId()`](/docs/api/yii/base/controller/index.md#method-getUniqueId) | Returns the unique ID of the controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getView"></span>[`getView()`](/docs/api/yii/base/controller/index.md#method-getView) | Returns the view object that can be used to render views or view files. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-getViewPath"></span>[`getViewPath()`](/docs/api/yii/base/controller/index.md#method-getViewPath) | Returns the directory containing view files for this controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-hasEventHandlers"></span>[`hasEventHandlers()`](/docs/api/yii/base/component/index.md#method-hasEventHandlers) | Returns a value indicating whether there is any handler attached to the named event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/component/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/component/index.md#method-hasProperty) | Returns a value indicating whether a property is defined for this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-init"></span>[`init()`](/docs/api/yii/base/controller/index.md#method-init) | Initializes the object. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-isColorEnabled"></span>[`isColorEnabled()`](/docs/api/yii/console/controller/index.md#method-isColorEnabled) | Returns a value indicating whether ANSI color is enabled. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/component/index.md#method-off) | Detaches an existing event handler from this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/component/index.md#method-on) | Attaches an event handler to an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-optionAliases"></span>[`optionAliases()`](/docs/api/yii/console/controller/index.md#method-optionAliases) | Returns option alias names. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-options"></span>[`options()`](/docs/api/yii/console/controller/index.md#method-options) | Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-prompt"></span>[`prompt()`](/docs/api/yii/console/controller/index.md#method-prompt) | Prompts the user for input and validates it. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-render"></span>[`render()`](/docs/api/yii/base/controller/index.md#method-render) | Renders a view and applies layout if available. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-renderContent"></span>[`renderContent()`](/docs/api/yii/base/controller/index.md#method-renderContent) | Renders a static string by applying a layout. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-renderFile"></span>[`renderFile()`](/docs/api/yii/base/controller/index.md#method-renderFile) | Renders a view file. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-renderPartial"></span>[`renderPartial()`](/docs/api/yii/base/controller/index.md#method-renderPartial) | Renders a view without applying layout. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-run"></span>[`run()`](/docs/api/yii/base/controller/index.md#method-run) | Runs a request specified in terms of a route. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-runAction"></span>[`runAction()`](/docs/api/yii/console/controller/index.md#method-runAction) | Runs an action with the specified action ID and parameters. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-select"></span>[`select()`](/docs/api/yii/console/controller/index.md#method-select) | Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-setView"></span>[`setView()`](/docs/api/yii/base/controller/index.md#method-setView) | Sets the view object to be used by this controller. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-setViewPath"></span>[`setViewPath()`](/docs/api/yii/base/controller/index.md#method-setViewPath) | Sets the directory that contains the view files. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="method-stderr"></span>[`stderr()`](/docs/api/yii/console/controller/index.md#method-stderr) | Prints a string to STDERR. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-stdout"></span>[`stdout()`](/docs/api/yii/console/controller/index.md#method-stdout) | Prints a string to STDOUT. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/component/index.md#method-trigger) | Triggers an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-bindInjectedParams"></span>[`bindInjectedParams()`](/docs/api/yii/base/controller/index.md#method-bindInjectedParams) protected final | Fills parameters based on types and names in action method signature. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| [`formatOptionAliases()`](#method-formatOptionAliases) protected |  | `HelpController` |
| [`formatOptionHelp()`](#method-formatOptionHelp) protected | Generates a well-formed string for an argument or option. | `HelpController` |
| <span id="method-getActionMethodReflection"></span>[`getActionMethodReflection()`](/docs/api/yii/console/controller/index.md#method-getActionMethodReflection) protected |  | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| [`getCommandDescriptions()`](#method-getCommandDescriptions) protected | Returns an array of commands an their descriptions. | `HelpController` |
| [`getCommandHelp()`](#method-getCommandHelp) protected | Displays the overall information of the command. | `HelpController` |
| [`getDefaultHelp()`](#method-getDefaultHelp) protected | Displays all available commands. | `HelpController` |
| [`getDefaultHelpHeader()`](#method-getDefaultHelpHeader) protected | Return a default help header. | `HelpController` |
| [`getModuleCommands()`](#method-getModuleCommands) protected | Returns available commands of a specified module. | `HelpController` |
| [`getScriptName()`](#method-getScriptName) protected |  | `HelpController` |
| [`getSubCommandHelp()`](#method-getSubCommandHelp) protected | Displays the detailed information of a command action. | `HelpController` |
| <span id="method-parseDocCommentDetail"></span>[`parseDocCommentDetail()`](/docs/api/yii/console/controller/index.md#method-parseDocCommentDetail) protected | Returns full description from the docblock. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-parseDocCommentSummary"></span>[`parseDocCommentSummary()`](/docs/api/yii/console/controller/index.md#method-parseDocCommentSummary) protected | Returns the first line of docblock. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| <span id="method-parseDocCommentTags"></span>[`parseDocCommentTags()`](/docs/api/yii/console/controller/index.md#method-parseDocCommentTags) protected | Parses the comment block into tags. | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) |
| [`validateControllerClass()`](#method-validateControllerClass) protected | Validates if the given class is a valid console controller class. | `HelpController` |

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_BEFORE_ACTION"></span>[`EVENT_BEFORE_ACTION`](/docs/api/yii/base/controller/index.md#event-EVENT_BEFORE_ACTION) | [`yii\base\ActionEvent`](/docs/api/yii/base/actionevent/index.md) | An event raised right before executing a controller action. Event name: `'beforeAction'`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |
| <span id="event-EVENT_AFTER_ACTION"></span>[`EVENT_AFTER_ACTION`](/docs/api/yii/base/controller/index.md#event-EVENT_AFTER_ACTION) | [`yii\base\ActionEvent`](/docs/api/yii/base/actionevent/index.md) | An event raised right after executing a controller action. Event name: `'afterAction'`. | [`yii\base\Controller`](/docs/api/yii/base/controller/index.md) |

## Method details

### actionIndex() <span id="method-actionIndex"></span>

```php
public function actionIndex(string|null $command = null): int
```

Displays available commands or the detailed information
about a particular command.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$command` | `string\|null` | The name of the command to show help about. If not provided, all available commands will be displayed. |

**Returns**

`int`: The exit status

**Throws**

- [`yii\console\Exception`](/docs/api/yii/console/exception/index.md): if the command for help is unknown

### actionList() <span id="method-actionList"></span>

```php
public function actionList(): mixed
```

List all available controllers and actions in machine readable format.

This is used for shell completion.

**Returns**

`mixed`

**Since**

2.0.11

### actionListActionOptions() <span id="method-actionListActionOptions"></span>

```php
public function actionListActionOptions(string $action): mixed
```

List all available options for the $action in machine readable format.

This is used for shell completion.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$action` | `string` | Route to action |

**Returns**

`mixed`

**Since**

2.0.11

### actionUsage() <span id="method-actionUsage"></span>

```php
public function actionUsage(string $action): mixed
```

Displays usage information for $action.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$action` | `string` | Route to action |

**Returns**

`mixed`

**Since**

2.0.11

### getActions() <span id="method-getActions"></span>

```php
public function getActions(yii\console\Controller $controller): array
```

Returns all available actions of the specified controller.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$controller` | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) | The controller instance |

**Returns**

`array`: All available action IDs.

### getCommands() <span id="method-getCommands"></span>

```php
public function getCommands(): array
```

Returns all available command names.

**Returns**

`array`: All available command names

### formatOptionAliases() <span id="method-formatOptionAliases"></span>

```php
protected function formatOptionAliases(yii\console\Controller $controller, string $option): string
```

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$controller` | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) | The controller instance |
| `$option` | `string` | The option name |

**Returns**

`string`: The formatted string for the alias argument or option

**Since**

2.0.8

### formatOptionHelp() <span id="method-formatOptionHelp"></span>

```php
protected function formatOptionHelp(string $name, bool $required, string $type, mixed $defaultValue, string $comment): string
```

Generates a well-formed string for an argument or option.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$name` | `string` | The name of the argument or option |
| `$required` | `bool` | Whether the argument is required |
| `$type` | `string` | The type of the option or argument |
| `$defaultValue` | `mixed` | The default value of the option or argument |
| `$comment` | `string` | Comment about the option or argument |

**Returns**

`string`: The formatted string for the argument or option

### getCommandDescriptions() <span id="method-getCommandDescriptions"></span>

```php
protected function getCommandDescriptions(): array
```

Returns an array of commands an their descriptions.

**Returns**

`array`: All available commands as keys and their description as values.

### getCommandHelp() <span id="method-getCommandHelp"></span>

```php
protected function getCommandHelp(yii\console\Controller $controller): mixed
```

Displays the overall information of the command.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$controller` | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) | The controller instance |

**Returns**

`mixed`

### getDefaultHelp() <span id="method-getDefaultHelp"></span>

```php
protected function getDefaultHelp(): mixed
```

Displays all available commands.

**Returns**

`mixed`

### getDefaultHelpHeader() <span id="method-getDefaultHelpHeader"></span>

```php
protected function getDefaultHelpHeader(): string
```

Return a default help header.

**Returns**

`string`: Default help header.

**Since**

2.0.11

### getModuleCommands() <span id="method-getModuleCommands"></span>

```php
protected function getModuleCommands(yii\base\Module $module): array
```

Returns available commands of a specified module.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$module` | [`yii\base\Module`](/docs/api/yii/base/module/index.md) | The module instance |

**Returns**

`array`: The available command names

### getScriptName() <span id="method-getScriptName"></span>

```php
protected function getScriptName(): string
```

**Returns**

`string`: The name of the cli script currently running.

### getSubCommandHelp() <span id="method-getSubCommandHelp"></span>

```php
protected function getSubCommandHelp(yii\console\Controller $controller, string $actionID): mixed
```

Displays the detailed information of a command action.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$controller` | [`yii\console\Controller`](/docs/api/yii/console/controller/index.md) | The controller instance |
| `$actionID` | `string` | Action ID |

**Returns**

`mixed`

**Throws**

- [`yii\console\Exception`](/docs/api/yii/console/exception/index.md): if the action does not exist

### validateControllerClass() <span id="method-validateControllerClass"></span>

```php
protected function validateControllerClass(string $controllerClass): bool
```

Validates if the given class is a valid console controller class.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$controllerClass` | `string` |  |

**Returns**

`bool`