Usage and flags explained

These are the CLI's integrated help. Go to the bottom of the page for the flags explanation.

> wordmove-ng help
Commands:
  wordmove-ng --version, -v   # Print the version
  wordmove-ng doctor          # Do some local configuration and environment checks
  wordmove-ng help [COMMAND]  # Describe available commands or one specific command
  wordmove-ng init            # Generates a brand new movefile.yml
  wordmove-ng list            # List all environments and vhosts
  wordmove-ng pull            # Pulls WP data from remote host to the local machine
  wordmove-ng push            # Pushes WP data from local machine to remote host

---

> wordmove-ng help doctor
Usage:
  wordmove-ng doctor

Do some local configuration and environment checks

The doctor checks, in order:

1. movefile.yml formal validation against the schemas in lib/wordmove/assets. It also rejects remotes that still carry an ftp block and reports when one search-replace term (local/remote vhost or wordpress_path) is a prefix of another.
2. Local database tools and connection: mysql/mariadb, mysqldump/mariadb-dump and a connection with the local.database credentials.
3. Local wp-cli presence and freshness.
4. Local rsync and ssh.
5. Each SSH remote: a non interactive connection (ssh -o BatchMode=yes … true); on success it probes the remote for rsync, gzip, mysql/mariadb, mysqldump/mariadb-dump and wp, and reports what is missing. It warns if ssh.gateway.password is set, because a jump host can only be reached with keys.

Run it before opening an issue and paste its output in the report.

---

> wordmove-ng list

Prints a list of all environments configured in movefile.yml with their respective URL (vhost key).

---

> wordmove-ng help push
Usage:
  wordmove-ng push

Options:
  -w, [--wordpress], [--no-wordpress]
  -u, [--uploads], [--no-uploads]
  -t, [--themes], [--no-themes]
  -p, [--plugins], [--no-plugins]
  -m, [--mu-plugins], [--no-mu-plugins]
  -l, [--languages], [--no-languages]
  -d, [--db], [--no-db]
  -v, [--verbose], [--no-verbose]
  -s, [--simulate], [--no-simulate]
  -e, [--environment=ENVIRONMENT]
  -c, [--config=CONFIG]
      [--debug], [--no-debug]
      [--no-adapt], [--no-no-adapt]
      [--all], [--no-all]

Pushes WP data from local machine to remote host

wordmove-ng help pull shows the same options for pull.

---

Push/Pull flags explanation

Flags give you control over which folders/components are pushed or pulled.

-w, [--wordpress]

The WordPress core. Ignores the wp-content folder.

-u, [--uploads]

wp-content/uploads

-t, [--themes]

wp-content/themes

-p, [--plugins]

wp-content/plugins

-m, [--mu-plugins]

wp-content/mu-plugins

-l, [--languages]

wp-content/languages

-d, [--db]

The database. Both directions work the same way: dump the source, import on the target, run wp search-replace on the target for vhost and wordpress_path. The source database is only read. A backup of the target database is written to the local wp-content/ folder before the import. See the README section "Database sync" for prerequisites and maintenance mode.

-v, [--verbose]

Print more info on screen.

-s, [--simulate]

Do not execute transfers: rsync runs with --dry-run and the database steps are skipped after logging.

-e, [--environment=ENVIRONMENT]

Set the remote environment when multiple are defined inside movefile.yml, e.g. wordmove-ng push -e production -d.

-c, [--config=CONFIG]

Use an alternate config file name. The path is relative to the directory the command was invoked from and must be inside the project root.

[--no-adapt]

Skip the wp search-replace step after importing the database. Useful when local and remote share the same vhost and wordpress_path, or when you want to run the replacement yourself.

[--all]

Consider all the folders and the database (a full copy).

[--no-*]

Negation flags exclude a component. They combine with --all to operate on everything but the negated ones; several can be given at once.

wordmove-ng push --all --no-db -e production

mirrors the whole site but does not push the database.

wordmove-ng push --all --no-db --no-wordpress -e production

mirrors everything but the database and the core.

[--debug]

Accepted for compatibility. It had an effect only with the FTP deployer, which was removed in 6.0.