www.aleph1.co.uk Git - yaffs-website/blob - vendor/drush/drush/examples/example.drush.yml

   1 #
   2 # Examples of valid statements for a Drush runtime config (drush.yml) file.
   3 #
   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.
   6 #
   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.
  10
  11 # Directories and Discovery
  12 #
  13 # Rename this file to drush.yml and copy it to one of the places listed below
  14 # in order of precedence:
  15 #
  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).
  22 #
  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.
  25 #
  26 # Version-specific configuration
  27 #
  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.
  32
  33 # Environment variables
  34 #
  35 # Your Drush config file may reference environment variables using a syntax like ${env.home}.
  36 # For example see the drush.paths examples below.
  37 #
  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.
  43
  44 drush:
  45   paths:
  46     # Specify config files to load.
  47     config:
  48       # Load any personal config files. Is silently skipped if not found. Filename must be drush.yml
  49       - ${env.home}/.drush/config/drush.yml
  50
  51
  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
  58     # command files.
  59     include:
  60       - '${env.home}/.drush/commands'
  61       - /usr/share/drush/commands
  62
  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.
  70     alias-path:
  71       - '${env.home}/.drush/sites'
  72       - /etc/drush/sites
  73
  74 # This section is for setting global options.
  75 options:
  76   # Specify the base_url that should be used when generating links.
  77   # Not recommended if you have more than one Drupal site on your system.
  78   uri: 'http://example.com/subdir'
  79
  80   # Specify your Drupal core base directory (useful if you use symlinks).
  81   # Not recommended if you have more than one Drupal root on your system.
  82   root: '/home/USER/workspace/drupal-6'
  83
  84   # Enable verbose mode.
  85   verbose: true
  86
  87 # This section is for setting command-specific options.
  88 command:
  89   sql:
  90     dump:
  91       options:
  92         # Uncomment to omit cache and similar tables (including during a sql:sync).
  93 #         structure-tables-key: common
  94   php:
  95     script:
  96       options:
  97         # Additional folders to search for scripts.
  98 #       script-path: 'sites/all/scripts:profiles/myprofile/scripts'
  99   core:
 100     rsync:
 101       options:
 102         # Ensure all rsync commands use verbose output.
 103 #       verbose: true
 104
 105   site:
 106     install:
 107       options:
 108         # Set a predetermined username and password when using site-install.
 109 #       account-name: 'alice'
 110 #       account-pass: 'secret'
 111
 112
 113 #
 114 # The sections below are configuration thats consulted by various commands, outside
 115 # of the option system.
 116 #
 117
 118 sql:
 119   # An explicit list of tables which should be included in sql-dump and sql-sync.
 120   tables:
 121     common:
 122       - user
 123       - permissions
 124       - role_permissions
 125       - role
 126   # List of tables whose *data* is skipped by the 'sql-dump' and 'sql-sync'
 127   # commands when the "--structure-tables-key=common" option is provided.
 128   # You may add specific tables to the existing array or add a new element.
 129   structure-tables:
 130     common:
 131       - cache
 132       - 'cache_*'
 133       - history
 134       - 'search_*'
 135       - 'sessions'
 136       - 'watchdog'
 137   # List of tables to be omitted entirely from SQL dumps made by the 'sql-dump'
 138   # and 'sql-sync' commands when the "--skip-tables-key=common" option is
 139   # provided on the command line.  This is useful if your database contains
 140   # non-Drupal tables used by some other application or during a migration for
 141   # example.  You may add new tables to the existing array or add a new element.
 142   skip-tables:
 143     common:
 144       - 'migration_*'
 145
 146 ssh:
 147   # Specify options to pass to ssh in backend invoke.  The default is to prohibit
 148   # password authentication, and is included here, so you may add additional
 149   # parameters without losing the default configuration.
 150   options: '-o PasswordAuthentication=no'
 151
 152 notify:
 153   # Notify when command takes more than 30 seconds.
 154   duration: 30
 155   # Specify a command to run. Defaults to Notification Center (OSX) or libnotify (Linux)
 156 # cmd: /path/to/program
 157   # See src/Commands/core/NotifyCommands.php for more configuration settings.
 158
 159 xh:
 160   # Start profiling via xhprof/tideways and show a link to the run report.
 161 # link: http://xhprof.local
 162   # See src/Commands/core/XhprofCommands.php for more configuration settings.