gulp-shell

gulp-shell

A handy command line interface for gulp

Installation

npm install --save-dev gulp-shell

Usage

var gulp  = require('gulp')
var shell = require('gulp-shell')

gulp.task('example', function () {
  return gulp.src('*.js')
    .pipe(shell('echo <%= file.path %>'))
})

If you just want to execute the command only once, starting the stream with gulp.src('') should do the trick.

Or you can use this shorthand:

gulp.task('shorthand', shell.task('echo hello'))

To run multiple commands, join them by && or ;:

gulp.task('multiple', shell.task([
  'echo hello',
  'echo world'
].join(' && ')))

Note: The command will be executed in an environment where PATH prepended by ./node_modules/.bin, allowing you to run executables in your Node's dependencies.

API

shell(command, options) or shell.task(command, options)

template

A command can be a template which can be interpolated by some file info (e.g. file.path).

options.ignoreErrors

type: Boolean

default: false

By default, it will emit an error event when the command finishes unsuccessfully.

options.quiet

type: Boolean

default: false

By default, it will print the command output.