Console Tool

• `help`
• `list`

help

Displays help for a command

Usage

• `help [--format FORMAT] [--raw] [--] [<command_name>]`

The <info>help</info> command displays help for a given command:

<info>php app/console help list</info>

You can also output the help in other formats by using the <comment>--format</comment> option:

<info>php app/console help --format=xml list</info>

To display the list of available commands, please use the <info>list</info> 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 <info>list</info> command lists all commands:

<info>php app/console list</info>

You can also display the commands for a specific namespace:

<info>php app/console list test</info>

You can also output the information in other formats by using the <comment>--format</comment> option:

<info>php app/console list --format=xml</info>

It's also possible to get raw list of commands (useful for embedding command runner):

<info>php app/console list --raw</info>

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'`