{"id":255,"date":"2021-07-23T12:26:37","date_gmt":"2021-07-23T12:26:37","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/wordpress-toolkit-command-line-interface\/"},"modified":"2021-07-23T12:26:37","modified_gmt":"2021-07-23T12:26:37","slug":"wordpress-toolkit-command-line-interface","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/wordpress-toolkit-command-line-interface\/","title":{"rendered":"WordPress\u00ae Toolkit Command Line Interface"},"content":{"rendered":"<\/p>\n<div class=\"col-md-9\">\n<div class=\"flex-column flex-md-row article-header\">\n<div id=\"versioned-article-header\">\n<p class=\"valid-version-info\"><em>Valid for versions 92 through the latest version<\/em><\/p>\n<\/div>\n<div id=\"version-select-group\" aria-label=\"select versions\">\n<h4>Version:<\/h4>\n<h4>92<\/h4>\n<\/div><\/div>\n<hr>\n<h2 id=\"overview\">Overview<\/h2>\n<p>This document lists all of the commands available via the WordPress\u00ae Toolkit command line interface.<\/p>\n<h3 id=\"create-a-wordpress-site-backup\">Create a WordPress site backup<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --backup\n    -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH\n    -operation list|backup|restore -filename FILENAME\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td>The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td>The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td>The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-operation<\/code><\/td>\n<td>The action to perform: <\/p>\n<ul>\n<li><code>backup<\/code> \u2014\u00a0Perform a WordPress site backup.<\/li>\n<li><code>restore<\/code>\u00a0\u2014\u00a0Restore a WordPress site backup.<\/li>\n<li><code>list<\/code> \u2014 List available backup files.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-filename<\/code><\/td>\n<td>The backup file\u2019s name.<\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --backup -instance-id <span style=\"color:#ae81ff\">1<\/span> -operation backup<\/code><\/pre>\n<\/div>\n<h3 id=\"clear-a-wordpress-installation-cache\">Clear a WordPress installation cache<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --clear-cache \n    -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-1\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td><strong>Required<\/strong>  The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td><strong>Required<\/strong>  The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-1\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --clear-cache -instance-id <span style=\"color:#ae81ff\">1<\/span><\/code><\/pre>\n<\/div>\n<h3 id=\"clear-the-wordpress-toolkit-cache\">Clear the WordPress Toolkit cache<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --clear-wpt-cache <\/code><\/pre>\n<\/div>\n<h3 id=\"display-the-wordpress-toolkit-help-documentation\">Display the WordPress Toolkit help documentation<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --help\n    -command COMMAND_NAME<\/code><\/pre>\n<\/div>\n<h4 id=\"options-2\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>Option<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-command<\/code><\/td>\n<td>Display a WordPress Toolkit command\u2019s help documentation.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-2\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --help -command wp-cli<\/code><\/pre>\n<\/div>\n<h3 id=\"clone-a-wordpress-site-to-a-domain-and-or-subdirectory\">Clone a WordPress site to a domain and\/or subdirectory<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --clone\n    -source-instance-id INSTANCE_ID\n    -target-domain-name DOMAIN_NAME\n    -target-path PATH\n    -target-db-name DB_NAME\n    -target-db-user-login DB_USER_LOGIN\n    -force-overwrite yes|no\n    -format raw|json\n    -show-progress yes|no<\/code><\/pre>\n<\/div>\n<h4 id=\"options-3\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:180px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-source-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The source WordPress site ID to clone.<\/td>\n<\/tr>\n<tr>\n<td><code>-target-domain-name<\/code><\/td>\n<td>The target domain name to clone the WordPress site ID to.<\/td>\n<\/tr>\n<tr>\n<td><code>-target-path<\/code><\/td>\n<td>The path inside the target domain\u2019s document root for cloning the WordPress site. This option defaults to the domain root.<\/td>\n<\/tr>\n<tr>\n<td><code>-target-db-name<\/code><\/td>\n<td>The target database name. If you do <strong>not<\/strong> use this option, the command automatically creates the database\u2019s name.<\/td>\n<\/tr>\n<tr>\n<td><code>-target-db-user-login<\/code><\/td>\n<td>The username of the target database user. To specify a password for the database user, use the <code>TARGET_DB_USER_PASSWORD<\/code> environment variable. If you do <strong>not<\/strong> use this option, the command automatically creates the username.<\/td>\n<\/tr>\n<tr>\n<td><code>-force-overwrite<\/code><\/td>\n<td>Whether WordPress Toolkit will overwrite data on the target domain and path, ignoring any existing WordPress installations and other site data. <\/p>\n<ul>\n<li><code>yes<\/code>\u00a0\u2014\u00a0Overwrite data.<\/li>\n<li><code>no<\/code> \u2014\u00a0Do <strong>not<\/strong> overwrite data.<\/li>\n<\/ul>\n<p> This option defaults to <code>no<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<tr>\n<td><code>-show-progress<\/code><\/td>\n<td>Whether to display the operation\u2019s progress: <\/p>\n<ul>\n<li><code>yes<\/code> \u2014\u00a0Display the operation\u2019s progress.<\/li>\n<li><code>no<\/code> \u2014 Perform the operation silently.<\/li>\n<\/ul>\n<p> By default, the command displays the operation progress unless you\u2019ve specified the <code>json<\/code> output format.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-3\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --clone -source-instance-id <span style=\"color:#ae81ff\">1<\/span> -target-domain-id <span style=\"color:#ae81ff\">2<\/span><\/code><\/pre>\n<\/div>\n<h3 id=\"manage-wordpress-toolkit-configuration-settings\">Manage WordPress Toolkit configuration settings<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --config\n    -operation list|get|set|rollback\n    -option-name OPTION_NAME\n    -option-value OPTION_VALUE\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-4\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-operation<\/code><\/td>\n<td><strong>Required<\/strong>  The action to perform: <\/p>\n<ul>\n<li><code>list<\/code> \u2014\u00a0Display all available configuration settings and their current values.<\/li>\n<li><code>get<\/code> \u2014\u00a0Display a configuration setting\u2019s information. This option requires the <code>-option-name<\/code> option.<\/li>\n<li><code>set<\/code> \u2014 Set a new configuration setting value. This option requires the <code>-option-name<\/code> and <code>-option-value<\/code> options.<\/li>\n<li><code>rollback<\/code> \u2014 Restore a configuration setting to its default value. This option requires the <code>-option-name<\/code> option.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-option-name<\/code><\/td>\n<td>The configuration setting\u2019s name. The setting\u2019s name is <strong>case-sensitive<\/strong> and <strong>cannot<\/strong> be a <code>read-only<\/code> configuration setting.<\/td>\n<\/tr>\n<tr>\n<td><code>-option-value<\/code><\/td>\n<td>The new configuration setting value.<\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-4\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --config -operation get -option-name logSecurityCheckErrors<\/code><\/pre>\n<\/div>\n<h3 id=\"copy-file-and-database-table-data-from-one-wordpress-site-to-another\">Copy file and database table data from one WordPress site to another<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --copy-data\n    -source-instance-id SOURCE_INSTANCE_ID\n    -target-instance-id TARGET_INSTANCE_ID\n    -data-to-copy all|files|db\n    -files-replace-modified yes|no\n    -files-remove-missing yes|no\n    -db-tables-copy-mode default|all|new|selected\n    -db-tables COMMA_SEPARATED_LIST_OF_TABLE_NAMES\n    -exclude-db-tables COMMA_SEPARATED_LIST_OF_TABLE_NAMES\n    -create-restore-point yes|no\n    -show-progress yes|no<\/code><\/pre>\n<\/div>\n<h4 id=\"options-5\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:180px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-source-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The source WordPress site\u2019s installation ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-target-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The target WordPress site\u2019s installation ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-data-to-copy<\/code><\/td>\n<td>The data to copy: <\/p>\n<ul>\n<li><code>all<\/code> \u2014 Copy all files and database.<\/li>\n<li><code>files<\/code> \u2014 Copy files <strong>only<\/strong>.<\/li>\n<li><code>db<\/code> \u2014 Copy the database <strong>only<\/strong>.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-files-replace-modified<\/code><\/td>\n<td>Whether to replace the target WordPress site\u2019s files with the source WordPress site\u2019s files, even if the source site\u2019s files are older: <\/p>\n<ul>\n<li><code>yes<\/code>\u00a0\u2014 Replace the target site\u2019s files.<\/li>\n<li><code>no<\/code>\u00a0\u2014\u00a0Do <strong>not<\/strong> replace the target site\u2019s files.<\/li>\n<\/ul>\n<p> This option defaults to <code>yes<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>-files-remove-missing<\/code><\/td>\n<td>Whether to remove any files that exist on the target WordPress site but do <strong>not<\/strong> exist on the source site: <\/p>\n<ul>\n<li><code>yes<\/code> \u2014\u00a0Remove files.<\/li>\n<li><code>no<\/code>\u00a0\u2014 Do <strong>not<\/strong> remove files.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-db-tables-copy-mode<\/code><\/td>\n<td>The database tables to copy: <\/p>\n<ul>\n<li><code>default<\/code> \u2014 Copy all tables <strong>except<\/strong> the <code>postmeta<\/code>, <code>posts<\/code>, <code>usermeta<\/code>, <code>users<\/code> data tables.<\/li>\n<li><code>all<\/code> \u2014 Copy all tables of the source WordPress site. You can exclude specific tables with the <code>-exclude-db-tables<\/code> option.<\/li>\n<li><code>new<\/code> \u2014 Copy tables that exist on the source WordPress site but do <strong>not<\/strong> exist on the target WordPress site.<\/li>\n<li><code>selected<\/code> \u2014 Select the exact tables to copy. This option requires the <code>-db-tables<\/code> option.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-db-tables<\/code><\/td>\n<td>A comma-separated list of database tables to copy.<\/td>\n<\/tr>\n<tr>\n<td><code>-exclude-db-tables<\/code><\/td>\n<td>A comma-separated list of database tables to exclude from copying.<\/td>\n<\/tr>\n<tr>\n<td><code>-create-restore-point<\/code><\/td>\n<td>Create a restore point you can use to revert any changes: <\/p>\n<ul>\n<li><code>yes<\/code> \u2014\u00a0Create a restore point.<\/li>\n<li><code>no<\/code> \u2014\u00a0Do <strong>not<\/strong> create a restore point.<\/li>\n<\/ul>\n<p> This option defaults to <code>yes<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>-show-progress<\/code><\/td>\n<td>Whether to display the operation\u2019s progress: <\/p>\n<ul>\n<li><code>yes<\/code> \u2014\u00a0Display the operation\u2019s progress.<\/li>\n<li><code>no<\/code> \u2014 Perform the operation silently.<\/li>\n<\/ul>\n<p> By default, the function displays the operation progress <strong>unless<\/strong> you\u2019ve specified the <code>json<\/code> output format.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-5\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --copy-data -source-instance-id <span style=\"color:#ae81ff\">1<\/span> -target-instance-id <span style=\"color:#ae81ff\">2<\/span> -data-to-copy files<\/code><\/pre>\n<\/div>\n<h3 id=\"detach-a-wordpress-site-from-wordpress-toolkit\">Detach a WordPress site from WordPress Toolkit<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --detach \n    -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH<\/code><\/pre>\n<\/div>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<p>This command does <strong>not<\/strong> uninstall the cPanel account\u2019s WordPress site.<\/p>\n<\/p><\/div>\n<\/div>\n<h4 id=\"options-6\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td><strong>Required<\/strong>  The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td><strong>Required<\/strong>  The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-6\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --detach -instance-id <span style=\"color:#ae81ff\">1<\/span><\/code><\/pre>\n<\/div>\n<h3 id=\"display-information-about-a-wordpress-installation\">Display information about a WordPress installation<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --info\n    -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-7\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td><strong>Required<\/strong>  The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td><strong>Required<\/strong>  The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-7\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --info -instance-id <span style=\"color:#ae81ff\">1<\/span><\/code><\/pre>\n<\/div>\n<h3 id=\"install-a-new-wordpress-site-on-a-domain\">Install a new WordPress site on a domain<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --install\n    -domain-name DOMAIN_NAME\n    -username USERNAME\n    -admin-email EMAIL\n    -protocol PROTOCOL\n    -path PATH\n    -version VERSION\n    -language LANGUAGE\n    -db-name DB_NAME\n    -db-user DB_USER\n    -table-prefix TABLE_PREFIX\n    -site-title SITE_TITLE\n    -auto-updates true|false|minor\n    -plugins-auto-updates true|false\n    -themes-auto-updates true|false\n    -format raw|json\n    -show-progress yes|no<\/code><\/pre>\n<\/div>\n<h4 id=\"options-8\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:180px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td><strong>Required<\/strong>  The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-username<\/code><\/td>\n<td>The WordPress site administrator\u2019s username. To set its password, use the <code>ADMIN_PASSWORD<\/code> environment variable.  If you do <strong>not<\/strong> specify this value, the system generates an <code>admin_<\/code> account with a randomized suffix value. For example: <code>admin_jzsfbt4l<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-admin-email<\/code><\/td>\n<td>The WordPress site administrator\u2019s email address.  If you do <strong>not<\/strong> specify this value, the system creates the <code>admin<\/code> email account. For example: <code>admin@example.com<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-protocol<\/code><\/td>\n<td>The WordPress site\u2019s protocol: <\/p>\n<ul>\n<li><code>http<\/code>\u00a0\u2014 The HTTP protocol.<\/li>\n<li><code>https<\/code>\u00a0\u2014\u00a0The HTTPS protocol.<\/li>\n<\/ul>\n<p> This option defaults to <code>https<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td>A relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code>  This option defaults to the cPanel account\u2019s home directory.<\/td>\n<\/tr>\n<tr>\n<td><code>-version<\/code><\/td>\n<td>The WordPress version number. For a list of available versions, use the <code>--versions<\/code> command.  This option defaults to the most recent version of WordPress.<\/td>\n<\/tr>\n<tr>\n<td><code>-language<\/code><\/td>\n<td>The WordPress site\u2019s locale. For a list of available locales, use the <code>--languages<\/code> command.  This option defaults to <code>en_US<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>-db-name<\/code><\/td>\n<td>The database\u2019s name.  If you do <strong>not<\/strong> specify this value, the system generates a database name using the cPanel account\u2019s username. For example: <code>username_wp_f0ehk<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-db-user<\/code><\/td>\n<td>The database user\u2019s username. To specify a password for the database user, use the <code>DB_PASSWORD<\/code> environment variable.  If you do <strong>not<\/strong> specify this value, the system generates a username using the cPanel account\u2019s username. For example: <code>username_wp_vfcf4<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-table-prefix<\/code><\/td>\n<td>The database table\u2019s prefix.  If you do <strong>not<\/strong> specify this value, the system generates a prefix.<\/td>\n<\/tr>\n<tr>\n<td><code>-site-title<\/code><\/td>\n<td>The WordPress site\u2019s title, surrounded by quotes.  If you do <strong>not<\/strong> specify this value, the system generates a random site title.<\/td>\n<\/tr>\n<tr>\n<td><code>-auto-updates<\/code><\/td>\n<td>Whether to enable automatic security updates for the new Wordpress site: <\/p>\n<ul>\n<li><code>true<\/code> \u2014\u00a0Enable all (major and minor) automatic security updates.<\/li>\n<li><code>false<\/code> \u2014\u00a0Do <strong>not<\/strong> enable automatic security updates.<\/li>\n<li><code>minor<\/code> \u2014\u00a0Only enable minor security updates.<\/li>\n<\/ul>\n<p> This option defaults to <code>true<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>-plugins-auto-updates<\/code><\/td>\n<td>Whether to enable automatic updates for Wordpress plugins: <\/p>\n<ul>\n<li><code>true<\/code> \u2014\u00a0Enable automatic updates.<\/li>\n<li><code>false<\/code> \u2014 Do <strong>not<\/strong> enable automatic updates.<\/li>\n<\/ul>\n<p> This option defaults to <code>false<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>-themes-auto-updates<\/code><\/td>\n<td>Whether to enable automatic updates for Wordpress themes: <\/p>\n<ul>\n<li><code>true<\/code>\u00a0\u2014\u00a0Enable automatic updates.<\/li>\n<li><code>false<\/code> \u2014 Do <strong>not<\/strong> enable automatic updates.<\/li>\n<\/ul>\n<p> This option defaults to <code>false<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>-show-progress<\/code><\/td>\n<td>Whether to display the operation\u2019s progress: <\/p>\n<ul>\n<li><code>yes<\/code> \u2014\u00a0Display the operation progress.<\/li>\n<li><code>no<\/code> \u2014 Perform the operation silently.<\/li>\n<\/ul>\n<p> By default, the function displays the operation progress unless you\u2019ve specified the <code>json<\/code> output format.<\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-8\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --install -domain-name example.com -username WPadmin -site-title <span style=\"color:#e6db74\">\"My WordPress Site\"<\/span><\/code><\/pre>\n<\/div>\n<h3 id=\"display-the-available-locales-for-a-version-of-wordpress\">Display the available locales for a version of WordPress<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --languages\n    -version VERSION\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-9\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>Option<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-version<\/code><\/td>\n<td><strong>Required<\/strong>  The WordPress version number.<\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-9\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --languages -version <span style=\"color:#ae81ff\">5<\/span>.7.1<\/code><\/pre>\n<\/div>\n<h3 id=\"display-information-for-all-wordpress-installations\">Display information for all WordPress installations<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --list\n    -domain-name DOMAIN_NAME\n    -plugins\n    -themes\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-10\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>Option<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td>The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-plugins<\/code><\/td>\n<td>Also display each WordPress installation\u2019s number of installed plugins.<\/td>\n<\/tr>\n<tr>\n<td><code>-themes<\/code><\/td>\n<td>Also display each WordPress installation\u2019s number of installed themes.<\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-10\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --list -plugins -themes<\/code><\/pre>\n<\/div>\n<h3 id=\"manage-your-available-wordpress-plugins\">Manage your available WordPress plugins<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --plugins\n    -operation list-custom|add|remove\n    -id ID\n    -version VERSION\n    -source-url URL\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-11\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-operation<\/code><\/td>\n<td><strong>Required<\/strong>  The action to perform: <\/p>\n<ul>\n<li><code>add<\/code> \u2014 Add a new WordPress plugin. This option requires the <code>-source-url<\/code> and <code>-path<\/code> options.<\/li>\n<li><code>remove<\/code> \u2014\u00a0Remove an installed WordPress plugin. This option requires the <code>-id<\/code> and <code>-version<\/code> options.<\/li>\n<li><code>list-custom<\/code> \u2014\u00a0List all custom WordPress plugins.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-id<\/code><\/td>\n<td>The WordPress plugin\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-version<\/code><\/td>\n<td>The WordPress version number.<\/td>\n<\/tr>\n<tr>\n<td><code>-source-url<\/code><\/td>\n<td>The plugin\u2019s URL.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td>The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-11\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --plugins -operation list-custom<\/code><\/pre>\n<\/div>\n<h3 id=\"add-a-wordpress-installation-to-the-wordpress-toolkit\">Add a WordPress installation to the WordPress Toolkit<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --register\n    -domain-name DOMAIN_NAME -path PATH\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-12\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td><strong>Required<\/strong>  The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td><strong>Required<\/strong>  The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-12\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --register -main-domain-id <span style=\"color:#ae81ff\">1<\/span> -path subdirectory<\/code><\/pre>\n<\/div>\n<h3 id=\"manage-wordpress-plugin-and-theme-sets\">Manage WordPress plugin and theme sets<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --sets\n    -operation list|info|add|remove|rename|add-plugin|add-theme|remove-plugin|remove-theme|install|activate-plugin|deactivate-plugin|activate-theme|deactivate-theme\n    -instance-id INSTANCE_ID\n    -plugin-id PLUGIN_ID\n    -plugin-slug PLUGIN_SLUG\n    -set-id SET_ID\n    -name NAME\n    -theme-id THEME_ID\n    -theme-slug THEME_SLUG\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-13\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-operation<\/code><\/td>\n<td><strong>Required<\/strong>  The action to perform: <\/p>\n<ul>\n<li><code>list<\/code> \u2014\u00a0List all available WordPress sets.<\/li>\n<li><code>info<\/code>\u00a0\u2014\u00a0Display a WordPress set\u2019s information. This option requires the <code>set-id<\/code> option.<\/li>\n<li><code>add<\/code> \u2014\u00a0Add a WordPress set. This option requires the <code>-name<\/code> option.<\/li>\n<li><code>remove<\/code> \u2014\u00a0Remove a WordPress set. This option requires the <code>-set-id<\/code> option.<\/li>\n<li><code>rename<\/code>\u00a0\u2014\u00a0Rename a WordPress set. This option requires the <code>-name<\/code> option.<\/li>\n<li><code>add-plugin<\/code> \u2014\u00a0Add a WordPress plugin to a set. This option requires the <code>-add-plugin<\/code> and <code>-remove-plugin<\/code> options.<\/li>\n<li><code>add-theme<\/code> \u2014\u00a0Add a WordPress theme to a set. This option requires the <code>-set-id<\/code> option.<\/li>\n<li><code>remove-plugin<\/code> \u2014\u00a0Remove a WordPress plugin from a set. This option requires the <code>-set-id<\/code> option.<\/li>\n<li><code>remove-theme<\/code> \u2014\u00a0Remove a WordPress theme from a WordPress installation. This option requires the <code>set-id<\/code> and <code>instance-id<\/code> options.<\/li>\n<li><code>install<\/code>\u00a0\u2014\u00a0Install a set on a WordPress installation. This option requires the <code>set-id<\/code> and <code>instance-id<\/code> options.<\/li>\n<li><code>activate-plugin<\/code> \u2014\u00a0Activate a WordPress set plugin. This option requires the <code>set-id<\/code> option and the <code>plugin-id<\/code> or <code>plugin-slug<\/code> options.<\/li>\n<li><code>deactivate-plugin<\/code> \u2014\u00a0Deactivate a WordPress set plugin. This option requires the <code>set-id<\/code> option and the <code>plugin-id<\/code> or <code>plugin-slug<\/code> options.<\/li>\n<li><code>activate-theme<\/code> \u2014\u00a0Activate a WordPress set theme. This option requires the <code>set-id<\/code> option and <code>theme-id<\/code> or <code>theme-slug<\/code> options.<\/li>\n<li><code>deactivate-theme<\/code> \u2014 Deactivate a WordPress set theme. This option requires the <code>set-id<\/code> option and the <code>theme-id<\/code> or <code>theme-slug<\/code> options.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td>The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-plugin-id<\/code><\/td>\n<td>The WordPress plugin\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-plugin-slug<\/code><\/td>\n<td>The WordPress plugin\u2019s slug name.<\/td>\n<\/tr>\n<tr>\n<td><code>-set-id<\/code><\/td>\n<td>The WordPress set\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-name<\/code><\/td>\n<td>The WordPress set\u2019s name.<\/td>\n<\/tr>\n<tr>\n<td><code>-theme-id<\/code><\/td>\n<td>The WordPress theme\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-theme-slug<\/code><\/td>\n<td>The WordPress theme\u2019s slug name.<\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-13\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --sets -operation list<\/code><\/pre>\n<\/div>\n<h3 id=\"manage-wordpress-toolkit-smart-updates-for-a-wordpress-site\">Manage WordPress Toolkit Smart Updates for a WordPress site<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --smart-update\n    -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH\n    -operation status|enable|disable\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-14\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td>The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td>The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td>The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-operation<\/code><\/td>\n<td><strong>Required<\/strong>  The action to perform: <\/p>\n<ul>\n<li><code>enable<\/code>\u00a0\u2014\u00a0Enable Smart Updates.<\/li>\n<li><code>disable<\/code>\u00a0\u2014\u00a0Disable Smart Updates.<\/li>\n<li><code>status<\/code> \u2014 Display a WordPress installation\u2019s Smart Update status. This option requires the <code>-instance-id<\/code> option.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-14\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --smart-update -instance-id <span style=\"color:#ae81ff\">1<\/span><\/code><\/pre>\n<\/div>\n<h3 id=\"manage-your-available-wordpress-themes\">Manage your available WordPress themes<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --themes\n    -operation list-custom|add|remove\n    -id ID\n    -version VERSION\n    -source-url URL\n    -path PATH\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-15\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-operation<\/code><\/td>\n<td><strong>Required<\/strong>  The action to perform: <\/p>\n<ul>\n<li><code>add<\/code>\u00a0\u2014\u00a0Add a WordPress theme. This option requires the <code>-source-url<\/code> and <code>-path<\/code> options.<\/li>\n<li><code>remove<\/code> \u2014\u00a0Remove a WordPress theme. This option requires the <code>-id<\/code> and <code>-version<\/code> options.<\/li>\n<li><code>list-custom<\/code> \u2014 List all installed WordPress themes.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td><code>-id<\/code><\/td>\n<td>The theme\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-version<\/code><\/td>\n<td>The WordPress version number.<\/td>\n<\/tr>\n<tr>\n<td><code>-source-url<\/code><\/td>\n<td>The theme\u2019s source URL.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td>The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-15\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --themes -operation remove -id <span style=\"color:#ae81ff\">1<\/span> -version <span style=\"color:#ae81ff\">2<\/span>.0<\/code><\/pre>\n<\/div>\n<h3 id=\"update-a-wordpress-site-url\">Update a WordPress site URL<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --update-site-url\n    -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-16\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td><strong>Required<\/strong>  The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td><strong>Required<\/strong>  The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-16\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --update-site-url -instance-id <span style=\"color:#ae81ff\">1<\/span><\/code><\/pre>\n<\/div>\n<h3 id=\"list-all-available-wordpress-versions-for-wordpress-toolkit\">List all available WordPress versions for WordPress Toolkit<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --versions\n    -format raw|json<\/code><\/pre>\n<\/div>\n<h4 id=\"options-17\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>Option<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-format<\/code><\/td>\n<td>Output the data in a specific format: <\/p>\n<ul>\n<li><code>json<\/code> \u2014\u00a0JSON format.<\/li>\n<li><code>raw<\/code> \u2014 Raw output format.<\/li>\n<\/ul>\n<p> This option defaults to <code>raw<\/code> data output.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-17\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --versions -format json<\/code><\/pre>\n<\/div>\n<h3 id=\"execute-a-wp-cli-command-to-the-given-wordpress-installation\">Execute a wp-cli command to the given WordPress installation<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --wp-cli\n    -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH\n    -- WP-CLI_COMMAND SUBCOMMAND<\/code><\/pre>\n<\/div>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<p>For a list of available commands and their subcommands, read WordPress\u2019 <code>wp-cli<\/code> documentation.<\/p>\n<\/p><\/div>\n<\/div>\n<h4 id=\"options-18\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td><strong>Required<\/strong>  The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td><strong>Required<\/strong>  The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-18\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --wp-cli -instance-id <span style=\"color:#ae81ff\">1<\/span> -- plugin activate akismet<\/code><\/pre>\n<\/div>\n<h3 id=\"update-the-wp-config-php-file-settings\">Update the wp-config.php file settings<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --wp-config\n    -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH\n    --\n    -db-charset DB_CHARSET\n    -db-name DB_NAME\n    -db-user DB_USER\n    -db-password DB_PASSWORD\n    -db-host DB_HOST\n    -domain-current-site DOMAIN_CURRENT_SITE\n    -path-current-site PATH_CURRENT_SITE\n    -multisite MULTISITE\n    -subdomain-install SUBDOMAIN_INSTALL\n    -wp-auto-update-core WP_AUTO_UPDATE_CORE\n    -wpcachehome WPCACHEHOME\n    -wp-debug WP_DEBUG\n    -wp-debug-log WP_DEBUG_LOG\n    -wp-debug-display WP_DEBUG_DISPLAY\n    -script-debug SCRIPT_DEBUG\n    -savequeries SAVEQUERIES\n    -wp-home WP_HOME\n    -wp-siteurl WP_SITEURL\n    -concatenate-scripts CONCATENATE_SCRIPTS\n    -disallow-file-edit DISALLOW_FILE_EDIT\n    -wp-cache-key-salt WP_CACHE_KEY_SALT\n    -disable-wp-cron DISABLE_WP_CRON<\/code><\/pre>\n<\/div>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<ul>\n<li>You can pass all <code>wp-config.php<\/code> file settings through environment variables. To do this, you must specify an empty parameter value.<\/li>\n<li>For information about the <code>wp-config.php<\/code> file and its settings, read WordPress\u2019 Editing <code>wp-config.php<\/code> documentation.<\/li>\n<\/ul><\/div>\n<\/div>\n<h4 id=\"options-19\">Options<\/h4>\n<p>This command accepts the following options:<\/p>\n<table>\n<thead>\n<tr>\n<th>\n<div style=\"width:110px\">Option<\/div>\n<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>-instance-id<\/code><\/td>\n<td><strong>Required<\/strong>  The WordPress installation\u2019s ID.<\/td>\n<\/tr>\n<tr>\n<td><code>-domain-name<\/code><\/td>\n<td><strong>Required<\/strong>  The domain name.<\/td>\n<\/tr>\n<tr>\n<td><code>-path<\/code><\/td>\n<td><strong>Required<\/strong>  The relative filepath from the domain\u2019s document root directory. For example: <code>\/subdirectory<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h4 id=\"example-19\">Example<\/h4>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --wp-config instance-id <span style=\"color:#ae81ff\">1<\/span> -- -db-charset utf8<\/code><\/pre>\n<\/div>\n<h3 id=\"install-a-wordpress-toolkit-license\">Install a WordPress Toolkit license<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --apply-license<\/code><\/pre>\n<\/div>\n<h3 id=\"update-the-operation-system-type-and-version\">Update the operation system type and version<\/h3>\n<div class=\"highlight\">\n<pre style=\"color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4\"><code class=\"language-BASH\" data-lang=\"BASH\">wp-toolkit --update-server-info <\/code><\/pre>\n<\/div>\n<div class=\"callout callout-info\">\n<div class=\"callout-heading\">Note:<\/div>\n<div class=\"callout-content\">\n<p>This command may be required after converting your system from CentOS to CloudLinux\u2122.<\/p>\n<\/p><\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Valid for versions 92 through the latest version Version: 92 Overview This document lists all of the commands available via the WordPress\u00ae Toolkit command line interface. Create a WordPress site backup wp-toolkit &#8211;backup -instance-id INSTANCE_ID|-domain-name DOMAIN_NAME -path PATH -operation list|backup|restore -filename FILENAME -format raw|json Options This command accepts the following options: Option Description -instance-id The &hellip;<\/p>\n","protected":false},"author":1,"featured_media":256,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/255"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=255"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/255\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/256"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=255"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=255"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=255"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}