#WP-CLI-Environment
WP-CLI-Environment is wp-cli package which add support to have multiple environments wp-cli.yml
files.
WP-CLI allow you to have two wp-cli.yml files. One global wp-cli.yml
and one for local development wp-cli.local.yml
. This package give you possibility to have additional files and firendly cli tool for using them.
##Installation
To install package follow instructions from wp-cli documentation https://github.com/wp-cli/wp-cli/wiki/Community-Packages
##Getting Started
Create directory config
and put inside file wp-cli.production.yml
. Content of wp-cli.production.yml
is standard wp-cli.yml
file and it can looks like.
path: ../
url: http://example.org/
core config:
dbname: your_production_dbname
dbuser: your_production_dbuser
dbpass: your_production_dbpassword
skip-check: true
disabled_commands:
- db drop
- plugin install
Exec command:
wp production core download
WP-CLI will download WordPress using settings in wp-cli.production.yml
file. Not so impressive. WP-CLI-Environment is design to work with multiple wp-cli.yml
files so now create wp-cli.developemnt.yml
file in config
directory with content.
path: ../
url: http://example.dev.org/
core config:
dbname: your_dev_dbname
dbuser: your_dev_dbuser
dbpass: your_dev_dbpassword
skip-check: true
Exec command:
wp production core config
As you see wp-cli created wp-config.php with settings from wp-cli.production.yml
. Delete wp-config.php and exec command:
wp development core config
Now hovewever wp-cli created wp-config.php with settings from wp-cli.development.yml
##Usage
WP-CLI-Environment support 5 environments: local
, development
, testing
, staging
, production
. For each environment you can create wp-cli.environment.yml
file e.g.: wp-cli.testing.yml
or wp-cli.staging.yml
. All environments files must be in config directory.
When you want to refer to particular file when executing wp-cli command simply type environment as first argument e.g: wp testing core download
or wp staging core config
.
If there is no wp-cli.environemnt.yml
file. You will se an error about this.
##The order of precedence
WP-CLI-Environment use WP_CLI_CONFIG_PATH
environment variable to require specific config file. It means that wp-cli-environemnt has very low priority. If you will have wp-cli.yml or wp-cli.local.yml files in your wordpress root directory, settings from this files will overwrite settings from wp-cli.environment.yml.
##License
The MIT License (MIT)
Copyright (c) 2014 ViewOne Sp. z o.o.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.