WP-CLI reference

WellTend Site and Admin Toolkit adds the wp awc toolkit command to WP-CLI. It lives under the shared wp awc namespace that all AllWPCare plugins use. Everything the dashboard can do for a module, the command line can do too, and it is also the way back in when a module has locked you out.

Module ids are the short names shown by wp awc toolkit list, for example disable_xmlrpc. Run any command with --help for the same text as below.

wp awc toolkit list#

List modules.

wp awc toolkit list [--category=<id>] [--enabled] [--format=<format>]

wp awc toolkit list --enabledwp awc toolkit list --category=disable

The columns are id, name, category, risk (normal or risky) and enabled (yes or no).

wp awc toolkit enable#

Enable modules.

wp awc toolkit enable <id>... [--yes]

wp awc toolkit enable disable_xmlrpc hide_wp_version

wp awc toolkit disable#

Disable modules. Also the way back in when a module locked you out.

wp awc toolkit disable <id>... [--yes]

wp awc toolkit disable change_login_url

wp awc toolkit get#

Show the settings of a module. Credentials such as an SMTP password are never printed.

wp awc toolkit get <id> [<key>] [--format=<format>]

Without <key> every option is shown. --format can be table, json, csv or yaml; the default is json.

wp awc toolkit get limit_revisions

{    "enabled": true,    "max": 5,    "post_types": []}

wp awc toolkit set#

Set one option of a module. enabled works as a key too. Lists and rows are given as JSON, for example '["post","page"]'.

wp awc toolkit set <id> <key> <value> [--yes]

wp awc toolkit set limit_revisions max 10wp awc toolkit set limit_revisions post_types '["post","page"]'

The value is checked against the same rules as in the dashboard. A value that is out of range or of the wrong kind is refused with a message, not silently changed.

Passwords and keys. Do not type a password or key on the command line: it stays in your shell history. For an option that holds one, give a single dash and the command reads the value from what you type or pipe in. An empty value ('') clears it. The value is never printed back.

wp awc toolkit set password_protection password -printf '%s' "$SITE_PASSWORD" | wp awc toolkit set password_protection password -

A command that is missing something says so, with the line to type, for example Missing argument. Usage: wp awc toolkit set <id> <key> <value>.

wp awc toolkit reset#

Reset the options of a module to their defaults. The module stays on or off.

wp awc toolkit reset <id> [--yes]

wp awc toolkit undo#

Undo the last change of a module. Run it again to redo.

wp awc toolkit undo <id> [--yes]

wp awc toolkit lockouts#

Show or empty the login lockouts of the Limit Login Attempts module.

wp awc toolkit lockouts <action> [<address>]

<action> is list, release (with the IP address to unlock) or clear.

wp awc toolkit lockouts listwp awc toolkit lockouts release 203.0.113.7wp awc toolkit lockouts clear

wp awc toolkit import-scm#

Carry over the modules that were switched on in Site Config Manager 0.3 (now WellTend Snapshots), before the Toolkit existed as its own plugin. Only modules that were on there and have never been saved here are imported.

wp awc toolkit import-scm

Pausing every module#

If you cannot reach WP-CLI either, add this line to your own wp-config.php:

define( 'AWC_DISABLE_MODULES', true );

true pauses all modules. A comma-separated list, such as 'change_login_url,maintenance_mode', pauses only those. The plugin never writes this line for you. See Risky modules and recovery.