Skip to content

tiaanduplessis/shell-exec

Repository files navigation

🐚 shell-exec

package version package downloads standard-readme compliant package license make a pull request

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

Table of Contents

⚙️ Install

Install the package locally within you project folder with your package manager:

With npm:

npm install shell-exec

With yarn:

yarn add shell-exec

With pnpm:

pnpm add shell-exec

📖 Usage

import shellExec from 'shell-exec'
shellExec('echo Hi!').then(console.log).catch(console.log)

📚 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.

See the hosted docs here.

💬 Contributing

Got an idea for a new feature? Found a bug? Contributions are welcome! Please open up an issue or make a pull request.

🪪 License

MIT © Tiaan du Plessis

About

Execute a command through the system shell

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •