shell-exec

shell-exec

Execute a command through the system shell

Built with ❤︎ by tiaanduplessis and contributors

Table of Contents

Table of Contents

About

Install

Usage

API

Contribute

License

About

A tiny cross-platform promise based wrapper around child_process.spawn.

Install

$ npm install shell-exec
# OR
$ yarn add shell-exec

Usage

const shellExec = require('shell-exec')

shellExec('echo Hi!').then(console.log).catch(console.log)
// Hi!
// { stdout: '', stderr: '', cmd: 'echo Hi!', code: 0 }

API

shellExec(command, options)

Parameters:

• command {String | Array} - String or Array of commands to run
• options {Object} - Options object passed to child_process.spawn

The function then returns a Promise.

Contributing

Contributions are welcome!

• Fork it.
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request :D

Or open up a issue.

License

Licensed under the MIT License.

Similar packages

Other packages similar to shell-exec

child_process

The child_process module is a built-in Node.js module that provides the ability to spawn child processes and execute shell commands. It offers more control and flexibility compared to shell-exec, but requires more boilerplate code to handle the execution and output of commands.

execa

Execa is a modern alternative to the child_process module. It provides a simpler and more powerful interface for executing shell commands, with better support for promises and improved error handling. Execa is more feature-rich and flexible compared to shell-exec.

shelljs

ShellJS is a portable Unix shell commands for Node.js. It provides a comprehensive set of shell commands that can be used within a Node.js application. ShellJS is more feature-rich and offers a wider range of shell commands compared to shell-exec.