# wpe-deploy

> A command-line tool for deploying WordPress plugins and themes to WP Engine

Latest version **0.1.1** (published 2018-11-21) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install wpe-deploy
pnpm add wpe-deploy
yarn add wpe-deploy
bun add wpe-deploy
```

Provides the command `wpedeploy`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-11-21 |
| First published | 2018-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.5.0 |
| Dependencies | 9 |
| Unpacked size | 64 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | rkbhochalya, unblock |
| Keywords | wp, engine, git, deploy, theme, plugin |

## Links

- npm: https://www.npmjs.com/package/wpe-deploy
- Repository: https://github.com/UnblockDotNet/wpe-deploy
- Homepage: https://github.com/UnblockDotNet/wpe-deploy#readme
- Issues: https://github.com/UnblockDotNet/wpe-deploy/issues
- npm.io page: https://npm.io/package/wpe-deploy

## Dependencies (9)

- [tmp](https://npm.io/package/tmp.md) ^0.0.33
- [chalk](https://npm.io/package/chalk.md) ^2.3.2
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.1
- [inquirer](https://npm.io/package/inquirer.md) ^5.2.0
- [commander](https://npm.io/package/commander.md) ^2.15.1
- [array-unique](https://npm.io/package/array-unique.md) ^0.3.2
- [escape-string-regexp](https://npm.io/package/escape-string-regexp.md) ^1.0.5

## Recent versions

- 0.1.1 (latest) — 2018-11-21
- 0.1.0 — 2018-09-28
- 0.0.2 — 2018-04-05
- 0.0.1 — 2018-04-04

## README

# WPE Deploy

[![npm version](https://badge.fury.io/js/wpe-deploy.svg)](https://badge.fury.io/js/wpe-deploy)

### A command-line tool for deploying WordPress plugins and themes to WP Engine


## Install
Install with [npm](https://www.npmjs.com/):

```sh
$ npm install -g wpe-deploy
```


## Usage
> Note: You need to have your SSH key added to WP Engine to be able to deploy using wpedeploy.

First generate a config file `wpedeploy.json` at the root of the theme or plugin:

```sh
$ wpedeploy init
```

Then deploy the theme or plugin in the current directory to WP Engine:

```sh
$ wpedeploy
```


## Options
To see all available options:

```sh
$ wpedeploy -h

  Usage: wpedeploy [command] [options]

  deploy a WordPress plugin or theme to WP Engine

  Options:

    -v, --version       output the version number

    -e, --env <env>     environment to deploy to, staging or production
    -s, --skip-confirm  push changes to WP Engine repo without asking for confirmation
    -f, --force         force push your changes to WP Engine repo
    -h, --help          output usage information

  Commands:

    init|i              interactively create a wpedeploy.json file
```

### `-e, --env <env>`
By default your theme/plugin is deployed to `production` env if you are on master branch of your theme/plugin or `staging` otherwise. You can manually set the WP Engine environment you want to push your theme/plugin to using this option. Supported values are `staging` and `production`.
To deploy theme/plugin to staging:
```sh
$ wpedeploy -e staging
```

### `-s, --skip-confirm`

wpedeploy confirms before your theme or plugin is pushed to WP Engine so that you can review the changes. You can skip this confirmation using this option:
```sh
$ wpedeploy -s
```

### `-f, --force`
This option will force push your changes to WP Engine repo:
```sh
$ wpedeploy -f
```


## TODO
- [ ] Improve documentation
- [ ] Write tests

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