Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 2.66 KB

README.md

File metadata and controls

84 lines (52 loc) · 2.66 KB
Raw

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

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.

cargo install wpe

Linux & WSL

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

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

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

Optional Features

  • Integrate WordPress CLI. e.g: Updating WordPress Sites
  • Add bulk edit options.

Completed

  • Implement headless version so that the tool can be used in pipelines