tiaanduplessis / shell-exec

Execute a command through the system shell

🐚 shell-exec

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

Table of Contents

• 🐚 shell-exec
  • Table of Contents
  • ⚙️ Install
  • 📖 Usage
  • 📚 API
    • shellExec(command, options)
  • 💬 Contributing
  • 🪪 License

⚙️ 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