# wexond-package-manager

> A package manager for Wexond

Latest version **1.4.5** (published 2018-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install wexond-package-manager
pnpm add wexond-package-manager
yarn add wexond-package-manager
bun add wexond-package-manager
```

Provides the command `wpm`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.5 |
| Published | 2018-07-25 |
| First published | 2018-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 35.6 KB |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 15 |
| Author | wexond |
| Maintainers | sential |
| Keywords | package-manager, nodejs |

## Links

- npm: https://www.npmjs.com/package/wexond-package-manager
- Repository: https://github.com/wexond/wexond-package-manager
- Homepage: https://github.com/wexond/wexond-package-manager#readme
- Issues: https://github.com/wexond/wexond-package-manager/issues
- npm.io page: https://npm.io/package/wexond-package-manager

## Dependencies (10)

- [ncp](https://npm.io/package/ncp.md) 2.0.0
- [chalk](https://npm.io/package/chalk.md) 2.4.1
- [rimraf](https://npm.io/package/rimraf.md) 2.6.2
- [easy-vm](https://npm.io/package/easy-vm.md) 1.2.1
- [commander](https://npm.io/package/commander.md) 2.16.0
- [@types/ncp](https://npm.io/package/@types/ncp.md) 2.0.1
- [decompress](https://npm.io/package/decompress.md) 4.2.0
- [@types/node](https://npm.io/package/@types/node.md) 10.5.3
- [@types/rimraf](https://npm.io/package/@types/rimraf.md) 2.0.2
- [@types/decompress](https://npm.io/package/@types/decompress.md) 4.2.3

## Recent versions

- 1.4.5 (latest) — 2018-07-25
- 1.4.4 — 2018-07-25
- 1.4.3 — 2018-07-25
- 1.4.2 — 2018-07-25
- 1.4.1 — 2018-07-25
- 1.4.0 — 2018-07-25
- 1.3.5 — 2018-04-09
- 1.3.4 — 2018-04-07
- 1.3.3 — 2018-04-07
- 1.3.1 — 2018-04-06
- 1.3.0 — 2018-04-06
- 1.1.0 — 2018-04-06
- 1.0.4 — 2018-04-04
- 1.0.3 — 2018-04-04
- 1.0.2 — 2018-04-04
- … 2 more at https://npm.io/package/wexond-package-manager/versions

## README

# wexond-package-manager

`wexond-package-manager` package manager for [`Wexond`](https://github.com/wexond/wexond), which is written in TypeScript and Node.js. It uses [`easy-vm`](https://github.com/Sential/easy-vm) to run plugins' scripts.

# Installation

```bash
$ npm install -g wexond-package-manager
```

# Usage

```bash
$ wpm <command> <params>
```

List of commands:

* `install` - Installs plugin from a GitHub repository.

  * `name` string - name of the GitHub repo for example `wexond/wexond-example-plugin`

* `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

# API

## Quick example

```javascript
const wpm = require("wexond-package-manager");

wpm
  .install("wexond-example-plugin", false)
  .then(() => {
    console.log("Installation completed successfully");
  })
  .catch(e => {
    console.error(e);
  });
```

## Methods

`wpm.install` - Installs plugin from a GitHub repository.

* `name` string - name of the GitHub repo
* Returns `Promise<void>`

`wpm.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>`

`wpm.run` - Runs a plugin in Node's VM.

* `name` string - name of the GitHub repo
* Returns `Promise<any>`

`wpm.list` - Lists all installed plugins.

* Returns `Promise<Package[]>`

---
_Source: https://npm.io/package/wexond-package-manager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._