wpe 0.0.17

A CLI tool for the wpengine API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

# WP Engine CLI

Built with Rust, this tool will allow you to control your sites, installs, users and more from your terminal or within a pipeline using headless mode.
I have also opted to not use async which will speed up performance. I work on this in my spare time, features may be added and removed randomly until
I push a version **1.0.0** release.

You may be wondering why does this need to exist. Well it is a two part answer...

1. I wanted a project to build in Rust.
2. I was tired of writing the same API calls over and over and I wanted something more concrete to use in my WordPress pipelines.

I have some big goals for this tool and I hope you find it as useful as I do!

[wpengine API reference](https://wpengineapi.com/reference)

> **Warning**
>
> This project is not constantly worked on and is unstable. Use at your own risk. As long as the version is below **1.0.0** you may experience breaking changes.

## Installation

## Cargo

You will need Rust installed in order to install this from Crates.io.

```bash
cargo install wpe
```

## Linux & WSL

The downloaded file will be located in `~/.local/bin/`

```bash
curl -s https://thesandybridge.github.io/scripts/install.sh | bash -s wpengine-cli wpe
```

## Authentication

Running the CLI for the first time will prompt you to add a username and password for the wpengine API.

You can also use the `auth` command to update the credentials or manually add them.

## Sites

The `sites` command will allow you to list, add, update, or delete existing sites. Passing the 
`-H` flag will enable headless mode for using the CLI in a pipeline or as part of a script.

Headless mode will enable list, add, update, and delete sub commands. 

**Examples**

```bash
wpe -H sites add <NAME> <Account_ID> # adds a site with the name provided.
wpe -H sites list # lists all sites for page 1.
wpe -H sites 1 list # lists all sites for page 2.
wpe -H sites list <Site_ID> # list a single site from page 1.
wpe -H sites 1 list <Site_ID> # list a single site from page 2.
```


## Installs

## Accounts

## Users

## Roadmap

### In Progress

- [ ] [Build commands for User/Accounts endpoint](https://github.com/thesandybridge/wpengine_cli_v2/issues/5)
- [ ] [Build commands for Domain endpoint](https://github.com/thesandybridge/wpengine_cli_v2/issues/8)
- [ ] [Build commands for Installs endpoint](https://github.com/thesandybridge/wpengine_cli_v2/issues/4)
- [ ] [Build commands for SSH endpoint](https://github.com/thesandybridge/wpengine_cli_v2/issues/6)

### Optional Features

- [ ] Integrate WordPress CLI. e.g: Updating WordPress Sites
- [ ] Add bulk edit options.

### Completed

- [x] Implement headless version so that the tool can be used in pipelines