My Symfony application v1.0 =========================== * [`alias1`](#descriptorcommand1) * [`alias2`](#descriptorcommand1) * [`completion`](#completion) * [`help`](#help) * [`list`](#list) **command4:** * [`command4:descriptor`](#descriptorcommand4) **descriptor:** * [`descriptor:alias_command4`](#descriptorcommand4) * [`descriptor:command1`](#descriptorcommand1) * [`descriptor:command2`](#descriptorcommand2) * [`descriptor:command4`](#descriptorcommand4) `completion` ------------ Dump the shell completion script ### Usage * `completion [--debug] [--] [<shell>]` Dump the shell completion script ### Arguments #### `shell` The shell type (e.g. "bash"), the value of the "$SHELL" env var will be used if this is not given * Is required: no * Is array: no * Default: `NULL` ### Options #### `--debug` Tail the completion debug log * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--help|-h` Display help for the given command. When no command is given display help for the list command * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--quiet|-q` Do not output any message * Accept value: no * Is value required: no * Is multiple: no * Is negatable: 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 * Is negatable: no * Default: `false` #### `--version|-V` Display this application version * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--ansi|--no-ansi` Force (or disable --no-ansi) ANSI output * Accept value: no * Is value required: no * Is multiple: no * Is negatable: yes * Default: `NULL` #### `--no-interaction|-n` Do not ask any interactive question * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` `help` ------ Display help for a command ### Usage * `help [--format FORMAT] [--raw] [--] [<command_name>]` The help command displays help for a given command: %%PHP_SELF%% help list You can also output the help in other formats by using the --format option: %%PHP_SELF%% 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 * Is negatable: no * Default: `'txt'` #### `--raw` To output raw command help * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--help|-h` Display help for the given command. When no command is given display help for the list command * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--quiet|-q` Do not output any message * Accept value: no * Is value required: no * Is multiple: no * Is negatable: 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 * Is negatable: no * Default: `false` #### `--version|-V` Display this application version * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--ansi|--no-ansi` Force (or disable --no-ansi) ANSI output * Accept value: no * Is value required: no * Is multiple: no * Is negatable: yes * Default: `NULL` #### `--no-interaction|-n` Do not ask any interactive question * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` `list` ------ List commands ### Usage * `list [--raw] [--format FORMAT] [--short] [--] [<namespace>]` The list command lists all commands: %%PHP_SELF%% list You can also display the commands for a specific namespace: %%PHP_SELF%% list test You can also output the information in other formats by using the --format option: %%PHP_SELF%% list --format=xml It's also possible to get raw list of commands (useful for embedding command runner): %%PHP_SELF%% 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 * Is negatable: no * Default: `false` #### `--format` The output format (txt, xml, json, or md) * Accept value: yes * Is value required: yes * Is multiple: no * Is negatable: no * Default: `'txt'` #### `--short` To skip describing commands' arguments * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--help|-h` Display help for the given command. When no command is given display help for the list command * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--quiet|-q` Do not output any message * Accept value: no * Is value required: no * Is multiple: no * Is negatable: 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 * Is negatable: no * Default: `false` #### `--version|-V` Display this application version * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--ansi|--no-ansi` Force (or disable --no-ansi) ANSI output * Accept value: no * Is value required: no * Is multiple: no * Is negatable: yes * Default: `NULL` #### `--no-interaction|-n` Do not ask any interactive question * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` `descriptor:command1` --------------------- command 1 description ### Usage * `descriptor:command1` * `alias1` * `alias2` command 1 help ### Options #### `--help|-h` Display help for the given command. When no command is given display help for the list command * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--quiet|-q` Do not output any message * Accept value: no * Is value required: no * Is multiple: no * Is negatable: 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 * Is negatable: no * Default: `false` #### `--version|-V` Display this application version * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--ansi|--no-ansi` Force (or disable --no-ansi) ANSI output * Accept value: no * Is value required: no * Is multiple: no * Is negatable: yes * Default: `NULL` #### `--no-interaction|-n` Do not ask any interactive question * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` `descriptor:command2` --------------------- 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` * Is required: yes * Is array: no * Default: `NULL` ### Options #### `--option_name|-o` * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--help|-h` Display help for the given command. When no command is given display help for the list command * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--quiet|-q` Do not output any message * Accept value: no * Is value required: no * Is multiple: no * Is negatable: 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 * Is negatable: no * Default: `false` #### `--version|-V` Display this application version * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--ansi|--no-ansi` Force (or disable --no-ansi) ANSI output * Accept value: no * Is value required: no * Is multiple: no * Is negatable: yes * Default: `NULL` #### `--no-interaction|-n` Do not ask any interactive question * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` `descriptor:command4` --------------------- ### Usage * `descriptor:command4` * `descriptor:alias_command4` * `command4:descriptor` ### Options #### `--help|-h` Display help for the given command. When no command is given display help for the list command * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--quiet|-q` Do not output any message * Accept value: no * Is value required: no * Is multiple: no * Is negatable: 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 * Is negatable: no * Default: `false` #### `--version|-V` Display this application version * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false` #### `--ansi|--no-ansi` Force (or disable --no-ansi) ANSI output * Accept value: no * Is value required: no * Is multiple: no * Is negatable: yes * Default: `NULL` #### `--no-interaction|-n` Do not ask any interactive question * Accept value: no * Is value required: no * Is multiple: no * Is negatable: no * Default: `false`