On the command line you see with one command whether your website is backed up. You fetch the logs and the support report, switch debugging on or off, check the notifications and watch or end the running job.
WP-CLI still missing? The guide is in Install WP-CLI. All commands of the plugin are listed in The commands at a glance.
The output of the commands is in English. Some actions first check the user: the command must run as the user who owns the folders of the plugin. --force skips the check. The sections below mention the parameter where it is available.
Showing the state of the website: status
status shows the same result as the status tile of the Overview page. The command has no actions and no parameters and changes nothing.
# Show the state of the website wp cloneworx-backup status
The first line shows the state. If several apply, the order of the table decides:
| State | Colour of the status tile | Meaning |
|---|---|---|
error |
red | The last backup failed. |
overdue |
red | An active backup plan did not make a valid backup in time. |
disconnected |
yellow | A target is disconnected. |
warn |
yellow | The website is backed up; the last backup ended with warnings. |
ok |
green | The website is backed up. |
none |
grey | There is no backup yet. |
Below it come the details. The lines plans and operation are always there, the others only when there is something to report:
| Line | Meaning |
|---|---|
last backup |
The last backup: job name, status, end, size and the state per target. |
last valid backup |
The last valid backup, if it is not the last backup. |
overdue |
The overdue plan and how long it has been due or has not made a valid backup. |
disconnected |
The disconnected target with the reason. If there are several, the line shows the number. |
warnings |
The warnings of the last backup, counted by kind. |
plans |
How many plans are active, how many there are and the number of targets. |
alarm |
The plans for which a warning about an overdue backup is running. |
operation |
The operation: the result, the last automatic tick with its task source, WP-Cron and the self-request. |
The result in the line operation is ok, late or missing. late means: there is an active plan, but no automatic task source has arrived for two hours. missing means: the server lacks a requirement of the plugin.
Fetching the logs: logs
logs lists the log files of the plugin or writes all of them into a tar file. There is the global log with one file per day and one log per job.
| Parameter | Meaning | Allowed values |
|---|---|---|
--to |
Writes all logs into a tar file with this name, without a path. The file is created in the folder cloneworx-backup-exports-… in the uploads folder and must not exist yet. --to without a name writes, for example, logs-2026-11-10_1652.tar. Without the parameter the command only shows the list. |
File name of letters, digits, dot, underscore and hyphen, or no value |
# List the log files wp cloneworx-backup logs # Write all logs to a tar file wp cloneworx-backup logs --to=logs.tar
The list shows the name, the size and the last change of each file, and at the end the number of files and their total size. The tar file is not compressed and contains the folder cloneworx-backup-logs. It is the same file as with Download all logs on the Settings page.
How you read a log is shown in Read the log.
Creating the support report: support
support prints the support report as text or writes it to a file. It is the same report as with Copy support report on the Settings page.
| Parameter | Meaning | Allowed values |
|---|---|---|
--to |
Writes the report into a file with this name, without a path. The file is created in the folder cloneworx-backup-exports-… in the uploads folder and must not exist yet. --to without a name writes, for example, support-2026-11-10_1652.txt. Without the parameter the report appears in the output. |
File name of letters, digits, dot, underscore and hyphen, or no value |
# Show the report in the output wp cloneworx-backup support # Write the report to a file wp cloneworx-backup support --to=support.txt
The report has the sections website, server, plugin, settings, operation, targets, plans, the last ten jobs, scope, diagnosis and the last 40 lines of the global log. The report is in English.
Not in the report: job names and other identifiers of 32 characters, the names of targets and plans, the locations and credentials of the targets, email addresses and server paths. Targets and plans appear with their identifier, email addresses only as a number, paths as <wp>, <wp-content> and <uploads>. The report contains the address of the website, per target the target type and the state and per plan rhythm, roots, targets and the number for Max. backups.
Nothing is sent
The command does not send the report anywhere. Read it through before you pass it on.
Switching debugging on and off: debug
With debugging the plugin writes detailed lines to the log. After 24 hours it switches itself off. In the interface the switch is called Debugging for 24 hours.
| Action | Purpose |
|---|---|
debug on |
Switches debugging on and shows the time until which it runs. |
debug off |
Switches debugging off. |
debug status |
Shows whether debugging is running and until when. Without an action wp cloneworx-backup debug does the same. |
on and off support the parameter --force.
# Enable debugging wp cloneworx-backup debug on # Show the state wp cloneworx-backup debug status # Disable debugging wp cloneworx-backup debug off
If the plugin cannot write its log, each of the three actions warns and shows the reason.
Checking the notifications: notify
| Action | Purpose |
|---|---|
notify status |
Shows the recipients, the three switches of the notifications, the running warnings about overdue backups, the last check, the last email sent and the last failure when sending. Without an action wp cloneworx-backup notify does the same. |
notify check |
Checks now whether a plan is overdue. If a warning begins or a reminder is due, the plugin sends the email if this notification is switched on. |
notify test |
Sends a test email to the entered recipients. If nobody is entered, it goes to the admin address of the website. |
check and test support the parameter --force.
# Show the status of the notifications wp cloneworx-backup notify status # Check for overdue backups now wp cloneworx-backup notify check # Send a test email wp cloneworx-backup notify test
A plan is overdue when its last valid backup is older than its rhythm plus a tolerance. The tolerance is half the rhythm, at least 6 hours: a daily plan is overdue after 36 hours. This check runs automatically on every task source, at most every 15 minutes.
notify check lists the overdue plans and counts how many warnings have begun, have had a reminder and have ended, and how many emails were sent. notify test lists the addresses the test email went to. If WordPress refuses to send, the command ends with an error and shows the reason.
You change the recipients and the switches with wp cloneworx-backup settings; see Settings and scope with WP-CLI.
Showing and renewing the key of the credentials: key
key shows what protects the key with which the plugin encrypts the passwords and keys of the targets, or renews this key. In the interface this is the tile Key of the page Settings.
| Action | Purpose |
|---|---|
key status |
Shows what protects the key, for example Key: in the database, protected by LOGGED_IN_KEY and LOGGED_IN_SALT in wp-config.php. If the key cannot be read, NOT READABLE is added. If wp-config.php has no usable values, it shows Key: none. Below are the number of targets with stored credentials and the number of unreadable values. Without an action, wp cloneworx-backup key does the same. |
key renew |
Creates a new key and re-encrypts all stored credentials with it. If the previous key cannot be read, the stored credentials are lost; the command shows the number of targets whose credentials you have to enter again. |
| Parameter | Meaning | Allowed values |
|---|---|---|
--force |
Only renew: also runs as another user. |
without a value |
# Show what protects the key of the credentials wp cloneworx-backup key status # Renew the key wp cloneworx-backup key renew
The passwords at the targets stay the same. If a single stored value cannot be read or wp-config.php has no usable values, the command ends with an error and shows the reason; nothing is changed then.
The key depends on wp-config.php
If LOGGED_IN_KEY and LOGGED_IN_SALT or CLONEWORX_BACKUP_KEY change in wp-config.php, the stored credentials can no longer be read.
Watching, continuing, aborting the running job: job
A backup, a restore, a check: everything that takes longer runs as a job in many short steps. Only one job runs per website at a time. job works with the job that is running right now.
| Action | Purpose |
|---|---|
job status |
Shows the running job. Without an action wp cloneworx-backup job does the same. |
job run |
Runs the running job to the end in this process, without pauses between the steps. |
job abort |
Registers the abort. The job stops at its next stopping point, cleans up and ends as aborted. If a restore is already past the switch-over, the command refuses and points to restore undo. |
job probe |
Starts a probe run: a job without data that measures the server. |
# Show the running job wp cloneworx-backup job status # Drive the running job to the end here wp cloneworx-backup job run # Cancel the running job wp cloneworx-backup job abort
job status shows the job name, the kind of job, who started it and whether a step is working right now. Below it come the progress with phase, entries, bytes and remaining time and the counters: steps, hard-ended steps, attempts without progress, warnings. If no job is running, the command says so.
job run writes one line per step and at the end the result of the job. If another process is already running the job, the command waits briefly and then gives up. The job continues without it.
The probe run: job probe
The probe run measures how long a step can really run on your server, which task sources arrive, how fast the work folder can be written to and how much memory is available. It backs up nothing and touches no target.
| Parameter | Meaning | Allowed values |
|---|---|---|
--units |
The number of work units. | whole number, default 200 |
--unit-ms |
The simulated work per unit in milliseconds. | whole number, default 50 |
--background |
The command starts the probe run and sends the first self-request. After that the job continues itself through the web server. The result then shows the limits of the web server, not those of the command line. | without a value |
--force |
Also runs as another user. | without a value |
# A probe run over several steps: about 100 seconds wp cloneworx-backup job probe --units=2000 --unit-ms=50 # The same probe run, driven by the web server wp cloneworx-backup job probe --units=2000 --unit-ms=50 --background
Afterwards the result is also shown on the Settings page in the tile System and support, in the block Diagnosis of the Extended view.
Further diagnostic jobs
Three further actions start diagnostic jobs. None of them makes a backup; they remove what they write again at the end.
| Action | Purpose | Own parameters |
|---|---|---|
job filelist |
Builds the file list: what a backup would contain, what is left out and whether the free space is enough. |
--roots, --targets
|
job dbexport |
Exports the database into the work folder, reads the export back and compares the rows per table. |
--tables, --no-snapshot
|
job files |
Writes the file part of a backup into the work folder and checks every part. With --targets the job transfers the parts to these targets, checks them there and removes them again. |
--roots, --targets, --part-limit (size of a part in MB, default 256) |
All three also support --max-per-step, --background and --force.
# Show what a backup of uploads and plugins would contain wp cloneworx-backup job filelist --roots=wp-uploads,wp-plugins # Check the database export wp cloneworx-backup job dbexport