WP-CLI is a set of command-line tools for managing WordPress installations. You can update plugins, configure multisite installs and much more, without using a web browser.
To stay up to date, follow @wpcli on Twitter or sign up for our email newsletter.
A more RESTful WP-CLI aims to unlocking the potential of the WP REST API at the command line. Project backed by Pressed, Chris Lema, Human Made, Pagely, Pantheon and many others. Learn more →
Quick links: Using | Installing | Support | Extending | Contributing | Credits
WP-CLI's goal is to provide a command-line interface for any action you might want to perform in the WordPress admin. For instance, wp plugin install --activate (doc) lets you install and activate a WordPress plugin:
$ wp plugin install rest-api --activate
Installing WordPress REST API (Version 2) (2.0-beta13)
Downloading install package from https://downloads.wordpress.org/plugin/rest-api.2.0-beta13.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating 'rest-api'...
Success: Plugin 'rest-api' activated.WP-CLI also includes commands for many things you can't do in the WordPress admin. For example, wp transient delete-all (doc) lets you delete one or all transients:
$ wp transient delete-all
Success: 34 transients deleted from the database.For a more complete introduction to using WP-CLI, read the Quick Start guide.
Already feel comfortable with the basics? Jump into the complete list of commands for detailed information on managing themes and plugins, importing and exporting data, performing database search-replace operations and more.
Downloading the Phar file is our recommended installation method. Should you need, see also our documentation on alternative installation methods.
Before installing WP-CLI, please make sure your environment meets the minimum requirements:
- UNIX-like environment (OS X, Linux, FreeBSD, Cygwin); limited support in Windows environment
- PHP 5.3.29 or later
- WordPress 3.7 or later
Once you've verified requirements, download the wp-cli.phar file using wget or curl:
$ curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.pharNext, check if it is working:
$ php wp-cli.phar --infoTo use WP-CLI from the command line by typing wp, make the file executable and move it to somewhere in your PATH. For example:
$ chmod +x wp-cli.phar
$ sudo mv wp-cli.phar /usr/local/bin/wpIf WP-CLI was installed successfully, you should see something like this when you run wp --info:
$ wp --info
PHP binary: /usr/bin/php5
PHP version: 5.5.9-1ubuntu4.14
php.ini used: /etc/php5/cli/php.ini
WP-CLI root dir: /home/wp-cli/.wp-cli
WP-CLI packages dir: /home/wp-cli/.wp-cli/packages/
WP-CLI global config: /home/wp-cli/.wp-cli/config.yml
WP-CLI project config:
WP-CLI version: 0.23.0You can update WP-CLI with wp cli update (doc), or by repeating the installation steps.
Want to live life on the edge? Run wp cli update --nightly to use the latest nightly build of WP-CLI. The nightly build is more or less stable enough for you to use in your development environment, and always includes the latest and greatest WP-CLI features.
WP-CLI also comes with a tab completion script for Bash and ZSH. Just download wp-completion.bash and source it from ~/.bash_profile:
source /FULL/PATH/TO/wp-completion.bashDon't forget to run source ~/.bash_profile afterwards.
If using zsh for your shell, you may need to load and start bashcompinit before sourcing. Put the following in your .zshrc:
autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bashWP-CLI's maintainers and project contributors are volunteers, and have limited availability to address general support questions. First, look for an answer in one of the following resources:
- Common issues and their fixes
- Documentation portal
- Open or closed issues on Github
- runcommand Excerpts
- WordPress StackExchange forums
If you can't find your answer at one of those links, the WordPress StackExchange can be used for development-related WP-CLI questions. Or, join the #cli channel on the WordPress.org Slack organization to see if a community member might have an answer for you. Professional users may also consider runcommand for premium support.
For bug reports, please review best practices for submitting a bug report before creating a new issue.
Please do not ask support questions on Twitter. Twitter isn't an acceptable venue for support because: 1) it's hard to hold conversations in under 140 characters, and 2) Twitter isn't a place where someone with your same question can search for an answer in a prior conversation.
Remember, libre != gratis; the open source license grants you the freedom to use and modify, but not commitments of other people's time. Please be respectful, and set your expectations accordingly.
A command is an atomic unit of WP-CLI functionality. wp plugin install (doc) is one command. wp plugin activate (doc) is another.
WP-CLI supports registering any callable class, function, or closure as a command. It reads usage details from the callback's PHPdoc. WP_CLI::add_command() (doc) is used for both internal and third-party command registration.
/**
* Delete an option from the database.
*
* Returns an error if the option didn't exist.
*
* ## OPTIONS
*
* <key>
* : Key for the option.
*
* ## EXAMPLES
*
* $ wp option delete my_option
* Success: Deleted 'my_option' option.
*/
$delete_option_cmd = function( $args ) {
list( $key ) = $args;
if ( ! delete_option( $key ) ) {
WP_CLI::error( "Could not delete '$key' option. Does it exist?" );
} else {
WP_CLI::success( "Deleted '$key' option." );
}
};
WP_CLI::add_command( 'option delete', $delete_option_cmd );WP-CLI comes with dozens of commands. It's easier than it looks to create a custom WP-CLI command. Read the commands cookbook to learn more. Browse the internal API docs to discover a variety of helpful functions you can use in your custom WP-CLI command.
Welcome and thanks!
We appreciate you taking the initiative to contribute to WP-CLI. It’s because of you, and the community around you, that WP-CLI is such a great project.
Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
Please take a moment to read these guidelines at depth. Following them helps to communicate that you respect the time of the other contributors to the project. In turn, they’ll do their best to reciprocate that respect when working with you, across timezones and around the world.
WP-CLI is led by these individuals:
- Daniel Bachhuber - current maintainer
- Cristi Burcă - previous maintainer
- Andreas Creten - founder
Read more about the project's governance and view a complete list of contributors.
Besides the libraries defined in composer.json, we have used code or ideas from the following projects:
- Drush for... a lot of things
- wpshell for
wp shell - Regenerate Thumbnails for
wp media regenerate - Search-Replace-DB for
wp search-replace - WordPress-CLI-Exporter for
wp export - WordPress-CLI-Importer for
wp import - wordpress-plugin-tests for
wp scaffold plugin-tests