What is wp-cli?
A set of tools for controlling WordPress installations from the command line.
- PHP >= 5.3
- WP >= 3.3
pear config-set auto_discover 1 sudo pear install wp-cli.github.com/pear/wpcli
git clone --recursive git://github.com/wp-cli/wp-cli.git ~/git/wp-cli cd ~/git/wp-cli sudo utils/dev-build
You can replace
~/git/wp-cli with whatever you want.
Go into a WordPress root folder:
wp help should show you an output similar to this:
Example usage: wp google-sitemap [build|help] ... wp core [update|help] ... wp home [help] ... wp option [add|update|delete|get|help] ... wp plugin [status|activate|deactivate|install|delete|update|help] ... wp theme [status|details|activate|help] ...
So this tells us which commands are installed: eg. google-sitemap, core, home, ... Between brackets you can see their sub commands.
Let's for example try to install the hello dolly plugin from wordpress.org:
wp plugin install hello-dolly
Installing Hello Dolly (1.5) Downloading install package from http://downloads.WordPress.org/plugin/hello-dolly.1.5.zip ... Unpacking the package ... Installing the plugin ... Success: The plugin is successfully installed
On a multisite installation, you need to pass a --blog parameter, so that WP knows which site it's supposed to be operating on:
wp theme status --blog=localhost/wp/test
If you have a subdomain installation, it would look like this:
wp theme status --blog=test.example.com
If you're usually working on the same site most of the time, you can put the url of that site in a file called 'wp-cli-blog' in your root WP dir:
echo 'test.example.com' > wp-cli-blog
Then, you can call
wp without the --blog parameter again:
wp theme status
Adding commands to wp-cli is very easy. You can even add them from within your own plugin. You can find more information about adding commands in the Commands Cookbook on our Wiki.
Please share the commands you make, issue a pull request to get them included in wp-cli by default.
wp core download
wp core config
wp plugin update --all
wp theme update
wp db import
- various bugfixes
wp core install
wp core update
wp plugin install
wp plugin uninstall
wp plugin installand
wp plugin update
- pear installer
- added multisite support
wp core version
- added bash completion script
- initial release