descriptor:
Dump the shell completion script
completion [--debug] [--] [<shell>]
The completion command dumps the shell completion script required to use shell autocompletion (currently only bash completion is supported).
Dump the script to a global completion file and restart your shell:
%%PHP_SELF%% completion bash | sudo tee /etc/bash_completion.d/%%COMMAND_NAME%%
Or dump the script to a local file and source it:
%%PHP_SELF%% completion bash > completion.sh
# source the file whenever you use the project
source completion.sh
# or add this line at the end of your "~/.bashrc" file:
source /path/to/completion.sh
Add this to the end of your shell configuration file (e.g. "~/.bashrc"):
eval "$(%%PHP_SELF_FULL%% completion bash)"
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
Tail the completion debug log
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
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
Do not output any message
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
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
Display this application version
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
Force (or disable --no-ansi) ANSI output
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: yes
- Default:
NULL
Do not ask any interactive question
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
Display help for a command
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.
The command name
- Is required: no
- Is array: no
- Default:
'help'
The output format (txt, xml, json, or md)
- Accept value: yes
- Is value required: yes
- Is multiple: no
- Is negatable: no
- Default:
'txt'
To output raw command help
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
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
Do not output any message
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
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
Display this application version
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
Force (or disable --no-ansi) ANSI output
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: yes
- Default:
NULL
Do not ask any interactive question
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
List commands
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
The namespace name
- Is required: no
- Is array: no
- Default:
NULL
To output raw command list
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
The output format (txt, xml, json, or md)
- Accept value: yes
- Is value required: yes
- Is multiple: no
- Is negatable: no
- Default:
'txt'
To skip describing commands' arguments
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
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
Do not output any message
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
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
Display this application version
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
Force (or disable --no-ansi) ANSI output
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: yes
- Default:
NULL
Do not ask any interactive question
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
command åèä description
descriptor:åèä [-o|--option_åèä] [--] <argument_åèä>
descriptor:åèä -o|--option_name <argument_name>
descriptor:åèä <argument_name>
command åèä help
- Is required: yes
- Is array: no
- Default:
NULL
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
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
Do not output any message
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
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
Display this application version
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false
Force (or disable --no-ansi) ANSI output
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: yes
- Default:
NULL
Do not ask any interactive question
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default:
false