2.6 KiB
Console Tool
help
Displays help for a command
Usage
help [--format FORMAT] [--raw] [--] [<command_name>]
The help command displays help for a given command:
php app/console help list
You can also output the help in other formats by using the --format option:
php app/console help --format=xml list
To display the list of available commands, please use the list command.
Arguments
command_name
The command name
- Is required: no
- Is array: no
- Default:
'help'
Options
--format
The output format (txt, xml, json, or md)
- Accept value: yes
- Is value required: yes
- Is multiple: no
- Default:
'txt'
--raw
To output raw command help
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
--help|-h
Display this help message
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
--quiet|-q
Do not output any message
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
--verbose|-v|-vv|-vvv
Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
--version|-V
Display this application version
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
--ansi
Force ANSI output
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
--no-ansi
Disable ANSI output
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
--no-interaction|-n
Do not ask any interactive question
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
list
Lists commands
Usage
list [--raw] [--format FORMAT] [--] [<namespace>]
The list command lists all commands:
php app/console list
You can also display the commands for a specific namespace:
php app/console list test
You can also output the information in other formats by using the --format option:
php app/console list --format=xml
It's also possible to get raw list of commands (useful for embedding command runner):
php app/console list --raw
Arguments
namespace
The namespace name
- Is required: no
- Is array: no
- Default:
NULL
Options
--raw
To output raw command list
- Accept value: no
- Is value required: no
- Is multiple: no
- Default:
false
--format
The output format (txt, xml, json, or md)
- Accept value: yes
- Is value required: yes
- Is multiple: no
- Default:
'txt'