grunt-exec

grunt-exec

Grunt task for executing shell commands.

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-exec

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-exec');

Documentation

This task is a multi task, meaning that grunt will automatically iterate over all exec targets if a target is not specified.

If the command used outputs to stderr, grunt-exec will display a warning and abort grunt immediately. Grunt will continue processing tasks if the --force command-line option was specified.

Target Properties

• command(required): The shell command to be executed. Must be a string.
• stdout(optional): Set true if you want the stdout to be printed. Defaults to false.

Example

grunt.initConfig({
  exec: {
    remove_logs: {
      command: 'rm -f *.log'
    },
    list_files: {
      command: 'ls -l **',
      stdout: true
    }
  }
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Release History

• 08/28/2012 - 0.2.1: Removed grunt as a dependency.
• 08/23/2012 - 0.2.0: Warn on output to stderr and remove option to log stderr.
• 04/16/2012 - 0.1.1: Fixed broken links on npm registry page.
• 04/08/2012 - 0.1.0: Initial release.

License

Copyright (c) 2012 Jake Harding
Licensed under the MIT license.