2 # Examples of valid statements for a Drush runtime config (drush.yml) file.
4 # Use this file to cut down on typing out lengthy and repetitive command line
5 # options in the Drush commands you use and to avoid mistakes.
7 # The Drush configuration system has been factored out and shared with
8 # the world at https://github.com/consolidation/config. Feel free to use it
9 # for your projects. Lots more usage information is there.
11 # Directories and Discovery
13 # Rename this file to drush.yml and copy it to one of the places listed below
14 # in order of precedence:
16 # 1. Drupal site folder (e.g. sites/{default|example.com}/drush.yml).
17 # 2. Drupal /drush and sites/all/drush folders, or the /drush folder
18 # in the directory above the Drupal root.
19 # 3. In any location, as specified by the --config (-c) option.
20 # 4. User's .drush folder (i.e. ~/.drush/drush.yml).
21 # 5. System wide configuration folder (e.g. /etc/drush/drush.yml or C:\ProgramData\Drush\drush.yml).
23 # If a configuration file is found in any of the above locations, it will be
24 # loaded and merged with other configuration files in the search list.
26 # Version-specific configuration
28 # Drush started using yml files for configuration in version 9; earlier versions
29 # of Drush will never attempt to load a drush.yml file. It is also possible
30 # to limit the version of Drush that will load a configuration file by placing
31 # the Drush major version number in the filename, e.g. drush9.yml.
33 # Environment variables
35 # Your Drush config file may reference environment variables using a syntax like ${env.home}.
36 # For example see the drush.paths examples below.
38 # An alternative way to populate Drush configuration is to define environment variables that
39 # correspond to config keys. For example, to populate the options.uri config item,
40 # create an environment variable `DRUSH_OPTIONS_URI=http://example.com`.
41 # As you can see, variable names should be uppercased, prefixed with `DRUSH_`, and periods
42 # replaced with dashes.
46 # Specify config files to load.
48 # Load any personal config files. Is silently skipped if not found. Filename must be drush.yml
49 - ${env.home}/.drush/config/drush.yml
52 # Specify folders to search for Drush command files. These locations
53 # are always merged with include paths defined on the command line or
54 # in other configuration files. On the command line, paths may be separated
55 # by a colon (:) on Unix-based systems or a semi-colon (;) on Windows,
56 # or multiple --include options may be provided. Drush 8 and earlier did
57 # a deep search in ~/.drush and /usr/share/drush/commands when loading
60 - '${env.home}/.drush/commands'
61 - /usr/share/drush/commands
63 # Specify the folders to search for Drush alias files (*.site.yml). These
64 # locations are always merged with alias paths defined on the command line
65 # or in other configuration files. On the command line, paths may be
66 # separated by a colon (:) on Unix-based systems or a semi-colon (;) on
67 # Windows, or multiple --alias-path options may be provided. Note that
68 # Drush 8 and earlier did a deep search in ~/.drush and /etc/drush when
69 # loading alias files.
71 - '${env.home}/.drush/sites'
74 # Specify a folder where Drush should store its file based caches. If unspecified, defaults to $HOME/.drush.
75 #cache-directory: /tmp/.drush
77 # This section is for setting global options.
79 # Specify the base_url that should be used when generating links.
80 # Not recommended if you have more than one Drupal site on your system.
81 # uri: 'http://example.com/subdir'
83 # Specify your Drupal core base directory (useful if you use symlinks).
84 # Not recommended if you have more than one Drupal root on your system.
85 # root: '/home/USER/workspace/drupal-6'
87 # Enable verbose mode.
90 # This section is for setting command-specific options.
95 # Uncomment to omit cache and similar tables (including during a sql:sync).
96 # structure-tables-key: common
100 # Additional folders to search for scripts.
101 # script-path: 'sites/all/scripts:profiles/myprofile/scripts'
105 # Ensure all rsync commands use verbose output.
111 # Set a predetermined username and password when using site-install.
112 # account-name: 'alice'
113 # account-pass: 'secret'
117 # The sections below are configuration thats consulted by various commands, outside
118 # of the option system.
122 # An explicit list of tables which should be included in sql-dump and sql-sync.
129 # List of tables whose *data* is skipped by the 'sql-dump' and 'sql-sync'
130 # commands when the "--structure-tables-key=common" option is provided.
131 # You may add specific tables to the existing array or add a new element.
140 # List of tables to be omitted entirely from SQL dumps made by the 'sql-dump'
141 # and 'sql-sync' commands when the "--skip-tables-key=common" option is
142 # provided on the command line. This is useful if your database contains
143 # non-Drupal tables used by some other application or during a migration for
144 # example. You may add new tables to the existing array or add a new element.
150 # Specify options to pass to ssh in backend invoke. The default is to prohibit
151 # password authentication, and is included here, so you may add additional
152 # parameters without losing the default configuration.
153 options: '-o PasswordAuthentication=no'
156 # Notify when command takes more than 30 seconds.
158 # Specify a command to run. Defaults to Notification Center (OSX) or libnotify (Linux)
159 # cmd: /path/to/program
160 # See src/Commands/core/NotifyCommands.php for more configuration settings.
163 # Start profiling via xhprof/tideways and show a link to the run report.
164 # link: http://xhprof.local
165 # See src/Commands/core/XhprofCommands.php for more configuration settings.