{"id":7008,"date":"2019-08-01T08:03:05","date_gmt":"2019-08-01T12:03:05","guid":{"rendered":"https:\/\/www.pair.com\/support\/kb\/?post_type=ht_kb&p=7008"},"modified":"2021-09-14T12:59:07","modified_gmt":"2021-09-14T16:59:07","slug":"wp-cli","status":"publish","type":"ht_kb","link":"https:\/\/www.pair.com\/support\/kb\/wp-cli\/","title":{"rendered":"WP-CLI"},"content":{"rendered":"

Shared<\/p><\/a>

VPS<\/p><\/a>

Dedicated<\/p><\/a>\u00a0

WP Professional<\/p><\/a>

WP Professional Plus<\/p><\/a>

Podcast Websites<\/p><\/a><\/span><\/p>\n

WP-CLI is a command-line tool that you can use to control your WordPress installation. You can use WP-CLI with any WordPress installation on our accounts. It can be used on fully managed WordPress hosting accounts<\/a> and\u00a0 PairSIM WordPress installations<\/a>.<\/p>\n

Getting Ready to Use WP-CLI<\/h3>\n

Before you can use the WP-CLI commands, you must first complete a few steps:<\/p>\n

    \n
  1. Connect to your account via SSH. For more information about how to establish this connection, see our Connect to Your Account via SSH article<\/a>.<\/li>\n
  2. Navigate to your WordPress installation files.The default SSH location is your home directory (\/usr\/home\/username<\/i>).\u00a0 You will first need to use the following command to reach your website files:\n
    cd public_html<\/pre>\n<\/li>\n
  3. Once you have reached your public_html<\/i> you will want to use the cd<\/span> command<\/a> to navigate to your WordPress installation files.\u00a0 If you are unsure where this is, you can check the domain mapping within the ACC.<\/li>\n<\/ol>\n
    After you have arrived within your WordPress installation's directory, you can use WP-CLI commands.<\/p>\n
    Our version of WP-CLI requires the prefix of \"<\/i>wp-cli\" instead of just \"<\/i>wp,\" so if you attempt to run WP-CLI commands that you found outside of this article, be sure to begin the command with \"<\/i>wp-cli\" instead of \"<\/i>wp.\"<\/i><\/p>\n
    WP-CLI Commands<\/h3>\n
    WP-CLI can be used in various aspects of your WordPress backend, from themes and plugins to cache flushing. We've broken the commands below into categories based on their purpose.<\/p>\n
    Keep in mind that this is not an exhaustive list of all WP-CLI can accomplish, but rather a helpful guide to get you started. If you want a complete list on WP-CLI commands, see the WP-CLI command documentation page<\/a>.<\/p>\n
    Themes<\/h4>\n\n\n\n\n\n\n\n\n
    Command<\/b><\/td>\nUse<\/b><\/td>\nExample<\/b><\/td>\n<\/tr>\n
    wp-cli theme list<\/td>\nLists the current themes that exist on the WordPress installation.<\/p>\n
    For the other commands, be sure to use the names as they appear in this list.<\/td>\n
    		wp-cli theme list<\/td>\n<\/tr>\n
    wp-cli theme install [theme name] --activate<\/td>\nInstalls and activates a theme<\/td>\nwp-cli theme install twentysixteen --activate<\/td>\n<\/tr>\n
    wp-cli theme delete [theme name]<\/td>\nDeletes a theme<\/td>\nwp-cli theme delete twentytwelve<\/td>\n<\/tr>\n
    wp-cli theme update [theme name]<\/td>\nUpdates the theme. This command can update multiple themes at a time. To update multiple themes, list the other theme names after the initial theme name.<\/td>\nwp-cli theme update twentyfifteen twentysixteen<\/td>\n<\/tr>\n
    wp-cli theme status [theme name]<\/td>\nGets information about a theme on the WordPress installation<\/td>\nwp-cli theme status twentysixteen<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Plugins<\/h4>\n\n\n\n\n\n\n\n\n
    Command<\/b><\/td>\nUse<\/b><\/td>\nExample<\/b><\/td>\n<\/tr>\n
    wp-cli plugin list<\/td>\nGets a list of all plugins.<\/p>\n
    This is necessary because plugin names are not always formatted in the same way that they appear in the plugin directory.<\/p>\n
    Use the names from the list to run the following commands.<\/td>\n
    		wp-cli plugin list<\/td>\n<\/tr>\n
    wp-cli plugin install [plugin]\u00a0 --activate<\/td>\nInstall and activate a plugin<\/td>\nwp-cli install woocommerce --activate<\/td>\n<\/tr>\n
    wp-cli plugin deactivate [plugin]<\/td>\nDeactivate a plugin<\/td>\nwp-cli plugin deactivate woocommerce<\/td>\n<\/tr>\n
    wp-cli plugin delete [plugin]<\/td>\nDelete a plugin from your WordPress installation<\/td>\nwp-cli plugin delete woocommerce<\/td>\n<\/tr>\n
    wp-cli plugin get [plugin]<\/td>\nGets plugin information<\/td>\nwp-cli plugin get woocomerce<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Core<\/h4>\n\n\n\n\n\n\n\n\n
    Command<\/b><\/td>\nUse<\/b><\/td>\nExample<\/b><\/td>\n<\/tr>\n
    wp-cli core version<\/td>\nShows the current WordPress core version<\/td>\nwp-cli core version<\/td>\n<\/tr>\n
    wp-cli core check-update<\/td>\nChecks for any pending WordPress core updates<\/td>\nwp-cli core check-update<\/td>\n<\/tr>\n
    wp-cli core update<\/td>\nIf there are any pending WordPress core updates, this command will initiate the update process<\/td>\nwp-cli core update<\/td>\n<\/tr>\n
    wp-cli core update --version=[version number] --force<\/td>\nForces the WordPress core to update to a specific core version<\/p>\n
    Note: Be careful using this command. Rolling back a core version can break your site and cause compatibility errors with your plugins and themes.<\/i><\/b><\/td>\n
    		wp-cli core update --version=4.9 --force<\/td>\n<\/tr>\n
    wp-cli core update-db<\/td>\nUpdates WordPress databases with any pending core updates<\/td>\nwp-cli core update-db<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Database<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n
    Command<\/b><\/td>\nUse<\/b><\/td>\nExample<\/b><\/td>\n<\/tr>\n
    wp-cli db check<\/td>\nChecks the current status of the WordPress database<\/td>\nwp-cli db check<\/td>\n<\/tr>\n
    wp-cli db tables<\/td>\nDisplays a list of all current tables in the WordPress database<\/td>\nwp-cli db tables<\/td>\n<\/tr>\n
    wp-cli db create<\/td>\nCreates a new WordPress database<\/td>\nwp-cli db create<\/td>\n<\/tr>\n
    wp-cli db drop<\/td>\nDeletes the current database<\/td>\nwp-cli db drop<\/td>\n<\/tr>\n
    wp-cli db optimize<\/td>\nOptimizes the current WordPress database<\/td>\nwp-cli db optimize<\/td>\n<\/tr>\n
    wp-cli db query [query]<\/td>\nExecutes a query within your WordPress database<\/td>\nwp-cli db query 'UPDATE wp_posts SET post_author=\"new-author-id\" WHERE post_author = \"old-author-id\";'<\/td>\n<\/tr>\n
    wp-cli db search [search string]<\/td>\nSearches the current WordPress data for the string<\/p>\n
    Note: If no instances are found, no information will be returned.\u00a0<\/i><\/td>\n
    		wp-cli db search dog.jpg<\/td>\n<\/tr>\n
    wp-cli db size --size_format=[format]<\/td>\nDisplays the size of the current WordPress database.<\/p>\n
    You can change the measurement size by entering a size format in the place of [format].<\/p>\n
    See the WordPress WP-CLI DB Size developer page for all the available size formats.\u00a0<\/a><\/td>\n
    		wp-cli db size --size_format=mb<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Maintenance Mode<\/h4>\n\n\n\n\n\n\n
    Command<\/b><\/td>\nUse<\/b><\/td>\nExample<\/b><\/td>\n<\/tr>\n
    wp-cli maintenance-mode status<\/td>\nDisplays whether or not maintenance mode is currently active on the WordPress site<\/td>\nwp-cli maintenance-mode status<\/td>\n<\/tr>\n
    wp-cli maintenance-mode activate<\/td>\nActivates maintenance mode on your current WordPress installation<\/p>\n
    Note: Visitors will be unable to access your site while maintenance mode is running.<\/td>\n
    		wp-cli maintenance-mode activate<\/td>\n<\/tr>\n
    wp-cli maintenance mode deactivate<\/td>\nDeactivates maintenance mode on your current WordPress installation<\/td>\nwp-cli maintenance mode deactivate<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Menu<\/h4>\n\n\n\n\n\n\n\n\n\n
    Command<\/b><\/td>\nUse<\/b><\/td>\nExample<\/b><\/td>\n<\/tr>\n
    wp-cli menu list<\/td>\nDisplays a list of current menus on the WordPress installation<\/td>\nwp-cli menu list<\/td>\n<\/tr>\n
    wp-cli menu create \"[menu name]\"<\/td>\nCreates a new menu<\/td>\nwp-cli menu create \"New-Header-Menu\"<\/td>\n<\/tr>\n
    wp-cli menu delete \"[menu name]\"<\/td>\nDeletes an existing menu<\/td>\nwp-cli menu delete \"New-Header-Menu\"<\/td>\n<\/tr>\n
    wp-cli menu location list<\/td>\nDisplays a list of locations available for menus<\/td>\nwp-cli menu location list<\/td>\n<\/tr>\n
    wp-cli menu location assign [menu name] [location]<\/td>\nAssigns the specified menu to the chosen location<\/td>\nwp-cli menu location assign New-Header-Menu top<\/td>\n<\/tr>\n
    wp-cli menu location remove [menu name] [location]<\/td>\nRemoves the specified menu from the chosen location.<\/td>\nwp-cli menu location remove New-Header-Menu top<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Posts<\/h4>\n\n\n\n\n\n\n\n
    Command<\/b><\/td>\nUse<\/b><\/td>\nExample<\/b><\/td>\n<\/tr>\n
    wp-cli post list<\/td>\nLists all posts on current WordPress installation, including their publish status.<\/td>\nwp-cli post list<\/td>\n<\/tr>\n
    wp-cli post create --post_type=[page or post] --post_title='[title]' --post_status=future --post_date='YYYY-MM-DD hour:min:sec'<\/td>\nCreates a post or page and schedules it to launch at a future date.<\/p>\n
    Note: Be sure to use 24 hour time when entering the time for post date.<\/td>\n
    		wp-cli post create --post_type= post<\/p>\n
    --post_title='My Post' --post_status=future --post_date='2025-08-05 17:10:00'<\/td>\n<\/tr>\n
    wp-cli post create --post_type=[post or page] --post_title='[title]'<\/td>\nCreate and publish a post or page.<\/td>\nwp-cli post create --post_type=page --post_title='My New Page'<\/td>\n<\/tr>\n
    wp-cli post delete [post name] --force<\/td>\nDeletes a post, skipping the trash.<\/td>\nwp-cli post delete My Post --force<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Users and Roles<\/h4>\n\n\n\n\n\n\n\n\n
    Command<\/b><\/td>\nUse<\/b><\/td>\nExample<\/b><\/td>\n<\/tr>\n
    wp-cli user create [user] [user email]\u00a0 --role=[role]<\/td>\nCreates a new user on the current WordPress installation.<\/td>\nwp-cli user create jack jack@email.com --role=author<\/td>\n<\/tr>\n
    wp-cli user delete [user] --reassign=[different user]<\/td>\nDeletes an existing user and reassigns their pages and posts to another user.<\/td>\nwp-cli user delete jack --reassign=paige<\/td>\n<\/tr>\n
    wp-cli user list<\/td>\nDisplays a list of all current users on the WordPress installation.<\/td>\nwp-cli user list<\/td>\n<\/tr>\n
    wp-cli user reset-password [user]<\/td>\nResets passwords for existing users. The next time users log in, they will be prompted to enter a new password.<\/p>\n
    You can reset the password for multiple users by adding user's at the end of the command<\/td>\n
    		wp-cli user reset-password admin editor<\/td>\n<\/tr>\n
    wp-cli role list<\/td>\nLists all available roles on the WordPress installation.<\/td>\nwp-cli role list<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
     <\/p>\n","protected":false},"excerpt":{"rendered":"
    \u00a0 WP-CLI is a command-line tool that you can use to control your WordPress installation. You can use WP-CLI with any WordPress installation on our accounts. It can be used on fully managed WordPress hosting accounts and\u00a0 PairSIM WordPress installations. Getting Ready to Use WP-CLI Before you can use the…<\/p>\n","protected":false},"author":11,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":[],"ht-kb-category":[182],"ht-kb-tag":[205,215,179,180,199],"yoast_head":"\nWP-CLI - Knowledge Base - Pair Networks<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.pair.com\/support\/kb\/wp-cli\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"WP-CLI - Knowledge Base - Pair Networks\" \/>\n<meta property=\"og:description\" content=\"\u00a0 WP-CLI is a command-line tool that you can use to control your WordPress installation. You can use WP-CLI with any WordPress installation on our accounts. It can be used on fully managed WordPress hosting accounts and\u00a0 PairSIM WordPress installations. Getting Ready to Use WP-CLI Before you can use the...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.pair.com\/support\/kb\/wp-cli\/\" \/>\n<meta property=\"og:site_name\" content=\"Knowledge Base - Pair Networks\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/pairnetworks\/\" \/>\n<meta property=\"article:modified_time\" content=\"2021-09-14T16:59:07+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@pairNetworks\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"6 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.pair.com\/support\/kb\/wp-cli\/\",\"url\":\"https:\/\/www.pair.com\/support\/kb\/wp-cli\/\",\"name\":\"WP-CLI - Knowledge Base - Pair Networks\",\"isPartOf\":{\"@id\":\"https:\/\/www.pair.com\/support\/kb\/#website\"},\"datePublished\":\"2019-08-01T12:03:05+00:00\",\"dateModified\":\"2021-09-14T16:59:07+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.pair.com\/support\/kb\/wp-cli\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.pair.com\/support\/kb\/wp-cli\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.pair.com\/support\/kb\/wp-cli\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.pair.com\/support\/kb\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"WP-CLI\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.pair.com\/support\/kb\/#website\",\"url\":\"https:\/\/www.pair.com\/support\/kb\/\",\"name\":\"Knowledge Base - Pair Networks\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.pair.com\/support\/kb\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.pair.com\/support\/kb\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.pair.com\/support\/kb\/#organization\",\"name\":\"Pair Networks\",\"url\":\"https:\/\/www.pair.com\/support\/kb\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.pair.com\/support\/kb\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.pair.com\/support\/kb\/wp-content\/uploads\/2022\/02\/Gb_TUkUE_400x400.jpeg\",\"contentUrl\":\"https:\/\/www.pair.com\/support\/kb\/wp-content\/uploads\/2022\/02\/Gb_TUkUE_400x400.jpeg\",\"width\":360,\"height\":360,\"caption\":\"Pair Networks\"},\"image\":{\"@id\":\"https:\/\/www.pair.com\/support\/kb\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/pairnetworks\/\",\"https:\/\/twitter.com\/pairNetworks\",\"https:\/\/www.instagram.com\/pairnetworks\/\",\"https:\/\/www.linkedin.com\/company\/2269676\/\",\"https:\/\/www.pinterest.com\/pairnetworksinc\/pins\/\",\"https:\/\/www.youtube.com\/user\/pairnetworks\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"WP-CLI - Knowledge Base - Pair Networks","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.pair.com\/support\/kb\/wp-cli\/","og_locale":"en_US","og_type":"article","og_title":"WP-CLI - Knowledge Base - Pair Networks","og_description":"\u00a0 WP-CLI is a command-line tool that you can use to control your WordPress installation. You can use WP-CLI with any WordPress installation on our accounts. It can be used on fully managed WordPress hosting accounts and\u00a0 PairSIM WordPress installations. Getting Ready to Use WP-CLI Before you can use the...","og_url":"https:\/\/www.pair.com\/support\/kb\/wp-cli\/","og_site_name":"Knowledge Base - Pair Networks","article_publisher":"https:\/\/www.facebook.com\/pairnetworks\/","article_modified_time":"2021-09-14T16:59:07+00:00","twitter_card":"summary_large_image","twitter_site":"@pairNetworks","twitter_misc":{"Est. reading time":"6 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.pair.com\/support\/kb\/wp-cli\/","url":"https:\/\/www.pair.com\/support\/kb\/wp-cli\/","name":"WP-CLI - Knowledge Base - Pair Networks","isPartOf":{"@id":"https:\/\/www.pair.com\/support\/kb\/#website"},"datePublished":"2019-08-01T12:03:05+00:00","dateModified":"2021-09-14T16:59:07+00:00","breadcrumb":{"@id":"https:\/\/www.pair.com\/support\/kb\/wp-cli\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.pair.com\/support\/kb\/wp-cli\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.pair.com\/support\/kb\/wp-cli\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.pair.com\/support\/kb\/"},{"@type":"ListItem","position":2,"name":"WP-CLI"}]},{"@type":"WebSite","@id":"https:\/\/www.pair.com\/support\/kb\/#website","url":"https:\/\/www.pair.com\/support\/kb\/","name":"Knowledge Base - Pair Networks","description":"","publisher":{"@id":"https:\/\/www.pair.com\/support\/kb\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.pair.com\/support\/kb\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.pair.com\/support\/kb\/#organization","name":"Pair Networks","url":"https:\/\/www.pair.com\/support\/kb\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.pair.com\/support\/kb\/#\/schema\/logo\/image\/","url":"https:\/\/www.pair.com\/support\/kb\/wp-content\/uploads\/2022\/02\/Gb_TUkUE_400x400.jpeg","contentUrl":"https:\/\/www.pair.com\/support\/kb\/wp-content\/uploads\/2022\/02\/Gb_TUkUE_400x400.jpeg","width":360,"height":360,"caption":"Pair Networks"},"image":{"@id":"https:\/\/www.pair.com\/support\/kb\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/pairnetworks\/","https:\/\/twitter.com\/pairNetworks","https:\/\/www.instagram.com\/pairnetworks\/","https:\/\/www.linkedin.com\/company\/2269676\/","https:\/\/www.pinterest.com\/pairnetworksinc\/pins\/","https:\/\/www.youtube.com\/user\/pairnetworks"]}]}},"_links":{"self":[{"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/ht-kb\/7008"}],"collection":[{"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/users\/11"}],"replies":[{"embeddable":true,"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/comments?post=7008"}],"version-history":[{"count":7,"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/ht-kb\/7008\/revisions"}],"predecessor-version":[{"id":8076,"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/ht-kb\/7008\/revisions\/8076"}],"wp:attachment":[{"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/media?parent=7008"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=7008"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.pair.com\/support\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=7008"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}