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.

Installing

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.phar

Next, check if it is working:

$ php wp-cli.phar --info

To 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/wp

If 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: 1.1.0

Using

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. Or, catch up with shell friends to learn about helpful command line utilities.

Handbook

Here are some helpful guides and resources for using WP-CLI.

Can’t find what you’re looking for? Open an issue to request improvements.

Guides

References

  • Global parameters – Variables defining how a command is executed, including which WordPress user the command is run as and which WordPress instance the command is run against.
  • Built-in commands – Commands included in every copy of WP-CLI.
  • Package index – Commands maintained and supported by the community.
  • Internal API – Stable utilities considered safe to use in community commands.
  • Documentation standards – Standards for annotating WP-CLI commands.
  • Hosting companies – List of hosting companies where WP-CLI is installed by default.
  • Shell friends – Helpful shortcuts for bash and zsh.
  • Integrated tools – Plugins, wrappers, and other projects that integrate with WP-CLI in some form.

WP-CLI A command line interface for WordPress

Learn more…

David

I'm freelance graphic, website designer. Currently, I get into the secrets of the world of Fedora Linux, SSH, WP-CLI and I’m preparing this blog about WordPress.

More:

Bootstrap – Responsive front-end framework Bootstrap is an open source toolkit for developing with HTML, CSS, and JS. Quickly prototype your ideas or build your entire app with our Sass varia...
Shift+Tab Hides all Adobe Palettes Except Toolbox Shift-Tab Hides all Adobe Palettes Except Toolbox. - Most designers know that tapping the Tab key is the quick way to temporarily hide all open palett...
Generating new business with online marketing Online marketing has become an essential tool for generating new business. In today's competitive world it has become very vital to advertise your bus...
A collection of free tools for app designers There has never been a better time to be an app designer. Not only are there now phones and tablets that allow designers to push themselves to the out...
How to Choose the Perfect Web Host for Your Blog Building a blog from the ground-up can be an exciting yet difficult endeavour to face. Regardless of the niche or topic(s), you plan to cover, there a...

Leave a Reply


Pin It on Pinterest