Skip to content

help

Display usage details for a command.

Examples

  • drush help pm:uninstall. Show help for a command.
  • drush help pmu. Show help for a command using an alias.
  • drush help --format=xml. Show all available commands in XML format.
  • drush help --format=json. All available commands, in JSON format.

Arguments

  • [command_name]. A command name

Options

  • --format[=FORMAT]. Format the result data. Available formats: csv,json,list,null,php,print-r,string,tsv,var_dump,var_export,xml,yaml [default: helpcli]
  • --include-field-labels.
  • --table-style[=TABLE-STYLE]. [default: compact]

Global Options

  • -v|vv|vvv, --verbose. Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • -y, --yes. Auto-accept the default for all user prompts. Equivalent to --no-interaction.
  • -l, --uri=URI. A base URL for building links and selecting a multi-site. Defaults to https://default.
  • To see all global options, run drush topic and pick the first choice.

Topics

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.