Code Monkey home page Code Monkey logo

node-wsb's Introduction

Node Windows Sandbox

This library allows running PowerShell scripts in Windows Sandbox.

Installation

git submodule add https://github.com/tomashubelbauer/node-wsb

To update:

cd node-wsb
git pull
cd ..

Usage

import wsb from './node-wsb/index.js';

console.log(await wsb('echo "Hello, World!"'));

The return value is an object:

  • stdout (string): the output value in case of success
  • stderr (string): the output value in case of failure
  • exitCode (number): 0 for success, 1 for failure
  • transcript (object):
    • startTime (string): the transcript start instant in yyyymmddhhmmss
    • endTime (string): the transcript end instant in yyyymmddhhmmss
    • meta (object): an object made of transcript metadata key-value pairs
    • data: (string[]) an array of lines written to the transcript

Development

Run tests using npm test.

To-Do

Address code to-do comments

Use todo.

Finalize the wait argument logic - wait or bail based on its value

Add a "simulation" mode option which falls back to PowerShell direct

This would be used in the CI or when the user doesn't want to / can't enable WSB on their machine.

Consider adding a Docker backend for non-Windows and CI environments maybe

Perhaps it should be a separate package though.

Look into using PowerShell remoting for communicating with the sandbox

I think we could find the sandbox' IP address and connect to it using PowerShell remoting and run the commands that way. We might need to turn it on first.

node-wsb's People

Contributors

tomashubelbauer avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.