gulp-cli for Mac

Command Line Utility for Gulp

Install

Usage

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.

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

Example Usage:

Tasks

The task(s) listed on the command line will be executed. If more than one task is listed, Gulp will execute all of them concurrently, that is, as if they had all been listed as dependencies of a single task.

By default, Gulp does not serialize tasks listed on the command line. If you would like to execute tasks serially, you must specify the --series flag. e.g. gulp clean build --series

Just running gulp will execute the task default. If there is no default task, gulp will error.

Completion Thanks to the grunt team, specifically Tyler Kellen

To enable tasks auto-completion in shell you should add eval "$(gulp --completion=shell)" in your .shellrc file.

Bash:

Add eval "$(gulp --completion=bash)" to ~/.bashrc.

Zsh:

Add eval "$(gulp --completion=zsh)" to ~/.zshrc.

Powershell:

Add Invoke-Expression ((gulp --completion=powershell) -join [System.Environment]::NewLine) to $PROFILE.

Fish:

Add gulp --completion=fish | source to ~/.config/fish/config.fish.

Compilers

You can find a list of supported JavaScript variant languages in 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.

Configuration

Configuration is supported through the use of a .gulp.* file (e.g. .gulp.js, .gulp.ts). You can find a list of supported JavaScript variant languages in Interpret.

A configuration file from the current working directory (cwd) or above are selected before a configuration file from the home directory (~).

Supported configurations properties:

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.

--preload [path]

Will preload a module before running the gulpfile. This is useful for transpilers but also has other applications.

--gulpfile [path] -f 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 preloads (with the --preload flag) will be from here.

--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]