drupal/console

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

Fund package maintenance!
Open Collective

Installs: 14 727 803

Dependents: 242

Suggesters: 3

Security: 0

Stars: 938

Watchers: 62

Forks: 557

Open Issues: 260

1.9.10 2022-10-02 14:56 UTC

README

Table of Contents generated with DocToc

Drupal Console

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

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 https://drupalconsole.com/docs/.

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

Install Drupal Console Using Composer

Install Drupal Console Launcher

Installing Drupal Console on Windows

Run

Using the DrupalConsole Launcher

drupal

We highly recommend you to install the global executable, but if is not installed, you can run Drupal Console depending on your installation by executing:

vendor/bin/drupal
# or
vendor/drupal/console/bin/drupal
# or
bin/drupal

Drupal Console Support

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

Contribute to Drupal Console

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

Contributors

Full list of contributors

Supporting Organizations

All supporting organizations

Drupal is a registered trademark of Dries Buytaert.