Table of Contents generated with DocToc
The Drupal Console is a CLI tool to generate boilerplate code, interact and debug Drupal 8.
Details of the latest version can be found on the Drupal Console project page under https://drupalconsole.com/.
All notable changes to this project will be documented in the releases page
The most up-to-date documentation can be found at http://docs.drupalconsole.com/.
More information about using this project at the official documentation.
PHP 5.5.9 or higher is required to use the Drupal Console application.
# Change directory to Drupal site
cd /path/to/drupal8.dev
# Download DrupalConsole
composer require drupal/console:~1.0 \
--prefer-dist \
--optimize-autoloader \
--sort-packages
Drupal 8 include some outdated libraries of Symfony 2.7.x, as result you get an old release of Drupal Console.
To fix that, execute the following command and you will get the latest release of Drupal Console.
composer update drupal/console --with-dependencies
composer create-project \
drupal-composer/drupal-project:8.x-dev \
drupal8.dev \
--prefer-dist \
--no-progress \
--no-interaction
# Run this in your terminal to get the latest version:
curl https://drupalconsole.com/installer -L -o drupal.phar
# Or if you don't have curl:
php -r "readfile('https://drupalconsole.com/installer');" > drupal.phar
# Accessing from anywhere on your system:
mv drupal.phar /usr/local/bin/drupal
# Apply executable permissions on the downloaded file:
chmod +x /usr/local/bin/drupal
# Copy configuration files.
drupal init --override
# Check and validate system requirements
drupal check
We highly recommend you to install the global executable, but if is not installed, then you can run DrupalConsole by:
Using default Drupal + DrupalConsole
vendor/bin/drupal
Using DrupalComposer
Change directory web, docroot or any other.
../vendor/bin/drupal
You can ask for support at Drupal Console gitter chat room http://bit.ly/console-support.
For information about how to run this project for development follow instructions at setup instructions.
# You can enable autocomplete by executing
drupal init
# Bash: Bash support depends on the http://bash-completion.alioth.debian.org/
# project which can be installed with your package manager of choice. Then add
# this line to your shell configuration file.
source "$HOME/.console/console.rc" 2>/dev/null
# Zsh: Add this line to your shell configuration file.
source "$HOME/.console/console.rc" 2>/dev/null
# Fish: Create a symbolic link
ln -s ~/.console/drupal.fish ~/.config/fish/completions/drupal.fish
Drupal is a registered trademark of Dries Buytaert.