Catalyst provides a variety of help options for your CLI command executions. You can use these options any time you require help with your CLI operations, such as for fetching the command reference or the list of options available for a particular command.

Command Reference Help

You can easily obtain the command reference that lists all the available CLI commands with their syntax, along with brief descriptions of the commands and the actions they perform. This will also list the general CLI options that can be used with any CLI command, with their descriptions.

To view the command reference, you can execute the following command from any directory:

$ catalyst help

 

This will display all the commands and options available in the CLI version that you have installed.

Command Syntax and Options Help

You can also get help with a specific command. This provides a brief usage description of the command's purpose, and lists the options that are available for the command and their syntaxes. You can access this help by specifying the command after catalyst help.

For example, if you require help with catalyst serve, you can execute the following command:

$ catalyst help serve

 

This will provide a brief description of the command, and list the options that it supports.

The Help Option

You can also obtain help for a specific command by typing in the command and following it with a -h or --help option. This performs the same functionality as the command syntax and options help mentioned in the previous section.

For example, if you require help with the catalyst functions:shell command, you can execute the following command:

$ catalyst functions:shell --help|-h

 

This is discussed in the CLI options document in detail.

 

Context Sensitive Help

Catalyst also provides context sensitive help when you encounter an error during a CLI command execution. Catalyst will not only specify the reason behind the error, but it will also provide you help with the actions you can take to rectify or prevent the error, as well as a help link to the documentation of the particular action.

This is discussed in the CLI Context Sensitive Help page in detail, which also includes a list of possible errors that you could encounter during each of your command executions.