drupal / console
The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.
Fund package maintenance!
Open Collective
Installs: 14 869 847
Dependents: 234
Suggesters: 3
Security: 0
Stars: 938
Watchers: 61
Forks: 557
Open Issues: 261
Requires
- php: >=7.0.8
- alchemy/zippy: ~0.4
- composer/installers: ~1.0
- doctrine/annotations: ^1.2
- doctrine/collections: ^1.3
- drupal/console-core: ^1.9.8
- drupal/console-extend-plugin: ~0.9.5
- psy/psysh: 0.6.* || ~0.8
- symfony/css-selector: ~3.0|~4.0
- symfony/dom-crawler: ~3.0|~4.0
- symfony/expression-language: ~3.0|~4.0
- symfony/http-foundation: ~3.0|~4.0
Suggests
- symfony/thanks: Thank your favorite PHP projects on GitHub using the CLI
- vlucas/phpdotenv: Loads environment variables from .env to getenv(), $_ENV and $_SERVER automagically
- dev-master
- 3807.x-dev
- 1.9.10
- 1.9.9
- 1.9.8
- 1.9.7
- 1.9.5
- 1.9.4
- 1.9.3
- 1.9.2
- 1.9.1
- v1.9.0
- 1.8.0
- 1.7.0
- 1.6.1
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.2
- 1.0.1
- 1.0.0
- 1.0.0-rc26
- 1.0.0-rc25
- 1.0.0-rc24
- 1.0.0-rc23
- 1.0.0-rc22
- 1.0.0-rc21
- 1.0.0-rc20
- 1.0.0-rc19
- 1.0.0-rc18
- 1.0.0-rc17
- 1.0.0-rc16
- 1.0.0-rc15
- 1.0.0-rc14
- 1.0.0-rc13
- 1.0.0-rc12
- 1.0.0-rc11
- 1.0.0-rc10
- 1.0.0-rc9
- 1.0.0-rc8
- 1.0.0-rc7
- 1.0.0-rc6
- 1.0.0-rc5
- 1.0.0-rc4
- 1.0.0-rc3
- 1.0.0-rc2
- 1.0.0-rc1
- 1.0.0-beta5
- 1.0.0-beta4
- 1.0.0-beta3
- 1.0.0-beta2
- 1.0.0-beta1
- 1.0.0-alpha2
- 1.0.0-alpha1
- 0.11.3
- 0.11.2
- 0.11.1
- 0.11.0
- 0.10.15
- 0.10.14
- 0.10.13
- 0.10.12
- 0.10.11
- 0.10.10
- 0.10.9
- 0.10.8
- 0.10.7
- 0.10.6
- 0.10.5
- 0.10.4
- 0.10.3
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.10
- 0.9.9
- 0.9.8
- 0.9.7
- 0.9.6
- 0.9.5
- 0.9.4
- 0.9.3
- 0.9.2
- 0.9.1
- 0.9.0
- 0.8.4
- 0.8.3
- 0.8.2
- 0.8.1
- 0.8.0
- 0.7.15
- 0.7.14
- 0.7.13
- 0.7.12
- 0.7.10
- 0.7.9
- 0.7.8
- 0.7.7
- 0.7.6
- 0.7.5
- 0.7.4
- 0.7.3
- 0.7.2
- 0.7.1
- 0.7.0
- 0.6.5
- 0.6.4
- 0.6.3
- 0.6.2
- 0.6.1
- 0.6.0
- 0.5.2
- 0.5.1
- 0.5.0
- 0.3.1
- 0.3.0
- 0.2.19
- 0.2.18
- 0.2.17
- 0.2.16
- 0.2.15
- 0.2.14
- 0.2.13
- 0.2.12
- 0.2.11
- 0.2.10
- 0.2.9
- 0.2.8
- 0.2.7
- 0.2.6
- 0.2.5
- 0.2.4
- 0.2.3
- 0.2.2
- 0.2.1
- 0.2.0
- 0.1.0
- dev-feat/drupal9
- dev-update-version-1-9-7
- dev-tag-1-9-7
- dev-feature/d9
- dev-revert-3880-master
- dev-load-commands-from-profile
- dev-test-suite
This package is auto-updated.
Last update: 2025-04-22 19:30:05 UTC
README
Sunsetting the project
Drupal Console became essential for thousands of developers worldwide with over 15 million downloads, support for 19 languages, and 200+ commands. It significantly improved Drupal 8+ development workflows and reduced project delivery times.
There is no need to maintain the project any longer, and that’s a good thing. As Drupal 8 matured, the ecosystem evolved with it. Drush embraced many of the interactive features that once made Drupal Console stand out, while also adopting the modern PHP and Symfony components that defined the new era of Drupal.
The goal was never to compete, it was to modernize the CLI in Drupal, and we can say: mission accomplished. So today, there’s no need to maintain two different tools because Drush evolved, and picked up the torch. The mission was a success.
None of this could have been possible without the incredible support of the community. It’s amazing how a project that started as a Drupal 8 learning exercise grew to the point to be considered for the Drupal community a must-have tool to accelerate Drupal 8 development.
Thank you all for using the project, for attending talks at events, for providing feedback, creating issues, and sending pull requests, for spreading the word and love about the project sending a tweet, writing a blog post or recording a video, and very special thanks to all of the awesome contributors.
So the project is sunsetting, not because it failed, but because it succeeded.
Table of Contents generated with DocToc
- Drupal Console
- Required PHP version
- Drupal Console documentation
- Download Drupal Console
- Run Drupal Console
- Contributors
- 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 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
Supporting Organizations
Drupal is a registered trademark of Dries Buytaert.