distrobox-node

Distrobox-Node

Distrobox API for Node.JS

Warning

The versions of this package published on npm may be untested. There will be a badge on the top of the page to indicate this.

Note

The latest versions of this package will be published on github. The badge on top of the readme will indicate if said release is stable.

Distrobox must be installed on the system that this package is being used on.

Usage

run npm install distrobox-node in your project

const distrobox = require('distrobox-node')
// create a container (os,name,args), returns stdout
await distrobox.create('ubuntu','ubuntu')
// run a command in a container (name, command, args), returns stdout
await distrobox.exec('ubuntu', 'sudo apt install neofetch -y; neofetch')
//stop a container (name, args), returns stdout
await distrobox.stop('ubuntu')
//remove a container (name, args), returns stdout
await distrobox.remove('ubuntu')
//list all containers (args), returns a list of objects, containing information about each container
await distrobox.list()
//get a object with the names and images of all OSs supported by distrobox-node (usually the latest image)
distrobox.getImages()
/*Also, the args parameter used in most functions exposed by this library
is a object containing arguments that are passed to distrobox. 
The keys of the object being the argument names, and the values being the argument values.
Note:
All commands are ran as root by default. 
To run a command without root,add the no-root argument in the args object.
*/ 

Pretty simple, right?
Your a smart developer so if you have any issues, just look at the code.
You want more features? Roll your own code. (I don't really have time to do anything but maintain the code)
You have a question? If you can't find the answer in the code, post an issue and state in the title that its a question.
If it's a bug, say it's a bug.
Simple.

Changelog

1.0.0: First release;

1.1.0: added list parsing;

1.1.1: fixed bugs with list parsing;

1.2.0: added getImages function;

1.2.1: Readme fix

1.2.2: no root argument added

1.3.0: Exec added, docs fixes

1.3.1: A heap of bug fixes