Run shell commands
A good way to interact with other CLI tools. E.g. compiling Compass compass compile
or get the current git branch git branch
.
Use StackOverflow for support questions.
$ npm install --save-dev grunt-shell
require('load-grunt-tasks')(grunt); // npm install --save-dev load-grunt-tasks
grunt.initConfig({
shell: {
options: {
stderr: false
},
target: {
command: 'ls'
},
another: 'ls ./src' // shorthand
}
});
grunt.registerTask('default', ['shell']);
Create a folder named test
.
grunt.initConfig({
shell: {
makeDir: {
command: 'mkdir test'
}
}
});
The command
property supports templates:
grunt.initConfig({
testDir: 'test',
shell: {
makeDir: {
command: 'mkdir <%= testDir %>'
}
}
});
You can also supply a function that returns the command:
grunt.initConfig({
shell: {
hello: {
command: function () {
return 'echo hello';
}
}
}
});
Which can also take arguments:
module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-shell');
grunt.initConfig({
shell: {
greet: {
command: function (greeting) {
return 'echo ' + greeting;
}
}
}
});
grunt.registerTask('default', ['shell:greet:hello']);
}
Output a directory listing in your Terminal.
grunt.initConfig({
shell: {
dirListing: {
command: 'ls'
}
}
});
Do whatever you want with the output.
function log(err, stdout, stderr, cb) {
console.log(stdout);
cb();
}
grunt.initConfig({
shell: {
dirListing: {
command: 'ls',
options: {
callback: log
}
}
}
});
Run a command in another directory. In this example we run it in a subfolder using the cwd
(current working directory) option.
grunt.initConfig({
shell: {
subfolderLs: {
command: 'ls',
options: {
stderr: false,
execOptions: {
cwd: 'tasks'
}
}
}
}
});
Run multiple commands by placing them in an array which is joined using &&
or ;
. &&
means run this only if the previous command succeeded. You can also use &
to have the commands run concurrently (by executing all commands except the last one in a subshell).
grunt.initConfig({
shell: {
multiple: {
command: [
'mkdir test',
'cd test',
'ls'
].join('&&')
}
}
});
Required
Type: string
, function
The command you want to run or a function which returns it. Supports underscore templates.
command can be omitted by directly setting the target with the command.
Type: boolean
Default: true
Show stdout in the Terminal.
Type: boolean
Default: true
Show stderr in the Terminal.
Type: boolean
Default: true
Forward the terminal's stdin to the command.
Type: boolean
Default: true
Fail task if it encounters an error. Does not apply if you specify a callback
.
Type: boolean
Default: false
This sets stdin
to act as a raw device.
Type: function
Lets you override the default callback with your own.
Make sure to call the cb
method when you're done.
Type: object
Specify some options to be passed to the .exec() method:
cwd
String Current working directory of the child processenv
Object Environment key-value pairssetsid
Booleanencoding
String (Default: 'utf8')timeout
Number (Default: 0)maxBuffer
Number (Default: 200*1024)killSignal
String (Default: 'SIGTERM')
MIT © Sindre Sorhus