Skip to main content
  1. All Posts/


Tools Open Source Sync WordPress


Will copy database and uploaded files.
Quick links: Installing | Using | Plugin Integrations | Contributing | Support


Make sure WP-CLI is installed on the remote server and you have SSH access.
Rsync needs to be installed to transfer the uploads folder.
Installing this package requires WP-CLI v1.5.0 or greater. Update to the latest stable release with wp cli update.
Once you’ve done so, you can install this package with:

wp package install


Create a wp-cli.local.yml file in your local WordPress project.


  ssh: root@<ip>/path/to/staging/wp-root

  ssh: root@<ip>/path/to/production/wp-root

Now you can sync your local development environment with one of the defined environments:

wp sync --env=staging


wp sync --env=production

Use the –force attribute to bypass the confirmation prompt.


The uploads folder is synced by default. You can ignore it with:

wp sync --env=production --no-uploads


User data is not synced by default. Having all this data on many local machines wouldn’t be a good idea considering privacy laws.
Include user data with:

wp sync --env=production --users

Plugin Integrations

Ninja Forms

All Ninja Forms subscriptions will be removed from the export. Syncing sensitive information of visitors to your local machine is not recommended.
There’s no switch.


We appreciate you taking the initiative to contribute to this project.
Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
For a more thorough introduction, check out WP-CLI’s guide to contributing. This package follows those policy and guidelines.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.
Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.
Once you’ve decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it’s a pleasant experience. See “Setting up” for details specific to working on this package locally.


Github issues aren’t for general support questions, but there are other venues you can try:
This is generated dynamically from the project’s codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase.