Skip to content

Commit 6aa90b4

Browse files
committed
Docs: Add usage & flags (closes #38)
1 parent a4b3d64 commit 6aa90b4

File tree

1 file changed

+101
-3
lines changed

1 file changed

+101
-3
lines changed

README.md

Lines changed: 101 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,105 @@
44
</a>
55
</p>
66

7-
# 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]
8-
> The streaming build system
7+
# gulp-cli
98

10-
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/wearefractal/gulp/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
9+
[![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]
10+
11+
Command Line Utility for Gulp
12+
13+
## Usage
14+
15+
```bash
16+
> gulp [options] tasks
17+
```
18+
19+
## Options
20+
21+
<table>
22+
<thead>
23+
<tr>
24+
<th width="25%">Flag</th>
25+
<th width="15%">Short Flag</th>
26+
<th>Description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr>
31+
<td>--help</td>
32+
<td>-h</td>
33+
<td>Show this help.</td>
34+
</tr>
35+
<tr>
36+
<td>--version</td>
37+
<td>-v</td>
38+
<td>Print the global and local gulp versions.</td>
39+
</tr>
40+
<tr>
41+
<td>--require [path]</td>
42+
<td></td>
43+
<td>Will require a module before running the gulpfile. This is useful for transpilers but also has other applications.</td>
44+
</tr>
45+
<tr>
46+
<td>--gulpfile [path]</td>
47+
<td></td>
48+
<td>Manually set path of gulpfile. Useful if you have multiple gulpfiles. This will set the CWD to the gulpfile directory as well.</td>
49+
</tr>
50+
<tr>
51+
<td>--cwd [path]</td>
52+
<td></td>
53+
<td>Manually set the CWD. The search for the gulpfile, as well as the relativity of all requires will be from here.</td>
54+
</tr>
55+
<tr>
56+
<td>--verify</td>
57+
<td></td>
58+
<td>Will verify plugins referenced in project's package.json against the plugins blacklist.</td>
59+
</tr>
60+
<tr>
61+
<td>--tasks</td>
62+
<td>-T</td>
63+
<td>Print the task dependency tree for the loaded gulpfile.</td>
64+
</tr>
65+
<tr>
66+
<td>--tasks-simple</td>
67+
<td></td>
68+
<td>Print a plaintext list of tasks for the loaded gulpfile.</td>
69+
</tr>
70+
<tr>
71+
<td>--tasks-json [path]</td>
72+
<td></td>
73+
<td>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.</td>
74+
</tr>
75+
<tr>
76+
<td>--color</td>
77+
<td></td>
78+
<td>Will force gulp and gulp plugins to display colors, even when no color support is detected.</td>
79+
</tr>
80+
<tr>
81+
<td>--no-color</td>
82+
<td></td>
83+
<td>Will force gulp and gulp plugins to not display colors, even when color support is detected.</td>
84+
</tr>
85+
<tr>
86+
<td>--silent</td>
87+
<td>-S</td>
88+
<td>Suppress all gulp logging.</td>
89+
</tr>
90+
<tr>
91+
<td>--continue</td>
92+
<td></td>
93+
<td>Continue execution of tasks upon failure.</td>
94+
</tr>
95+
<tr>
96+
<td>--log-level</td>
97+
<td>-L</td>
98+
<td>Set the loglevel. -L for least verbose and -LLLL for most verbose. -LLL is default.</td>
99+
</tr>
100+
</tbody>
101+
</table>
102+
103+
## License
104+
105+
MIT
11106

12107
[gittip-url]: https://www.gittip.com/WeAreFractal/
13108
[gittip-image]: http://img.shields.io/gittip/WeAreFractal.svg
@@ -21,3 +116,6 @@
21116

22117
[coveralls-url]: https://coveralls.io/r/gulpjs/gulp-cli
23118
[coveralls-image]: http://img.shields.io/coveralls/gulpjs/gulp-cli/master.svg
119+
120+
[gitter-url]: https://gitter.im/gulpjs/gulp
121+
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png

0 commit comments

Comments
 (0)