/
example.drushrc.php
311 lines (274 loc) · 13.8 KB
/
example.drushrc.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<?php
/**
* @file
* Examples of valid statements for a Drush runtime config (drushrc) file.
*
* Use this file to cut down on typing out lengthy and repetitive command line
* options in the Drush commands you use and to avoid mistakes.
*
* Rename this file to drushrc.php and optionally copy it to one of the places
* listed below in order of precedence:
*
* 1. Drupal site folder (e.g. sites/{default|example.com}/drushrc.php).
* 2. Drupal /drush and sites/all/drush folders, or the /drush folder
* in the directory above the Drupal root.
* 3. In any location, as specified by the --config (-c) option.
* 4. User's .drush folder (i.e. ~/.drush/drushrc.php).
* 5. System wide configuration folder (e.g. /etc/drush/drushrc.php).
* 6. Drush installation folder.
*
* If a configuration file is found in any of the above locations, it will be
* loaded and merged with other configuration files in the search list.
*
* If you have some configuration options that are specific to a particular
* version of Drush, then you may place them in a file called drush5rc.php.
* The version-specific file is loaded in addition to, and after, the general-
* purpose drushrc file. Version-specific configuration files can be placed
* in any of the locations specified above.
*
* IMPORTANT NOTE regarding configuration file on Windows:
*
* For Windows 7, Windows Vista, Windows Server 2008 and later versions is the
* system window configuration folder C:\ProgramData\Drush. For previous
* versions of Windows is the folder C:\Documents and Settings\All Users\Drush.
*
* IMPORTANT NOTE on configuration file loading:
*
* At its core, Drush works by "bootstrapping" the Drupal environment in very
* much the same way that is done during a normal page request from the web
* server, so most Drush commands run in the context of a fully-initialized
* website.
*
* Configuration files are loaded in the reverse order they are shown above. All
* configuration files are loaded in the first bootstrapping phase, but
* a configuration file in a specific Drupal site folder other than the default
* (eg, sites/example.com/drushrc.php) will not be loaded unless a specific
* Drupal site is selected. However, it _will_ be loaded if a site is selected
* (either via the current working directory or by use of the --uri option),
* even if the Drush command being run does not bootstrap to the Drupal Site
* phase.
*
* The Drush commands 'rsync' and 'sql-sync' are special cases. These commands
* will load the configuration file for the site specified by the source
* parameter; however, they do not load the configuration file for the site
* specified by the destination parameter, nor do they load configuration files
* for remote sites.
*
* See `drush topic docs-bootstrap` for more information on how bootstrapping
* affects the loading of Drush configuration files.
*/
// Specify the base_url that should be used when generating links
# $options['l'] = 'http://example.com/subdir';
// Specify your Drupal core base directory (useful if you use symlinks).
# $options['r'] = '/home/USER/workspace/drupal-6';
/**
* Useful shell aliases:
*
* Drush shell aliases act similar to git aliases. For best results, define
* aliases in one of the drushrc file locations between #3 through #6 above.
* More information on shell aliases can be found via:
* `drush topic docs-shell-aliases` on the command line.
*
* @see https://git.wiki.kernel.org/index.php/Aliases#Advanced
*/
# $options['shell-aliases']['pull'] = '!git pull'; // We've all done it.
# $options['shell-aliases']['pulldb'] = '!git pull && drush updatedb';
# $options['shell-aliases']['noncore'] = 'pm-list --no-core';
# $options['shell-aliases']['self-alias'] = 'site-alias @self --with-db --alias-name=new';
# $options['shell-aliases']['site-get'] = '@none php-eval "return drush_sitealias_site_get();"';
// Add a 'pm-clone' to simplify git cloning from drupal.org.
# $options['shell-aliases']['pm-clone'] = 'pm-download --gitusername=YOURUSERNAME --package-handler=git_drupalorg';
// Save a sanitized sql dump. Customize alias names and --result-file.
# $options['shell-aliases']['sql-transfer'] = 'drush sql-sync @source @temp --sanitize && drush @temp sql-dump --result-file=/example && drush @temp sql-drop';
# Drupal 8.
# $options['shell-aliases']['offline'] = 'drush sset system.maintenance_mode 1 --input-format=integer';
# $options['shell-aliases']['online'] = 'drush sset system.maintenance_mode 0 --input-format=integer';
# $options['shell-aliases']['cpull'] = 'config-pull @example.prod @self --label=vcs';
# $options['shell-aliases']['wipe'] = 'cache-rebuild';
#Drupal 7 (and 6).
# $options['shell-aliases']['offline'] = 'variable-set -y --always-set maintenance_mode 1';
# $options['shell-aliases']['online'] = 'variable-delete -y --exact maintenance_mode';
# $options['shell-aliases']['wipe'] = 'cache-clear all';
# $options['shell-aliases']['dis-all'] = '!drush -y dis `drush pml --status=enabled --type=module --no-core --pipe`';
# $options['shell-aliases']['unsuck'] = 'pm-disable -y overlay,dashboard';
/**
* Load a drushrc.php configuration file from the current working directory.
*/
# $options['config'][] = './drushrc.php';
/**
* By default, Drush will download projects compatible with the current
* version of Drupal, or, if no Drupal site is specified, then the Drupal-8
* version of the project is downloaded. Set default-major to select a
* different default version.
*/
# $options['default-major'] = 7;
// Clone extensions (modules, themes, etc.) from drupal.org via 'pm-download'.
# $options['package-handler'] = 'git_drupalorg';
/**
* Specify folders to search for Drush command files (*.drush.inc). These
* values are always merged with include paths defined on the command line or
* in other configuration files. On the command line, paths may be separated
* by a colon (:) on Unix-based systems or a semi-colon (;) on Windows.
*/
# $options['include'] = array('/path/to/commands','/path2/to/more/commands');
/**
* Specify the modules to ignore when searching for command files (*.drush.inc)
* inside a Drupal site.
*/
# $options['ignored-modules'] = array('module1', 'module2');
/**
* Specify the folders to search for Drush alias files (*.alias.drushrc.php and
* *.aliases.drushrc.php). These values are always merged with alias paths
* defined on the command line or in other configuration files. On the command
* line, paths may be separated by a colon (:) on Unix-based systems or a
* semi-colon (;) on Windows.
*/
# $options['alias-path'] = array('/path/to/aliases','/path2/to/more/aliases');
/**
* Specify the max depth to search in the alias paths. (Default: TRUE)
* When TRUE, the directory scan will recurse the entire tree
* starting at the provided directory. When FALSE, only files
* in the provided directory are returned. Integer values
* limit the depth of the traversal, with zero being treated
* identically to FALSE, and 1 limiting the traversal to the
* provided directory and its immediate children only, and so on.
*/
# $options['alias-search-depth'] = TRUE;
/**
* Specify the filename and path where 'sql-dump' should store backups of
* database dumps. The default is to dump to STDOUT, however if this option is
* set in a drushrc.php file, the default behaviour can be achieved by
* specifying a value of FALSE ("--result-file=0" on the command line). Two
* substitution tokens are available: @DATABASE is replaced with the name of the
* database being dumped, and @DATE is replaced with the current time and date
* of the dump of the form: YYYYMMDD_HHMMSS. A value of TRUE ("--result-file=1"
* on the command line) will cause 'sql-dump' to use the same temporary backup
* location as 'pm-updatecode'.
*/
# $options['result-file'] = TRUE;
# $options['result-file'] = '/path/to/backup/dir/@DATABASE_@DATE.sql';
// Notify user via Notification Center (OSX) or libnotify (Linux) when command
// takes more than 30 seconds. See global options for more configuration.
# $options['notify'] = 30;
// Enable verbose mode.
# $options['v'] = 1;
// Show database passwords in 'status' and 'sql-conf' commands.
# $options['show-passwords'] = 1;
/**
* Specify the logging level for PHP notices. Defaults to "notice". Set to
* "warning" when doing Drush development. Also make sure that error_reporting
* is set to E_ALL in your php configuration file. See `drush status` for the
* path to your php.ini file.
*/
# $options['php-notices'] = 'warning';
/**
* Specify the error handling of recoverable errors (E_RECOVERABLE_ERROR).
* Defaults to 1 and will stop execution of Drush.
* When set to 0, execution will continue.
*/
# $options['halt-on-error'] = 0;
/**
* Specify options to pass to ssh in backend invoke. The default is to prohibit
* password authentication, and is included here, so you may add additional
* parameters without losing the default configuration.
*/
# $options['ssh-options'] = '-o PasswordAuthentication=no';
// Set 'remote-os' to 'Windows' to make Drush use Windows shell escape rules
// for remote sites that do not have an 'os' item set.
# $options['remote-os'] = 'Linux';
// By default, unknown options are disallowed and result in an error. Change
// them to issue only a warning and let command proceed.
# $options['strict'] = FALSE;
/**
* Drush requires at least rsync version 2.6.9 for some functions to work
* correctly. rsync version 2.6.8 or earlier may give the following error
* message: "--remove-source-files: unknown option". To fix this, set
* $options['rsync-version'] = '2.6.8'; (replace with the lowest version of
* rsync installed on any system you are using with Drush). Note that this
* option can also be set in a site alias, which is the preferred solution if
* newer versions of rsync are available on some of the systems you use.
* See: http://drupal.org/node/955092
*/
# $options['rsync-version'] = '2.6.9';
/**
* The output charset suitable to pass to the iconv PHP function's out_charset
* parameter.
*
* Drush will convert its output from UTF-8 to the charset specified here. It
* is possible to use //TRANSLIT and //IGNORE charset name suffixes (see iconv
* documentation). If not defined, conversion will not be performed.
*/
# $options['output_charset'] = 'ISO-8859-1';
# $options['output_charset'] = 'KOI8-R//IGNORE';
# $options['output_charset'] = 'ISO-8859-1//TRANSLIT';
/**
* Multiple-site execution options:
*
* Some drush commands such as 'sql-sync' are intended for or capable of being
* executed on multiple sites or server environments and will pass along the
* options specified here to all instances of the command being executed.
*/
/**
* By default, Drush will prepend the name of the site to the output of any
* multiple-site command execution. To disable this behavior, set the
* "--no-label" option.
*/
# $options['no-label'] = TRUE;
/**
* An explicit list of tables which should be included in sql-dump and sql-sync.
*/
# $options['tables']['common'] = array('user', 'permissions', 'role_permission', 'role');
/**
* List of tables whose *data* is skipped by the 'sql-dump' and 'sql-sync'
* commands when the "--structure-tables-key=common" option is provided.
* You may add specific tables to the existing array or add a new element.
*/
# $options['structure-tables']['common'] = array('cache', 'cache_*', 'history', 'search_*', 'sessions', 'watchdog');
/**
* List of tables to be omitted entirely from SQL dumps made by the 'sql-dump'
* and 'sql-sync' commands when the "--skip-tables-key=common" option is
* provided on the command line. This is useful if your database contains
* non-Drupal tables used by some other application or during a migration for
* example. You may add new tables to the existing array or add a new element.
*/
# $options['skip-tables']['common'] = array('migration_*');
/**
* Override specific entries in Drupal's variable system or settings.php (D6/D7 only).
*/
# $options['variables']['site_name'] = 'My Drupal site';
# $options['variables']['theme_default'] = 'minnelli';
# $options['variables']['anonymous'] = 'Visitor';
/**
* Command-specific execution options:
*
* Most execution options can be shared between multiple Drush commands; these
* are specified as top-level elements of the $options array in the prior
* examples above. On the other hand, other options are command-specific, and,
* in some cases, a shared option needs a different configuration depending on
* which command is being executing.
*
* To define options that are only applicable to certain commands, make an entry
* in the $command-specific array as shown below. The name of the command may
* be either the command's full name or any of the command's aliases.
*
* Options defined here will be overridden by options of the same name on the
* command line. Unary flags such as "--verbose" are overridden via special
* "--no-xxx" options (e.g. "--no-verbose").
*
* Limitation: If 'verbose' is set in a command-specific option, it must be
* cleared by '--no-verbose', not '--no-v', and visa-versa.
*/
// Ensure all rsync commands use verbose output.
# $command_specific['rsync'] = array('verbose' => TRUE);
// Prevent drush ssh command from adding a cd to Drupal root before provided command.
# $command_specific['ssh'] = array('cd' => FALSE);
// Additional folders to search for scripts.
// Separate by : (Unix-based systems) or ; (Windows).
# $command_specific['script']['script-path'] = 'sites/all/scripts:profiles/myprofile/scripts';
// Always show release notes when running pm-update or pm-updatecode.
# $command_specific['pm-update'] = array('notes' => TRUE);
# $command_specific['pm-updatecode'] = array('notes' => TRUE);
// Set a predetermined username and password when using site-install.
# $command_specific['site-install'] = array('account-name' => 'alice', 'account-pass' => 'secret');
// Use Drupal version specific CLI history instead of per site.
# $command_specific['core-cli'] = array('version-history' => TRUE);