aleph1.co.uk Git - yaffs-website/blob - node_modules/grunt/node_modules/grunt-cli/README.md

   1 # grunt-cli [![Build Status: Linux](https://travis-ci.org/gruntjs/grunt-cli.svg?branch=master)](https://travis-ci.org/gruntjs/grunt-cli) [![Build Status: Windows](https://ci.appveyor.com/api/projects/status/prp6g944b05jsq6d/branch/master?svg=true)](https://ci.appveyor.com/project/gruntjs/grunt-cli/branch/master)
   2
   3 > The Grunt command line interface.
   4
   5 Install this globally and you'll have access to the `grunt` command anywhere on your system.
   6
   7 ```shell
   8 npm install -g grunt-cli
   9 ```
  10
  11 **Note:** The job of the `grunt` command is to load and run the version of Grunt you have installed locally to your project, irrespective of its version.  Starting with Grunt v0.4, you should never install Grunt itself globally.  For more information about why, [please read this](http://nodejs.org/en/blog/npm/npm-1-0-global-vs-local-installation).
  12
  13 See the [Getting Started](http://gruntjs.com/getting-started) guide for more information.
  14
  15 ## Shell tab auto-completion
  16 To enable tab auto-completion for Grunt, add one of the following lines to your `~/.bashrc` or `~/.zshrc` file.
  17
  18 ```bash
  19 # Bash, ~/.bashrc
  20 eval "$(grunt --completion=bash)"
  21 ```
  22
  23 ```bash
  24 # Zsh, ~/.zshrc
  25 eval "$(grunt --completion=zsh)"
  26 ```
  27
  28 ## Installing grunt-cli locally
  29 If you prefer the idiomatic Node.js method to get started with a project (`npm install && npm test`) then install grunt-cli locally with `npm install grunt-cli --save-dev`. Then add a script to your `package.json` to run the associated grunt command: `"scripts": { "test": "grunt test" } `. Now `npm test` will use the locally installed `./node_modules/.bin/grunt` executable to run your Grunt commands.
  30
  31 To read more about npm scripts, please visit the npm docs: <https://docs.npmjs.com/misc/scripts>.