README.md

gulp-cli

Command Line Utility for Gulp

Usage

> gulp [flags] tasks

Custom Metadata

When listing tasks with the gulp -T command, gulp-cli displays some custom metadata as defined upon task functions. Currently supported properties:

• task.description - String of the description to display.

function clean() { ... }
clean.description = 'Cleans up generated files.';

• task.flags - Object with key/value pairs being flag/description to display.

function build() { ... }
build.flags = {
  '--prod': 'Builds in production mode.'
};

Example Usage:

function build() { ... }
build.description = 'Build entire project.';
build.flags = {
  '--prod': 'Builds in production mode (minification, etc).'
};
// gulp 3.x
gulp.task('build', build);
// gulp 4.x
gulp.task(build);

Tasks

Tasks can be executed by running gulp <task> <othertask>. Just running gulp will execute the task you registered called default. If there is no default task, gulp will error.

Compilers

You can find a list of supported languages at https://github.com/js-cli/js-interpret. If you would like to add support for a new language, send pull requests/open issues on that project.

Environment

The CLI adds process.env.INIT_CWD which is the original cwd it was launched from.

Flags

gulp has very few flags to know about. All other flags are for tasks to use if needed.

Some flags only work with gulp 4 and will be ignored when invoked against gulp 3.

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 [path (optional)]		Will verify plugins referenced in project's package.json against the plugins blacklist.
--tasks	-T	Print the task dependency tree for the loaded gulpfile.
--depth [number]		Specify the depth of the task dependency tree to print.
--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.

License

MIT