Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

node-powershellcore

Easily run PowerShell from your NodeJS app - cross platform edition!

node-powershell, ps, powershell, node-ps, microsoft, shell, cmd, commandline, command, Line, windows, windows powershell, script, spwan, shells, terminal, linux powershell, powershell github, PowerShell for every system, PowerShell cross-platform, powershell linux, powershell centos, powershell rhel, powershell ubuntu, powershell macos, powershell docker

readme

Node-PowerShell

Build Status NPM Version NPM Downloads Coveralls Package Quality Closed Issues Dependencies License GitHub Stars

Node-PowerShell taking advantage of two of the simplest, effective and easy tools that exist in the today technology world. On the one hand, NodeJS which made a revolution in the world of javascript, and on the other hand, PowerShell which recently came out with an initial open-source, cross-platform version, and by connecting them together, gives you the power to create any solution you were asked to, no matter if you are a programmer, an IT or a DevOps guy.

Installation

$ npm i -S node-powershell
$ yarn add node-powershell

Quick start

const shell = require('node-powershell');

let ps = new shell({
  executionPolicy: 'Bypass',
  noProfile: true
});

ps.addCommand('echo node-powershell')
ps.invoke()
.then(output => {
  console.log(output);
})
.catch(err => {
  console.log(err);
  ps.dispose();
});

API Reference

:memo: API reference
I've created a convenient and readable page, so you can enjoy the experience of learning and begin to use the module quickly and easily.

:fire: PowerShell 6.0

As you may have heard already, lately Microsoft is taking steps towards becoming an open source company. One of these steps, brings us [PowerShell 6.0][] , which is a cross-platform version of the amazing tool that we know and love from Windows. Node-PowerShell Welcomes the move, and started the current version, will fully support the new PS. Moreover, I will continue to follow the development of the new PS repo, and to update the module accordingly. Enjoy! [PowerShell 6.0]: https://github.com/PowerShell/PowerShell

License

MIT © Ran Cohen

changelog

Change Log

v3.3.0 - 2017-10-28

Implemented enhancements:

  • Add support to PowerShell Hashtable data type - {name: JSON} -> [hashtable]$hashtable.
  • New way to detect output - Unique ShellStream class created.
  • Add optional parameter to determine the PS version.
  • Add optional parameter to change EOI string.
  • Improve performance.

Fixed bugs:

  • Added shell option to change EOI string. #18
  • Fix EOL Bug. #34
  • Intermittently the data from the power shell instance is blank. #20
  • Escaping string input. #21
  • addCommand("ls c:") followed by invoke() always emits nothing (blank string). #25
  • "EOI" marker matching logic often "eats" last chunk of output. #26
  • NO output from powershell when an argument value changes. #31
  • new-webserviceproxy isn't supported. #32
  • 'end' event not fired, outputs merged. #33

v3.1.0 - 2017-02-25

Implemented enhancements:

  • Add support to most of PowerShell data types including switch options ({name: ''}).
  • New syntax to send parameters to addCommand method. {name: value}
  • New homepage and docs.
  • Add headers to build files.
  • Integration with travis-ci.

Fixed bugs:

  • Unable to send [switch] options. #17
  • Unable to send array of strings. #15