README
verdox-package-manager
verdox-package-manager
package manager for Verdox
, which is written in TypeScript and Node.js. It uses tiny-vm
to run plugins' scripts.
Installation
$ npm install -g verdox-package-manager
Usage
$ vpm <command> <params>
List of commands:
install
- Installs plugin from a GitHub repository.name
string - name of the GitHub repo for exampleverdox/verdox-example-plugin
update
- Checks if there is newer version of a plugin and if there is, it installs newer version of the pluginname
string - name of the GitHub repo
API
Quick example
const vpm = require("verdox-package-manager");
vpm
.install("verdox-example-plugin", false)
.then(() => {
console.log("Installation completed successfully");
})
.catch(e => {
console.error(e);
});
Methods
vpm.install
- Installs plugin from a GitHub repository.
name
string - name of the GitHub repo- Returns
Promise<void>
vpm.update
- Checks if there is newer version of a plugin and if there is, it installs newer version of the plugin
name
string - name of the GitHub repo- Returns
Promise<void>
vpm.run
- Runs a plugin in Node's VM.
name
string - name of the GitHub repo- Returns
Promise<any>
vpm.list
- Lists all installed plugins.
- Returns
Promise<Package[]>