www.aleph1.co.uk Git - yaffs-website/blob - vendor/drupal/console/README.md

   1 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
   2 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
   3 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
   4
   5   - [Drupal Console](#drupal-console)
   6   - [Required PHP version](#required-php-version)
   7   - [Drupal Console documentation](#documentation)
   8   - [Download as new dependency](#download-as-new-dependency)
   9   - [Download using DrupalComposer](#download-using-drupalcomposer)
  10   - [Update DrupalConsole](#update-drupalconsole)
  11   - [Install Drupal Console Launcher](#install-drupal-console-launcher)
  12   - [Update DrupalConsole Launcher](#update-drupalconsole-launcher)
  13   - [Run Drupal Console](#running-drupal-console)
  14   - [Supporting organizations](#supporting-organizations)
  15
  16 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
  17
  18 Drupal Console
  19 =============================================
  20
  21 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hechoendrupal/DrupalConsole)
  22 [![Build Status](https://travis-ci.org/hechoendrupal/DrupalConsole.svg?branch=master)](https://travis-ci.org/hechoendrupal/DrupalConsole)
  23 [![Latest Stable Version](https://poser.pugx.org/drupal/console/v/stable.svg)](https://packagist.org/packages/drupal/console)
  24 [![Latest Unstable Version](https://poser.pugx.org/drupal/console/v/unstable.svg)](https://packagist.org/packages/drupal/console)
  25 [![Software License](https://img.shields.io/badge/license-GPL%202.0+-blue.svg)](https://packagist.org/packages/drupal/console)
  26 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/d0f089ff-a6e9-4ba4-b353-cb68173c7d90/mini.png)](https://insight.sensiolabs.com/projects/d0f089ff-a6e9-4ba4-b353-cb68173c7d90)
  27
  28 The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.
  29
  30 ## Latest Version
  31 Details of the latest version can be found on the Drupal Console project page under https://drupalconsole.com/.
  32
  33 ## Releases Page
  34 All notable changes to this project will be documented in the [releases page](https://github.com/hechoendrupal/DrupalConsole/releases)
  35
  36 ## Documentation
  37 The most up-to-date documentation can be found at [http://docs.drupalconsole.com/](http://docs.drupalconsole.com/).
  38
  39 More information about using this project at the [official documentation](http://docs.drupalconsole.com/en/using/project.html).
  40
  41 ## Required PHP Version
  42 PHP 5.5.9 or higher is required to use the Drupal Console application.
  43
  44 ## Download as new dependency
  45 ```
  46 # Change directory to Drupal site
  47 cd /path/to/drupal8.dev
  48
  49 # Download DrupalConsole
  50 composer require drupal/console:~1.0 \
  51 --prefer-dist \
  52 --optimize-autoloader \
  53 --sort-packages
  54 ```
  55
  56 ## Download using DrupalComposer
  57 ```
  58 composer create-project \
  59 drupal-composer/drupal-project:8.x-dev \
  60 drupal8.dev \
  61 --prefer-dist \
  62 --no-progress \
  63 --no-interaction
  64 ```
  65
  66 ## Update DrupalConsole
  67
  68 ```
  69 composer update drupal/console --with-dependencies
  70 ```
  71
  72 ## Install Drupal Console Launcher
  73 ```
  74 curl https://drupalconsole.com/installer -L -o drupal.phar
  75 mv drupal.phar /usr/local/bin/drupal
  76 chmod +x /usr/local/bin/drupal
  77 ```
  78 NOTE: If you don't have curl you can try
  79 ```
  80 php -r "readfile('https://drupalconsole.com/installer');" > drupal.phar
  81 ```
  82
  83
  84 ## Update DrupalConsole Launcher
  85 ```
  86 drupal self-update
  87 ```
  88 > NOTE: `drupal` is the alias name you used when installed the DrupalConsole Launcher.
  89
  90 ## Run Drupal Console
  91 Using the DrupalConsole Launcher
  92 ```
  93 drupal
  94 ```
  95
  96 We highly recommend you to install the global executable, but if is not installed, then you can run DrupalConsole by:
  97
  98 ```
  99 vendor/bin/drupal
 100 # or
 101 vendor/drupal/console/bin/drupal
 102 # or
 103 bin/drupal
 104 ```
 105
 106 ## Drupal Console Support
 107 You can ask for support at Drupal Console gitter chat room [http://bit.ly/console-support](http://bit.ly/console-support).
 108
 109 ## Getting The Project To Contribute
 110
 111 For information about how to run this project for development follow instructions at [setup instructions](https://gist.github.com/jmolivas/97bbd07f328217be3564a434c5bd2618).
 112
 113 ## Enabling Autocomplete
 114 ```
 115 # You can enable autocomplete by executing
 116 drupal init
 117
 118 # Bash: Bash support depends on the http://bash-completion.alioth.debian.org/
 119 # project which can be installed with your package manager of choice. Then add
 120 # this line to your shell configuration file.
 121 source "$HOME/.console/console.rc" 2>/dev/null
 122
 123 # Zsh: Add this line to your shell configuration file.
 124 source "$HOME/.console/console.rc" 2>/dev/null
 125
 126 # Fish: Create a symbolic link
 127 ln -s ~/.console/drupal.fish ~/.config/fish/completions/drupal.fish
 128 ```
 129
 130 ## Supporting Organizations
 131
 132 [![weKnow](https://www.drupal.org/files/weKnow-logo_5.png)](http://weknowinc.com)
 133
 134 [![Anexus](https://www.drupal.org/files/anexus-logo.png)](http://www.anexusit.com/)
 135
 136 [![Indava](https://www.drupal.org/files/indava-logo.png)](http://www.indava.com/)
 137
 138 [![FFW](https://www.drupal.org/files/ffw-logo.png)](https://ffwagency.com)
 139
 140 > Drupal is a registered trademark of Dries Buytaert.