Skip to content

config:edit

Open a config file in a text editor. Edits are imported after closing editor.

Examples

  • drush config:edit image.style.large. Edit the image style configurations.
  • drush config:edit. Choose a config file to edit.
  • drush --bg config-edit image.style.large. Return to shell prompt as soon as the editor window opens.

Arguments

  • config_name. The config object name, for example system.site.

Options

  • --editor[=EDITOR]. A string of bash which launches user's preferred text editor. Defaults to ${VISUAL-${EDITOR-vi}}.
  • --bg. Launch editor in background process.

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.

Aliases

  • cedit
  • config-edit

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.