Pulse WP-CLI Reference
Manage Pulse migration from the command line: status, start, pause, sync, verify, smoke, enable, and drop-legacy.
WP ULike 5.2+ registers wp ulike pulse when WP-CLI is available. Use it on hosts, in deploy scripts, or when the admin upgrade UI is awkward on large databases.
Requires the free plugin 5.2+ with the Pulse ledger loaded. Run from the WordPress root (or pass --path=).
Admin UI counterpart: Storage Upgrade.
Quick workflow
wp ulike pulse status
wp ulike pulse start
# wait / re-check status until complete
wp ulike pulse verify
wp ulike pulse enable
# optional, after backup:
wp ulike pulse drop-legacy
On very large sites, drive the copy yourself with repeated batches:
wp ulike pulse sync --batch-size=500
Commands
status (default)
Show storage mode, read mode, migration status, and progress JSON.
wp ulike pulse status
Useful fields: Mode (legacy / dual / pulse), Read (legacy / merged / pulse), progress percent estimate, per-source counters.
start
Start (or resume) background migration.
wp ulike pulse start
pause
Pause background migration.
wp ulike pulse pause
sync
Run one migration batch and print the JSON result. Optional batch size (clamped by Pulse defaults, typically 50–2000):
wp ulike pulse sync
wp ulike pulse sync --batch-size=1000
verify
Compare legacy vs Pulse counts. Add --deep for full COUNT(*) scans (slower, more thorough).
wp ulike pulse verify
wp ulike pulse verify --deep
smoke
Read-only health checks for storage, stats meta, and dual-mode routing.
wp ulike pulse smoke
wp ulike pulse smoke --deep
Multisite — run on every network blog:
wp ulike pulse smoke --all-sites
wp ulike pulse smoke --all-sites --deep
enable
Finish the upgrade: require sync complete + passing verify, then switch reads/writes to Pulse mode.
wp ulike pulse enable
Fails if migration is incomplete or verification reports issues.
drop-legacy
Permanently drop old vote log tables after Pulse mode is active. Irreversible. Backup first.
wp ulike pulse drop-legacy
dismiss
Hide the storage-upgrade admin UI / notice flag (same as dismissing in wp-admin).
wp ulike pulse dismiss
Multisite tips
- Run commands per site with
--url=https://example.com/site/unless the subcommand supports--all-sites(smokedoes). - Prefer finishing migration on a staging copy before production cutover.
Related PHP helpers
| Function | Returns |
|---|---|
wp_ulike_pulse_mode() | legacy | dual | pulse |
wp_ulike_pulse_read_mode() | legacy | merged | pulse |
wp_ulike_writes_pulse() | bool |
wp_ulike_use_pulse_queries() | bool |
wp_ulike_pulse_needs_migration() | Whether the migration UI still applies |
Schema: Database & Meta.
Related: Pulse Storage Engine · Storage Upgrade
Related articles
Continue with these guides
Did this article help?
Pick how you feel, add a note if you want, then hit Send. It takes two seconds and helps us improve this guide.