WP-CLI DB Sync
Remote to local database import tool for wp-cli, (*1)
This is a wp-cli command version of this gist, (*2)
Installation
composer require timneutkens/wp-cli-dbsync:^1.0.0
, (*3)
Configuration
This command uses wp-cli-ssh., (*4)
To get started use their instructions to setup a remote host:, (*5)
Add an ssh
section to your wp-cli.yml
/wp-cli.local.yml
, as seen in the sample config.
You indicate the ssh
command templates for each host you want to connect to. The template variable %cmd%
is
replaced with the full command to run on the server; the %pseudotty%
template variable is replaced
with -t
/-T
depending on whether you're on a TTY or piping the command output., (*6)
For a step-by-step guide, please refer to the wiki., (*7)
Now you can run the following command:, (*8)
wp dbsync <host here>
, (*9)
The command will import the database. After that it will search replace the old home url to the new home url using wp search-replace
.
The new home url will be guessed using wp option get home
.
Beware that if you define WP_HOME
this command will return that url instead of the url set in the wp_options
table.
Optionally you can provide --new-base-url=http://example.com
to override this behaviour., (*10)
Replace <host here>
with the host you just setup in your wp-cli.yml
/wp-cli.local.yml
., (*11)