wp-lite-env

A simple, lightweight, docker-based WordPress environment

Usage

Installation

To install the package, run the following command:

npm install -g @elementor/wp-lite-env

If you want to install the package for a specific project, run the following command:

npm install --save-dev @elementor/wp-lite-env

Creating a configuration file

The configuration file is a JSON file that contains the configuration for the WordPress environment.

| Field | Type | Default | Description | |----------------|----------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | "core" | string\|null | null | The WordPress installation to use. If null is specified, the latest production release of WordPress will be used. | | "phpVersion" | string\|null | null | The PHP version to use. If null is specified, the latest version of PHP that is compatible with the latest production release of WordPress will be used. | | "plugins" | Object | {} | A set of plugins to install and activate in the environment. The entries are a key-value pair in the format of : | | "themes" | Object | {} | A set of themes to install in the environment. The entries are a key-value pair in the format of : | | "config" | Object | {} | Mapping of wp-config.php constants to their desired values. | | "mappings" | Object | "{}" | Mapping of WordPress directories to local directories to be mounted in the WordPress instance. |

The following is an example of a configuration file:

{
  "core": "6.7",
  "phpVersion": "8.2",
  "plugins": {
    "elementor": "./elementor/build"
  },
  "themes": {
    "hello-elementor": "./hello-elementor"
  },
  "mappings": {
    "resources": "./resources"
  },
  "config": {
    "SCRIPT_DEBUG": false,
    "WP_DEBUG": false
  }
}

Usage

Starting a new WordPress environment

To start a new WordPress environment, run the following command:

npx wp-lite-env start config=<path to configuration file> -- port=<port>

For example:

npx wp-lite-env start config=./tests/.wp-lite-env.json -- port=1234

Stopping a WordPress environment

To stop a running WordPress environment, run the following command:

npx wp-lite-env start config=<path to configuration file> -- port=<port used by the WordPress environment>

For example:

npx wp-lite-env stop config=./tests/.wp-lite-env.json -- port=1234

Starting a new WordPress environment

The WordPress CLI is available for use on the server. To use it, run the following command:

npx wp-lite-env cli config=<path to configuration file> -- port=<port used by the WordPress environment> command="<CLI command>"

For example:

npx wp-lite-env cli config=./tests/.wp-lite-env.json -- port=1234 command="ls -la /var/www/html"

Contributors

This package is developed and maintained by the Elementor team. With that being said, we want to thank the @wordpress/env team, this package is heavily inspired by their wonderful work.