WordPress CLI¶
WP-CLI is the command-line interface for WordPress. It allows you to perform many actions that would normally require visiting your WordPress Dashboard in a browser. The following commands are provided by LiteSpeed, so that you may manage your cache with the CLI.
Tip
LiteSpeed CLI commands accept standard WP parameters, in addition to any specific parameters that we mention in the command descriptions.
The syntax for LiteSpeed CLI commands looks like this:
wp <command> <subcommand> [parameters]
The following commands are available:
| Command | Scope |
|---|---|
| litespeed-option | Options |
| litespeed-purge | Purge |
| litespeed-presets | Presets |
| litespeed-image | Image Optimization |
| litespeed-online | QUIC.cloud Online Services |
| litespeed-debug | Debug |
| litespeed-crawler | Crawler |
| litespeed-database | Database Optimization |
litespeed-option¶
The litespeed-option command allows you to manipulate your LSCWP settings.
Syntax:
wp litespeed-option <subcommand> [parameters]
| Subcommand | Description |
|---|---|
set | Set a particular option |
get | Get a particular option |
all | Get all options |
export | Export options |
import | Import options |
import_remote | Import remote options |
reset | Reset options |
litespeed-option set¶
wp litespeed-option set <key> <value>
Set a particular option.
| Parameter | Description |
|---|---|
<key> | The option key to update |
<value> | The value to assign to the option |
Example
Set Cache Logged-in Users to OFF:
wp litespeed-option set cache-priv false
Example
Set the first URL in CDN Mapping to https://cdn.example.com:
wp litespeed-option set 'cdn-mapping[url][0]' https://cdn.example.com
Example
What if <value> contains multiple lines? The CLI doesn't accept multi-line input, so you would need to use a different syntax, like this:
wp litespeed-option set <key> $'<value1>\n<value2>'
To set LQIP Excludes to a list of three images like this:
img1.jpg
img2.jpg
img3.jpg
wp litespeed-option set media-lqip_exc $'img1.jpg\nimg2.jpg\nimg3.jpg'`
litespeed-option get¶
wp litespeed-option get <key>
Get a particular option.
| Parameter | Description |
|---|---|
<key> | The option key to return the value of |
Example
Get the value of Cache Logged-in Users:
wp litespeed-option get cache-priv
Example
Get the value of the first URL in CDN Mapping:
wp litespeed-option get 'cdn-mapping[url][0]'
litespeed-option all¶
wp litespeed-option all
Displays a list of all options and their values. No parameters.
litespeed-option export¶
wp litespeed-option export `[--filename=<path>]`
All options are exported to CURRENTDIR/lscache_wp_options_DATE-TIME.txt unless a new path is specified.
| Parameter | Description |
|---|---|
[--filename=<path>] | Different path to save export file. Optional. |
Example
Export all options to /tmp/export:
wp litespeed-option export --filename=/tmp/export
litespeed-option import¶
wp litespeed-option import <file>
Import options from specified file. Options must be one per line and formatted as option_key=option_value. A semicolon (;) at the beginning of a line indicates a comment. Comment lines are ignored.
| Parameter | Description |
|---|---|
<file> | Options file to import |
Example
Import from options.txt file:
wp litespeed-option import options.txt
litespeed-option import_remote¶
wp litespeed-option import_remote <URL>
Import options from a remote URL. Options must be one per line and formatted as option_key=option_value. A semicolon (;) at the beginning of a line indicates a comment. Comment lines are ignored.
| Parameter | Description |
|---|---|
<URL> | URL of options file to import |
Example
Import from https://example.com/options.txt
wp litespeed-option import_remote https://example.com/options.txt
litespeed-option reset¶
wp litespeed-option reset
Resets all options to factory default. No parameters.
litespeed-purge¶
The litespeed-purge command allows you to purge all of your site’s cache content, or subsets of it.
Syntax:
wp litespeed-purge <subcommand> [parameters]
| Subcommand | Description |
|---|---|
network_list | List all site domains and IDs on the network |
all | Purge all cache entries |
url | Purge all cache tags related to a URL |
blog | Purge all cache tags for a particular site in the network |
category | Purge all cache entries for a list of categories |
tag | Purge all cache entries for a list of tags |
post_id | Purge all cache entries for a list of post IDs |
litespeed-purge network_list¶
wp litespeed-purge network_list
List all site domains and IDs on the network. No parameters.
litespeed-purge all¶
wp litespeed-purge all
Purge all cache entries for every site in the network. Also works for non-networked sites, and just purges that single site. No parameters
litespeed-purge url¶
wp litespeed-purge url <url>
Purge all cache tags related to a URL.
| Parameter | Description |
|---|---|
<url> | The URL to purge |
Example
Purge all cache tags related to https://example.com:
wp litespeed-purge url https://example.com
litespeed-purge blog¶
wp litespeed-purge blog <blogid>
Purge all cache entries for a particular site in the network.
| Parameter | Description |
|---|---|
<blogid> | ID of the site to purge |
Example
Purge all cache for site with the ID 2:
wp litespeed-purge blog 2
litespeed-purge category¶
wp litespeed-purge category <ids>
Purge all cache entries for a list of categories.
| Parameter | Description |
|---|---|
<ids> | IDs of the categories to purge, separated by a space |
Example
Purge the categories with the IDs 1, 3, and 5:
wp litespeed-purge category 1 3 5
litespeed-purge tag¶
wp litespeed-purge tag <ids>
Purge all cache entries for a list of tags.
| Parameter | Description |
|---|---|
<ids> | IDs of the tags to purge, separated by a space |
Example
Purge the tags with the IDs 1, 3, and 5:
wp litespeed-purge tag 1 3 5
litespeed-purge post_id¶
wp litespeed-purge post_id <ids>
Purge all cache entries for a list of post IDs.
| Parameter | Description |
|---|---|
<ids> | IDs of the posts to purge, separated by a space |
Example
Purge the posts with the IDs 1, 3, and 5:
wp litespeed-purge post_id 1 3 5
litespeed-presets¶
Apply presets and restore backups using litespeed-presets.
Syntax:
wp litespeed-presets <subcommand> [parameters]
| Subcommand | Description |
|---|---|
apply | Apply a particular preset configuration |
get_backups | Get a list of available backups |
restore | Restore a previous configuration |
litespeed-presets apply¶
wp litespeed-presets apply <preset>
Apply a particular preset configuration.
| Parameter | Description |
|---|---|
<preset> | Name of the preset to apply |
Example
Apply the basic preset:
wp litespeed-presets apply basic
litespeed-presets get_backups¶
wp litespeed-presets get_backups
When you apply a preset, a backup is saved of your existing configuration before the preset is applied. This option provides a list of available backups. No parameters.
litespeed-presets restore¶
wp litespeed-presets restore <backup_number>
Restore a previous configuration using one of the backups listed via the get_backups option.
| Parameter | Description |
|---|---|
<backup_number> | Number of the backup to restore |
Example
Restore backup number 1667485245:
wp litespeed-presets restore 1667485245
litespeed-image¶
The litespeed-image command allows you to control certain aspects of the QUIC.cloud image optimization service.
wp litespeed-image <subcommand> [parameters]
| Subcommand | Description |
|---|---|
push | Push images |
pull | Pull images |
status or s | Get status |
clean | Clean up |
rm_bkup | Remove original backups |
batch_switch | Switch between optimized or original backups |
litespeed-image push¶
wp litespeed-image push
Send an image optimization request to the QUIC.cloud server. No parameters.
litespeed-image pull¶
wp litespeed-image pull
Pull optimized images from the QUIC.cloud server. No parameters.
litespeed-image status¶
wp litespeed-image status
Show optimization status based on local data. No parameters.
litespeed-image clean¶
wp litespeed-image clean
Clean up unfinished image data on the QUIC.cloud server. No parameters.
litespeed-image rm_bkup¶
wp litespeed-image rm_bkup
Remove original image backups. No parameters.
litespeed-image batch_switch¶
wp litespeed-image batch_switch <type>
Switch between serving optimized images and the original image backups.
| Parameter | Description |
|---|---|
<type> | Type of images to serve. May be optm for optimized or orig for original images. |
Example
Switch to serving optimized images:
wp litespeed-image batch_switch optm
litespeed-online¶
Use the litespeed-online command to control certain aspects of QUIC.cloud CDN and Online Services, and lookup information.
Syntax:
wp litespeed-online <subcommand> [parameters]
| Subcommand | Description |
|---|---|
init | Generate domain API key |
sync | Synchronize usage information |
services | List all services |
nodes | List active nodes |
ping | Find closest active node for a service |
cdn_status | Return status of CDN for your account |
cdn_ini | Activate CDN for a particular domain |
link |
litespeed-online init¶
wp litespeed-online init
Generate an anonymous domain API key for secure communication with QUIC.cloud. No parameters.
litespeed-online sync¶
wp litespeed-online sync
Synchronize QUIC.cloud service usage information. No parameters.
litespeed-online services¶
wp litespeed-online services
List all QUIC.cloud services. No parameters.
litespeed-online nodes¶
wp litespeed-online nodes
List all currently active QUIC.cloud nodes. No parameters.
litespeed-online ping¶
wp litespeed-online ping <service> [--force]
Detect the closest active QUIC.cloud node for a particular service.
| Parameter | Description |
|---|---|
<service> | Service to find a node for |
--force | Don't read the node from cache, redetect it |
Example
Find the closest active image optimization node, and it’s ok to read it from cache:
wp litespeed-online ping img_optm
litespeed-online cdn_status¶
wp litespeed-online cdn_status
Return information pertaining to your account status and whether the CDN is enabled or disabled for your account. No parameters.
litespeed-online cdn_ini¶
wp litespeed-online cdn_init --method=cname|ns|cfi [--cf-token=] [--ssl-cert=] [--ssl-key=]
Activate QUIC.cloud CDN for a specified domain.
| Parameter | Description |
|---|---|
--ssl-cert | SSL Certificate, optional |
--ssl-key | SSL Key, optional |
--method | Possible values for the setup method: cname (CNAME record), ns (QUIC.cloud DNS), cfi (CloudFlare Integration) |
--cf-token | Cloudflare token, optional, for use with --method: cfi |
Example
Set up QUIC.cloud CDN using the Cloudflare Integration method and Cloudflare token 123456789:
wp litespeed-online cdn_init --method=cfi --cf-token=123456789
litespeed-online link¶
wp litespeed-online link --email=<string> --api-key=<string>
Link a user account by API key
| Parameter | Description |
|---|---|
--email | QUIC.cloud account email |
--api-key | API Key |
Example
Link the you@example.com account with API key 123456789:
wp litespeed-online link --email=you@example.com --api-key=123456789
litespeed-debug¶
LiteSpeed Debug commands begin with litespeed-debug.
Syntax:
wp litespeed-debug <subcommand> [parameters]
| Subcommand | Description |
|---|---|
send | Send an Environment Report to LiteSpeed support |
litespeed-debug send¶
wp litespeed-debug send
Send an Environment Report to LiteSpeed support. No parameters.
litespeed-crawler¶
Use litespeed-crawler to control the cache crawlers.
Syntax:
wp litespeed-crawler <subcommand> [parameters]
| Subcommand | Description |
|---|---|
list or l | List all existing crawlers |
enable | Enable the specified crawler |
disable | Disable the specified crawler |
run or r | Start running the crawlers |
reset | Reset the crawler position |
litespeed-crawler list¶
wp litespeed-crawler list
Get a list of all existing crawlers. No parameters.
litespeed-crawler enable¶
wp litespeed-crawler enable <number>
Enable the specified crawler.
| Parameter | Description |
|---|---|
<number> | The crawler ID number |
Example
Enable the crawler with ID 2:
wp litespeed-crawler enable 2
litespeed-crawler disable¶
wp litespeed-crawler disable <number>
Disable the specified crawler.
| Parameter | Description |
|---|---|
<number> | The crawler ID number |
Example
Disable the crawler with ID 2:
wp litespeed-crawler disable 2
litespeed-crawler run¶
wp litespeed-crawler run
Start the crawler running. No parameters.
litespeed-crawler reset¶
wp litespeed-crawler reset
Reset the crawler's position. No parameters.
litespeed-database¶
Database Optimization commands correspond to the buttons found in the plugin GUI at LiteSpeed Cache > Database > Manage. These commands all begin with litespeed-database, and have no parameters.
Syntax:
wp litespeed-database <subcommand>
| Subcommand | Description |
|---|---|
clear_posts | Clean up post data |
clear_comments | Clean up comment data |
clear_trackbacks | Clean up trackbacks and pingbacks |
clear_transients | Clean up transients |
optimize_tables | Optimize database tables |
optimize_all | Perform all possible optimizations and clean ups |
litespeed-database clear_posts¶
wp litespeed-database clear_posts
Clean up post data, which includes revisions, orphaned posts, auto drafts, and trashed posts. No parameters.
litespeed-database clear_comments¶
wp litespeed-database clear_comments
Clean up comment data, which includes spam comments and trashed comments. No parameters.
litespeed-database clear_trackbacks¶
wp litespeed-database clear_trackbacks
Clean up trackbacks and pingbacks. No parameters.
litespeed-database clear_transients¶
wp litespeed-database clear_transients
Clean up transients. No parameters.
litespeed-database optimize_tables¶
wp litespeed-database optimize_tables
Optimize database tables. No parameters.
litespeed-database optimize_all¶
wp litespeed-database optimize_all
Perform all possible optimizations and clean ups. No parameters.