Download the PHP package jonbp/wp-cli-sync without Composer
On this page you can find all versions of the php package jonbp/wp-cli-sync. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jonbp/wp-cli-sync
More information about jonbp/wp-cli-sync
Files in jonbp/wp-cli-sync
Package wp-cli-sync
Short Description A WP-CLI command for syncing a live site to a development environment
License MIT
Homepage https://github.com/jonbp/wp-cli-sync
Informations about the package wp-cli-sync
WP-CLI Sync
About
A WP-CLI command for syncing a live site to a development environment.
This plugin is designed to be used with a Roots Bedrock based WordPress project.
Requirements
You will need the following to use this plugin:
Installation
To install this plugin, follow these steps:
-
Require the plugin by running:
-
Add the following to your
.env
file (don't forget.env.example
for reference 😉): - Run
wp sync
from the project root.
First Sync
You may find yourself working on a bedrock project that already exists on a production server and you don't have the database setup locally yet. Running wp sync
in the project will fail in this case as it requires an active WordPress installation to run.
To remedy this, you can run the following commands to create a database (if necessary) and create a basic installation inside that database in order to run the plugin and its first sync.
It’s not necessary to edit the variables on the second line as the database is overwritten by the plugin during sync. The code is simply to give the plugin the requirements it needs to run without the real database installed.
Extra Environment Variables
Below is a list of extra environment variables that can be added to your .env
file to customise the sync process.
Variable | Description |
---|---|
DEV_POST_SYNC_QUERIES |
A comma seperated list of SQL queries to run after the sync has completed. |
DEV_SYNC_DIR_EXCLUDES |
A comma seperated list of directories within the uploads folder to exclude from the sync. |
DEV_TASK_DEBUG |
Set to true to show debug information about the commands being run. Useful for debugging if something isn't working as expected. |
UPLOAD_DIR |
The name of the uploads directory. Defaults to app/uploads where the uploads folder is located on a bedrock project. |
All versions of wp-cli-sync with dependencies
wp-cli/db-command Version ^2.0
wp-cli/extension-command Version ^2.1
wp-cli/maintenance-mode-command Version ^2.0