drupal/console

The Drupal Console is a CLI tool to generate boilerplate code, interact and debug Drupal 8.

1.0.0-rc1 2016-09-27 12:45 UTC

README

Table of Contents generated with DocToc

Gitter Build Status Latest Stable Version Latest Unstable Version Software License SensioLabsInsight

The Drupal Console is a CLI tool to generate boilerplate code, interact and debug Drupal 8.

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.

Downloading 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

Downloading using DrupalComposer

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

Installing 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

# 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

Running Drupal Console

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 default Drupal + DrupalComposer Change directory web, docroot or any other.

../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

weKnow

Anexus

Indava

FFW

Drupal is a registered trademark of Dries Buytaert.