Table of Contents generated with DocToc

• Drupal Console
  • Required PHP version
  • Drupal Console documentation
  • Download as new dependency
  • Download using DrupalComposer
  • Update DrupalConsole
  • Install Drupal Console Launcher
  • Run Drupal Console
  • Supporting organizations

Drupal Console

The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.

Latest Version

Details of the latest version can be found on the Drupal Console project page under https://drupalconsole.com/.

Releases Page

All notable changes to this project will be documented in the releases page

Documentation

The most up-to-date documentation can be found at http://docs.drupalconsole.com/.

More information about using this project at the official documentation.

Required PHP Version

PHP 5.5.9 or higher is required to use the Drupal Console application.

Download as new dependency

# Change directory to Drupal site
cd /path/to/drupal8.dev

# Download DrupalConsole
composer require drupal/console:~1.0 \
--prefer-dist \
--optimize-autoloader \
--sort-packages

Download using DrupalComposer

composer create-project \
drupal-composer/drupal-project:8.x-dev \
drupal8.dev \
--prefer-dist \
--no-progress \
--no-interaction

Update DrupalConsole

composer update drupal/console --with-dependencies

Install Drupal Console Launcher

# 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

Run Drupal Console

Using the DrupalConsole Launcher

drupal

NOTE: If using a DrupalComposer make sure you execute the init command and answer yest to Copy at current directory console/config.yml? (yes/no) [yes]: question.

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 you can also change directory web, docroot and

../vendor/bin/drupal

Drupal Console Support

You can ask for support at Drupal Console gitter chat room http://bit.ly/console-support.

Getting The Project To Contribute

For information about how to run this project for development follow instructions at setup instructions.

Enabling Autocomplete

# 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

Supporting Organizations

Drupal is a registered trademark of Dries Buytaert.