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
- Update DrupalConsole Launcher
- Run Drupal Console
- Supporting organizations
The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.
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
composer create-project \
drupal-composer/drupal-project:8.x-dev \
drupal8.dev \
--prefer-dist \
--no-progress \
--no-interaction
composer update drupal/console --with-dependencies
curl https://drupalconsole.com/installer -L -o drupal.phar
mv drupal.phar /usr/local/bin/drupal
chmod +x /usr/local/bin/drupal
NOTE: If you don't have curl you can try
php -r "readfile('https://drupalconsole.com/installer');" > drupal.phar
drupal self-update
NOTE:
drupalis the alias name you used when installed the DrupalConsole Launcher.
Using the DrupalConsole Launcher
drupal
We highly recommend you to install the global executable, but if is not installed, then you can run DrupalConsole by:
vendor/bin/drupal
# or
vendor/drupal/console/bin/drupal
# or
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.