-What is wp-cli?
---------------
+WP-CLI
+======
-A set of tools for controlling WordPress installations from the command line.
+[](https://travis-ci.org/wp-cli/wp-cli)
-Requirements
-------------
-
-PHP >= 5.3
-
-Installing
-----------
-
-**Via PEAR:**
-
-```sh
-pear config-set auto_discover 1
-sudo pear install wp-cli.github.com/pear/wpcli
-```
-
-**Via GIT:**
-
-```sh
-git clone --recurse-submodules git://github.com/wp-cli/wp-cli.git ~/git/wp-cli
-cd ~/git/wp-cli
-sudo utils/build-dev
-```
-
-You can replace `~/git/wp-cli` with whatever you want.
-
-
-Using
------
-
-Go into a WordPress root folder:
-
-```
-cd /var/www/wp/
-```
-
-Typing `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
-```
-
-Output:
-
-```
-Installing Hello Dolly (1.5)
+WP-CLI is a set of command-line tools for managing WordPress installations.
-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
-```
-
-Multisite
----------
-
-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:
+Installation
+------------
+If you just want to use WP-CLI, see <http://wp-cli.org/#install>.
-```
-echo 'test.example.com' > wp-cli-blog
-```
+If you want to hack on WP-CLI, then clone this repository and run `./utils/dev-build`.
-Then, you can call `wp` without the --blog parameter again:
+Where can I get more info?
+--------------------------
+For documentation and examples, check out [wp-cli.org](http://wp-cli.org/) and the [wiki](https://github.com/wp-cli/wp-cli/wiki).
-```
-wp theme status
-```
+Also, WordPress Answers has a growing list of [WP-CLI related questions](http://wordpress.stackexchange.com/questions/tagged/wp-cli).
-Adding commands
----------------
+If you want to receive an email for every single commit, you can subscribe to the [wp-cli-commits](https://groups.google.com/forum/?fromgroups=#!forum/wp-cli-commits) mailing list.
-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](https://github.com/wp-cli/wp-cli/wiki/Commands-Cookbook) on our Wiki.
+I'm running into troubles, what can I do?
+-----------------------------------------
+To suggest a feature, report a bug, or general discussion, visit the [issues section](https://github.com/wp-cli/wp-cli/issues).
-**Please share the commands you make, issue a pull request to get them included in wp-cli by default.**
+If you're reporting a bug, please also post the output from `wp --info`.
-Changelog
+How can I help?
---------------
+See [CONTRIBUTING.md](CONTRIBUTING.md).
-**0.5**
+Credits
+-------
+Besides the libraries defined in [composer.json](composer.json), we have used code or ideas from the following projects:
-- added `wp user`
-- added `wp core download`
-- added `wp core config`
-- added `wp plugin update --all`
-- added `wp theme update`
-- added `wp db import`
-- added `--url` `--path` and `--user` global parameters
-- various bugfixes
+* [Drush](http://drush.ws/) for... a lot of things
+* [wpshell](http://code.trac.wordpress.org/browser/wpshell) for `wp shell`
+* [Regenerate Thumbnails](http://wordpress.org/plugins/regenerate-thumbnails/) for `wp media regenerate`
+* [Search-Replace-DB](https://github.com/interconnectit/Search-Replace-DB) for `wp search-replace`
+* [WordPress-CLI-Exporter](https://github.com/Automattic/WordPress-CLI-Exporter) for `wp export`
+* [WordPress-CLI-Importer](https://github.com/Automattic/WordPress-CLI-Importer) for `wp import`
+* [wordpress-plugin-tests](https://github.com/benbalter/wordpress-plugin-tests/) for `wp scaffold plugin-tests`
-**0.4**
-
-- added `wp eval` and `wp eval-file`
-- added `wp export`
-- added `wp core install`
-- fixed `wp core update`
-- added `--dev` flag to `wp plugin install`
-- added `wp plugin uninstall`
-- fixed `wp plugin install` and `wp plugin update`
-
-**0.3**
-
-- added `wp sql`
-- improved `wp option`
-- pear installer
-
-**0.2**
-
-- added multisite support
-- improved `wp plugin` and `wp theme`
-- added `wp generate`
-- added `wp core version`
-- added `wp --version`
-- added bash completion script
-
-**0.1**
-
-- initial release
-
-Contributors
-------------
+Who's behind this thing?
+------------------------
+We are [Andreas Creten](https://github.com/andreascreten) and [Cristi Burcă](https://github.com/scribu), friendly guys from Europe. For more info, see [Governance](https://github.com/wp-cli/wp-cli/wiki/Governance).
-- [Contributor list](https://github.com/wp-cli/wp-cli/contributors)
-- [Contributor guide](https://github.com/wp-cli/wp-cli/wiki/Commands-Cookbook)
+A complete list of contributors can be found [here](https://github.com/wp-cli/wp-cli/contributors).
OSDN Git Service
