# wpcli

> Simple wrapper to use wp-cli with promises

Latest version **1.0.1** (published 2017-06-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install wpcli
pnpm add wpcli
yarn add wpcli
bun add wpcli
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-06-27 |
| First published | 2016-12-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | itgalaxy |
| Maintainers | itgalaxy |
| Keywords | cli, wp-cli, promise, wordpress |

## Links

- npm: https://www.npmjs.com/package/wpcli
- Repository: https://github.com/itgalaxy/wpcli
- Issues: https://github.com/itgalaxy/wpcli/issues
- npm.io page: https://npm.io/package/wpcli

## Dependencies (1)

- [execa](https://npm.io/package/execa.md) ^0.7.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2017-06-27
- 1.0.0 — 2016-12-13

## README

# wpcli

[![NPM version](https://img.shields.io/npm/v/wpcli.svg)](https://www.npmjs.org/package/wpcli) 
[![Travis Build Status](https://img.shields.io/travis/itgalaxy/wpcli/master.svg?label=build)](https://travis-ci.org/itgalaxy/wpcli) 
[![dependencies Status](https://david-dm.org/itgalaxy/wpcli/status.svg)](https://david-dm.org/itgalaxy/wpcli) 
[![devDependencies Status](https://david-dm.org/itgalaxy/wpcli/dev-status.svg)](https://david-dm.org/itgalaxy/wpcli?type=dev)
[![Greenkeeper badge](https://badges.greenkeeper.io/itgalaxy/wpcli.svg)](https://greenkeeper.io/)

Wrapper to use wp-cli with promises.

## Install

```shell
npm install wpcli --save-dev
```

## Usage

```js
const wpCli = require('wpcli').default;

wpCli('./wp-cli.phar', ['--version'], {
    cwd: 'vendor/bin'
})
    .then((result) => {
        console.log(result);
    });
```

## API

### wpCli(bin, arguments, options)

Same options as [`child_process.execFile`](https://nodejs.org/api/child_process.html#child_process_child_process_execfile_file_args_options_callback).

Think of this as a mix of `child_process.execFile` and `child_process.spawn`.

Returns a [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess), 
which is enhanced to also be a `Promise` for a result `Object` with `stdout` and `stderr` properties.

## Related

-   [wp-cli](https://github.com/wp-cli/wp-cli) - Main package.

## Contribution

Feel free to push your code if you agree with publishing under the MIT license.

## [Changelog](CHANGELOG.md)

## [License](LICENSE)

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