Skip to content

help

Tip

This command is part of Drupal core, not Drush. Use the Drupal issue queue for bug reports and feature requests.

Display help for a command

The %command.name% command displays help for a given command:

%command.invocation% list

You can also output the help in other formats by using the --format option:

%command.invocation% --format=xml list

To display the list of available commands, please use the list command.

Examples

Arguments

  • [command_name]. The command name

Options

  • --format=FORMAT. The output format (txt, xml, json, or md) [default: txt]
  • --raw. To output raw command help
  • --show-hidden-options. Show hidden options

Global Options

  • -h, --help. Display help for the given command. When no command is given display help for the list command
  • --silent. Do not output any message
  • -q, --quiet. Only errors are displayed. All other output is suppressed
  • -v|vv|vvv, --verbose. Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • -V, --version. Display this application version
  • --ansi. Force (or disable --no-ansi) ANSI output
  • --no-ansi. Negate the --ansi option.
  • -n, --no-interaction. Do not ask any interactive question
  • --url=URL. A base URL (e.g. example.com). Used for building links, selecting a multi-site, etc.
  • -e, --env=ENV. The Environment name. [default: prod]
  • --no-debug. Switches off debug mode.

Legend

  • An argument or option with square brackets is optional.
  • Any default value is listed at end of arg/option description.
  • An ellipsis indicates that an argument accepts multiple values separated by a space.