diff --git a/README.md b/README.md index 5649c443..7d1802da 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,105 @@
-# gulp-cli [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Support us][gittip-image]][gittip-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] -> The streaming build system +# gulp-cli -[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/wearefractal/gulp/trend.png)](https://bitdeli.com/free "Bitdeli Badge") +[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url] + +Command Line Utility for Gulp + +## Usage + +```bash +> gulp [options] tasks +``` + +## Options + +Flag | +Short Flag | +Description | +
---|---|---|
--help | +-h | +Show this help. | +
--version | +-v | +Print the global and local gulp versions. | +
--require [path] | ++ | Will require a module before running the gulpfile. This is useful for transpilers but also has other applications. | +
--gulpfile [path] | ++ | Manually set path of gulpfile. Useful if you have multiple gulpfiles. This will set the CWD to the gulpfile directory as well. | +
--cwd [path] | ++ | Manually set the CWD. The search for the gulpfile, as well as the relativity of all requires will be from here. | +
--verify | ++ | Will verify plugins referenced in project's package.json against the plugins blacklist. | +
--tasks | +-T | +Print the task dependency tree for the loaded gulpfile. | +
--tasks-simple | ++ | Print a plaintext list of tasks for the loaded gulpfile. | +
--tasks-json [path] | ++ | Print the task dependency tree, in JSON format, for the loaded gulpfile. The [path] argument is optional, and if given writes the JSON to the path. | +
--color | ++ | Will force gulp and gulp plugins to display colors, even when no color support is detected. | +
--no-color | ++ | Will force gulp and gulp plugins to not display colors, even when color support is detected. | +
--silent | +-S | +Suppress all gulp logging. | +
--continue | ++ | Continue execution of tasks upon failure. | +
--log-level | +-L | +Set the loglevel. -L for least verbose and -LLLL for most verbose. -LLL is default. | +