Aquifer is a command line interface that makes it easy to scaffold, build, test, and deploy your Drupal websites. It provides a default set of tools that allow you to develop, and build Drupal sites using the Drush-make workflow. In addition, Aquifer ships with an extensions system that allows you to add additional tools to your project.
Aquifer is an npm module, installing it is relatively painless:
npm install -g aquifer
Aquifer should now be installed!
Aquifer has some helpful command line documentation. Run
aquifer --help to get a list of the commands that are availble to you at any given time. If you need documentation for a specific command, run
aquifer commandName --help.
If you need more in-depth documentation, checkout these wiki documents:
You can easily get started using Aquifer with just a couple commands.
To create an Aquifer-based Drupal project, run the following command:
aquifer create mySiteName
mySiteName directory will now contain an Aquifer project with an number of files/folders. For information on what each file and folder is, checkout this document in the wiki.
Aquifer projects build into a Drupal site root in the
build directory. To build the Drupal site, run:
This command will use Drush make and other tools to construct a Drupal site root, which will now be located in the
build folder, or whatever folder is specified in
aquifer.json in the
To add contrib modules to your project, simply edit the
drupal.make.yml file and add your contrib modules there. To learn more about Drush Make, see http://www.drush.org/en/master/make/
Aquifer makes optional use of Drush make lock files. If you make a change to
drupal.make.yml after you've already built your site, you'll need to add the
--refresh-lock flag to the
aquifer build command so that the lock file is recalculated when your site root is constructed.
For more details, visit the documentation page for the build system.
Custom themes should be added to the
themes folder within the Aquifer root, and likewise custom modules should be added to the
modules/custom folder, or
modules/features folder if the custom module is a feature. When you build the site, Aquifer will symlink those files into your site root.
Several extensions for Aquifer already exist, and you may find them useful:
Use the project, fork it, and submit PRs. We are responsive and will review them as soon as possible!
These humanoids (in alphabetical order) are responsible for creating and maintaining Aquifer:
Aquifer is a trademark of Four Kitchens, LLC. You are free to use the logo to promote the Aquifer product as long as you do not modify it in any way.