Skip to content

Latest commit

 

History

History
241 lines (88 loc) · 5.08 KB

README.md

File metadata and controls

241 lines (88 loc) · 5.08 KB
Raw

powershell

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Run PowerShell scripts and commands from Node.js.

Why?

  • Actively maintained
  • Improved codebase.
  • Written in ES2015

☁️ Installation

# Using npm
npm install --save powershell

# Using yarn
yarn add powershell

📋 Example

const PowerShell = require("powershell");

// Start the process
let ps = new PowerShell("echo 'powershell is awesome'");

// Handle process errors (e.g. powershell not found)
ps.on("error", err => {
    console.error(err);
});

// Stdout
ps.on("output", data => {
    console.log(data);
});

// Stderr
ps.on("error-output", data => {
    console.error(data);
});

// End
ps.on("end", code => {
    // Do Something on end
});

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛
  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

PowerShell(input, opt, cb)

Params

  • String input: The command or PowerShell script ro execute.
  • Object opt: An object containing the following fields:
  • debug (Boolean): Turn on/off the debug messages (default: false).
  • noprofile (Boolean): Turn on/off noprofile parameter (default: true).
  • executionpolicy (Enum): Run powershell with specified executionpolicy (default: System default). Valid enum values are Restricted, AllSigned, RemoteSigned, Unrestricted, Bypass, Undefined.
  • PSCore (Boolean) : Turn on/off 'pwsh' the executable for PowerShell Core as opposed to Windowes PowerShell (default: 'false').
  • Function cb: The callback function (optional).

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

🍰 Thanks

This module is heavily based on node-powershell by @rann505.

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

  • workflow-wm-windows
  • workflow-wm-windows-python
  • win-screenoff
  • rdc-generator
  • ptc-integrity

📜 License

MIT © Ionică Bizău