Package Exports

gulp-shell

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-shell) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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', {read: false})
    .pipe(shell([
      'echo  <%= file.path %>',
      'ls -l <%= file.path %>'
    ]))
})

If you just want to execute a series of commands 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',
  'echo world'
]))

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

You can find more examples in the gulpfile of this project.

API

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

commands

type: Array or String

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.

options.cwd

type: String

default: process.cwd()

Sets the current working directory for the command.