application_2.md
6.7 KB
My Symfony application
- alias1
- alias2
- help
- list
descriptor:
- descriptor:command1
- descriptor:command2
help
- Description: 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:
- Name: command_name
- Is required: no
- Is array: no
- Description: The command name
- Default:
'help'
Options:
format:
- Name:
--format - Shortcut:
- Accept value: yes
- Is value required: yes
- Is multiple: no
- Description: The output format (txt, xml, json, or md)
- Default:
'txt'
raw:
- Name:
--raw - Shortcut:
- Accept value: no
- Is value required: no
- Is multiple: no
- Description: To output raw command help
- Default:
false
help:
- Name:
--help - Shortcut:
-h - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Display this help message
- Default:
false
quiet:
- Name:
--quiet - Shortcut:
-q - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Do not output any message
- Default:
false
verbose:
- Name:
--verbose - Shortcut:
-v|-vv|-vvv - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
- Default:
false
version:
- Name:
--version - Shortcut:
-V - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Display this application version
- Default:
false
ansi:
- Name:
--ansi - Shortcut:
- Accept value: no
- Is value required: no
- Is multiple: no
- Description: Force ANSI output
- Default:
false
no-ansi:
- Name:
--no-ansi - Shortcut:
- Accept value: no
- Is value required: no
- Is multiple: no
- Description: Disable ANSI output
- Default:
false
no-interaction:
- Name:
--no-interaction - Shortcut:
-n - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Do not ask any interactive question
- Default:
false
list
- Description: 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:
- Name: namespace
- Is required: no
- Is array: no
- Description: The namespace name
- Default:
NULL
Options:
raw:
- Name:
--raw - Shortcut:
- Accept value: no
- Is value required: no
- Is multiple: no
- Description: To output raw command list
- Default:
false
format:
- Name:
--format - Shortcut:
- Accept value: yes
- Is value required: yes
- Is multiple: no
- Description: The output format (txt, xml, json, or md)
- Default:
'txt'
descriptor:command1
- Description: command 1 description
Usage:
descriptor:command1alias1alias2
command 1 help
Options:
help:
- Name:
--help - Shortcut:
-h - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Display this help message
- Default:
false
quiet:
- Name:
--quiet - Shortcut:
-q - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Do not output any message
- Default:
false
verbose:
- Name:
--verbose - Shortcut:
-v|-vv|-vvv - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
- Default:
false
version:
- Name:
--version - Shortcut:
-V - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Display this application version
- Default:
false
ansi:
- Name:
--ansi - Shortcut:
- Accept value: no
- Is value required: no
- Is multiple: no
- Description: Force ANSI output
- Default:
false
no-ansi:
- Name:
--no-ansi - Shortcut:
- Accept value: no
- Is value required: no
- Is multiple: no
- Description: Disable ANSI output
- Default:
false
no-interaction:
- Name:
--no-interaction - Shortcut:
-n - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Do not ask any interactive question
- Default:
false
descriptor:command2
- Description: command 2 description
Usage:
descriptor:command2 [-o|--option_name] [--] <argument_name>descriptor:command2 -o|--option_name <argument_name>descriptor:command2 <argument_name>
command 2 help
Arguments:
argument_name:
- Name: argument_name
- Is required: yes
- Is array: no
- Description:
- Default:
NULL
Options:
option_name:
- Name:
--option_name - Shortcut:
-o - Accept value: no
- Is value required: no
- Is multiple: no
- Description:
- Default:
false
help:
- Name:
--help - Shortcut:
-h - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Display this help message
- Default:
false
quiet:
- Name:
--quiet - Shortcut:
-q - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Do not output any message
- Default:
false
verbose:
- Name:
--verbose - Shortcut:
-v|-vv|-vvv - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
- Default:
false
version:
- Name:
--version - Shortcut:
-V - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Display this application version
- Default:
false
ansi:
- Name:
--ansi - Shortcut:
- Accept value: no
- Is value required: no
- Is multiple: no
- Description: Force ANSI output
- Default:
false
no-ansi:
- Name:
--no-ansi - Shortcut:
- Accept value: no
- Is value required: no
- Is multiple: no
- Description: Disable ANSI output
- Default:
false
no-interaction:
- Name:
--no-interaction - Shortcut:
-n - Accept value: no
- Is value required: no
- Is multiple: no
- Description: Do not ask any interactive question
- Default:
false