Skip to content

index.md

Latest commit

 

History

History
142 lines (97 loc) · 3.5 KB

index.md

File metadata and controls

142 lines (97 loc) · 3.5 KB
layout default
title Command line interface for WordPress

WP-CLI is a set of command-line tools for managing WordPress installations. You can update plugins, set up multisite installs and much more, without using a web browser.

Requirements

  • UNIX-like environment (OS X, Linux, FreeBSD, Cygwin)
  • PHP 5.3.2 or later
  • WordPress 3.4 or later

Installing

Just execute the following command in your terminal:

curl https://raw.github.com/wp-cli/wp-cli.github.com/master/installer.sh | bash

Make sure to read the instructions.

Tab completions

WP-CLI comes with a tab completion script for command, subcommand and flag names.

If you're using Bash, add the following lines to ~/.bash_profile:

# WP-CLI Bash completions
source $HOME/.wp-cli/vendor/wp-cli/wp-cli/utils/wp-completion.bash

And re-load the file:

source ~/.bash_profile

If you're using Zsh, add the following lines to ~/.zprofile:

# WP-CLI Bash completions
autoload bashcompinit
bashcompinit
source $HOME/.wp-cli/vendor/wp-cli/wp-cli/utils/wp-completion.bash

And re-load the file:

source ~/.zprofile

Updating

If you installed WP-CLI using the method above, you can also easily update it:

cd ~/.wp-cli
php composer.phar self-update
php composer.phar require 'wp-cli/wp-cli=@stable' --no-dev

Also see Alternative Install Methods.

Using

Go into a WordPress root folder:

cd /var/www/wp/

Typing wp should show you output similar to this:

Available commands:
    wp blog create|delete
    wp cache add|decr|delete|flush|get|incr|replace|set|type
    wp comment create|delete|trash|untrash|spam|unspam|approve|unapprove|count|status|last
    wp core download|config|is-installed|install|install-network|version|update|update-db
    wp db create|drop|reset|optimize|repair|connect|cli|query|export|import
    wp eval-file
    ...

See 'wp help <command>' for more information on a specific command.

Let's try to install the Hello Dolly plugin from wordpress.org:

wp plugin install hello-dolly

Output:

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 ...
Plugin installed successfully.

Multisite

On a multisite installation, you need to pass a --url parameter, so that WP-CLI knows which site it's supposed to be operating on:

wp theme status --url=localhost/wp/test

If you have a subdomain installation, it would look like this:

wp theme status --url=test.example.com

If you're usually working on the same site most of the time, you can create a wp-cli.yml file in the root directory:

url: test.example.com

Then, you can call wp without the --url parameter again:

wp theme status

Adding commands

Adding commands to WP-CLI is as easy as creating a PHP class. See the Commands Cookbook for more info.

Please share the commands you make by adding them to the List of community commands.

Contributors