A simple, lightweight, docker-based WordPress environment
npm install @elementor/wp-lite-envbash
npm install -g @elementor/wp-lite-env
`
If you want to install the package for a specific project, run the following command:
bash
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 |
|----------------|----------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| 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:
`json
{
"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
$3
To start a new WordPress environment, run the following command:
bash
npx wp-lite-env start config= -- port=
`
For example:
bash
npx wp-lite-env start config=./tests/.wp-lite-env.json -- port=1234
`
$3
To stop a running WordPress environment, run the following command:
bash
npx wp-lite-env start config= -- port=
`
For example:
bash
npx wp-lite-env stop config=./tests/.wp-lite-env.json -- port=1234
`
$3
The WordPress CLI is available for use on the server. To use it, run the following command:
bash
npx wp-lite-env cli config= -- port= command=""
`
For example:
bash
npx wp-lite-env cli config=./tests/.wp-lite-env.json -- port=1234 command="ls -la /var/www/html"
``