README.md

   1 WP-CLI
   2 ======
   3
   4 [![Build Status](https://travis-ci.org/wp-cli/wp-cli.png?branch=master)](https://travis-ci.org/wp-cli/wp-cli)
   5
   6 WP-CLI is a set of command-line tools for managing WordPress installations.
   7
   8 Installation
   9 ------------
  10 If you just want to use WP-CLI, see <http://wp-cli.org/#install>.
  11
  12 If you want to hack on WP-CLI, then clone this repository and run `./utils/dev-build`.
  13
  14 Where can I get more info?
  15 --------------------------
  16 For documentation and examples, check out [wp-cli.org](http://wp-cli.org/) and the [wiki](https://github.com/wp-cli/wp-cli/wiki).
  17
  18 Also, WordPress Answers has a growing list of [WP-CLI related questions](http://wordpress.stackexchange.com/questions/tagged/wp-cli).
  19
  20 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.
  21
  22 I'm running into troubles, what can I do?
  23 -----------------------------------------
  24 To suggest a feature, report a bug, or general discussion, visit the [issues section](https://github.com/wp-cli/wp-cli/issues).
  25
  26 If you're reporting a bug, please also post the output from `wp --info`.
  27
  28 How can I help?
  29 ---------------
  30 See [CONTRIBUTING.md](CONTRIBUTING.md).
  31
  32 Credits
  33 -------
  34 Besides the libraries defined in [composer.json](composer.json), we have used code or ideas from the following projects:
  35
  36 * [Drush](http://drush.ws/) for... a lot of things
  37 * [wpshell](http://code.trac.wordpress.org/browser/wpshell) for `wp shell`
  38 * [Regenerate Thumbnails](http://wordpress.org/plugins/regenerate-thumbnails/) for `wp media regenerate`
  39 * [Search-Replace-DB](https://github.com/interconnectit/Search-Replace-DB) for `wp search-replace`
  40 * [WordPress-CLI-Exporter](https://github.com/Automattic/WordPress-CLI-Exporter) for `wp export`
  41 * [WordPress-CLI-Importer](https://github.com/Automattic/WordPress-CLI-Importer) for `wp import`
  42 * [wordpress-plugin-tests](https://github.com/benbalter/wordpress-plugin-tests/) for `wp scaffold plugin-tests`
  43
  44 Who's behind this thing?
  45 ------------------------
  46 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).
  47
  48 A complete list of contributors can be found [here](https://github.com/wp-cli/wp-cli/contributors).