PHPackages                             10up/wpinstructions - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. 10up/wpinstructions

AbandonedArchivedLibrary[CLI & Console](/categories/cli)

10up/wpinstructions
===================

Run human-readable WordPress commands

1.1(6y ago)982.6k↑180%4[1 PRs](https://github.com/10up/wpinstructions/pulls)2MITPHPPHP >=7.2

Since Mar 21Pushed 2y ago5 watchersCompare

[ Source](https://github.com/10up/wpinstructions)[ Packagist](https://packagist.org/packages/10up/wpinstructions)[ RSS](/packages/10up-wpinstructions/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (5)Versions (6)Used By (2)

WP Instructions
===============

[](#wp-instructions)

> WP Instructions lets you execute WordPress actions in human-readable format e.g. installing WordPress, activating plugins, etc. WP Instruction files can be provided to developers to ease local development setup and improve environment consistency.

[![Support Level](https://camo.githubusercontent.com/bda18bd40847957c7c2fd168847c0be1c844a01a7e8938bbadef330bcd0f6790/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f737570706f72742d61726368697665642d7265642e737667)](#support-level) [![MIT License](https://camo.githubusercontent.com/01b913b2f70250e6489f3f7d9fa434420e896c3ea923b8ae9ebc07ee6c01d910/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f313075702f7770696e737472756374696f6e732e737667)](https://github.com/10up/wpinstructions/blob/master/LICENSE.md)

Caution

As of 12 April 2024, this project is archived and no longer being actively maintained.

Requirements
------------

[](#requirements)

- PHP 7.2+

Install
-------

[](#install)

Install WP Instructions with Composer like so:

```
composer require 10up/wpinstructions

```

Usage
-----

[](#usage)

Instructions should be saved in a file named `WPInstructions`. Here is an example of an instructions file:

```
install wordpress where url is http://wp.test
Install plugin where name is distributor and url is https://github.com/10up/distributor.git and version is latest
install theme where name is twentynineteen

```

You can execute the instruction file via the command line like so:

```
./vendor/bin/wpinstructions run

```

Every instructions contains an `action` and a list of `options`. In the instructions file above, `install wordpress` is the action for the first command where `url` is an option. Each instruction supports different options.

Supported Instructions
----------------------

[](#supported-instructions)

`install wordpress`

**Options:** *\[version\] \[site title\] \[site url\] \[home url\] \[admin email\] \[admin user\] \[admin password\] \[install type=(multisite|single)\] \[path=(path to WP directory)\]*

Installs WordPress. When using this instruction, you will need to pass the following parameters in via the command line: `--config_db_host`, `--config_db_name`, `--config_db_user`, `--config_db_pass`. For example:

```
./vendor/bin/wpinstructions run --config_db_host=localhost --config_db_name=wordpress --config_db_user=wordpress --config_db_pass=password

```

`install theme`

**Options**: *\[theme name=(theme slug)\] \[theme version\] \[theme url\] \[theme status=(enabled|disabled)*

Installs a WordPress theme. `theme url` should be used for installing a theme via zip or git. `theme name` should match the theme slug.

`install plugin`

**Options**: *\[plugin name=(plugin slug)\] \[plugin version\] \[plugin url\] \[plugin status=(active|network active|inactive)*

Installs a WordPress plugin. `plugin url` should be used for installing a plugin via zip or git. `plugin name` should match the plugin slug.

`add site`

**Options**: *\[site title\] \[site url\] \[home url\] \[admin email\] \[admin user\] \[admin password\]*

Add a site to a multisite instance. `site_url` and `home_url` are required as options.

`activate plugin`

**Options**: \*\[plugin name=(plugin slug)\] \[active type=(network|single)\]

Activate a plugin.

`enable theme`

**Options**: \*\[theme name=(theme slug)\]

Enable a theme.

Examples
--------

[](#examples)

See examples in [EXAMPLES.md](EXAMPLES.md).

Support Level
-------------

[](#support-level)

**Archived:** This project is no longer maintained by 10up. We are no longer responding to Issues or Pull Requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!

Like what you see?
------------------

[](#like-what-you-see)

[![](https://camo.githubusercontent.com/5ec5223fa6fe20a5ca00d8d768bd7ee91e93f67c9d7a06e575c87e3ed1d00263/68747470733a2f2f313075702e636f6d2f75706c6f6164732f323031362f31302f313075702d4769746875622d42616e6e65722e706e67)](http://10up.com/contact/)

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity38

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 81% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~219 days

Total

2

Last Release

2395d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/3358927?v=4)[10up](/maintainers/10up)[@10up](https://github.com/10up)

---

Top Contributors

[![tlovett1](https://avatars.githubusercontent.com/u/1844351?v=4)](https://github.com/tlovett1 "tlovett1 (34 commits)")[![jeffpaul](https://avatars.githubusercontent.com/u/2818133?v=4)](https://github.com/jeffpaul "jeffpaul (6 commits)")[![dinhtungdu](https://avatars.githubusercontent.com/u/5423135?v=4)](https://github.com/dinhtungdu "dinhtungdu (2 commits)")

---

Tags

archivedcreate wordpress environment

### Embed Badge

![Health badge](/badges/10up-wpinstructions/health.svg)

```
[![Health](https://phpackages.com/badges/10up-wpinstructions/health.svg)](https://phpackages.com/packages/10up-wpinstructions)
```

###  Alternatives

[illuminate/console

The Illuminate Console package.

12944.1M5.1k](/packages/illuminate-console)[crunzphp/crunz

Schedule your tasks right from the code.

2292.0M6](/packages/crunzphp-crunz)[n98/magerun

Tools for managing Magento projects and installations

1.4k264.7k7](/packages/n98-magerun)[crazywhalecc/static-php-cli

Build single static PHP binary, with PHP project together, with popular extensions included.

1.8k13.9k](/packages/crazywhalecc-static-php-cli)[n98/magerun2

Tools for managing Magento projects and installations

928244.3k6](/packages/n98-magerun2)[madewithlove/license-checker

CLI tool to verify allowed licenses for composer dependencies

54449.8k21](/packages/madewithlove-license-checker)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)