WP-CLI はいろいろな方法でみなさんの環境にインストールすることができます。
それぞれユースケースがいろいろありますので、それらを紹介します。
Homebrewでインストール
Mac の人にとってはこれが一番簡単な方法かもですね。
$ brew install homebrew/php/wp-cli
一見簡単ですが、Homebrew が Xcode に依存しているので、ハンズオンとかの際にXcodeをダウンロードして。。。っていうのはなかなか大変なことになります。
あと、最新版がリリースされた後に、その最新版がダウンロードできるようになるまでにややタイムラグがあります。
アップデートを行うには brew update && brew upgrade ですね。
他のものとまとめてアップデートできるので、メンドくさがりな人にはおすすめ。
Phar アーカイブをダウンロードする
WP-CLI は Phar アーカイブで配布されているので、それをダウンロードする方法もやや手数は必要ですが簡単です。
この方法は Homebrew などに依存しないので、多くの環境で動作させることができます。また最新版がリリースされれると同時にそれにアップデートすることも可能です。
$ curl https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
または
$ wget https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
つぎに実行権限をつけてください。
$ chmod 755 wp-cli.phar
以上でとりあえず動作します。試しに以下のコマンドを実行してみましょう。
$ ./wp-cli.phar --info
環境によって内容は変わりますが以下のような出力があればおっけー。
PHP binary: /usr/bin/php
PHP version: 5.6.25
php.ini used:
WP-CLI root dir: phar://wp-cli.phar
WP-CLI packages dir: /Users/xxxx/.wp-cli/packages/
WP-CLI global config: /Users/xxxx/.wp-cli/config.yml
WP-CLI project config:
WP-CLI version: 0.25.0
次にこれを wp というファイル名で $PATH が通っているディレクトリに移動します。
$ mv wp-cli.phar /usr/local/bin/wp
このインストール方法を使用した場合に最新のWP-CLIにアップデートを行うには、以下のコマンドを実行してください。
$ wp cli update
パーミッションがなんたらかんたらって怒られた場合は以下のコマンドで。
$ sudo wp cli update --allow-root
そうそう、WP-CLI は sudo とか root とかでコマンドを実行することは推奨していません。update 以外のコマンドも sudo が必要な場合は環境を見直しましょう。
Nightly バージョンをインストール
WP-CLI のリリースサイクルは現時点で約3ヶ月サイクルになっていますが、開発はとても活発にされており毎日のように改善が行われています。
これらの様々な修正は GitHub の master ブランチに push されるたびに4000通り以上のテストケースでテストされ、自動的に Nightly バージョンとしてリリースされています。
開発チームではこの Nightly バージョンを本番環境で使うことは推奨していませんが、開発環境で使うには十分な品質が保証されていると考えていますので、みなさんの環境にこれをインストールすれば、いち早く最新の機能をつかったり、バグが修正された WP-CLI を使うことができます。
インストール方法は上述の Phar アーカイブによるインストール方法とほぼ同じですが、アーカイブのURLが変わります。
$ curl https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli-nightly.phar
$ chmod 755 wp-cli-nightly.phar
$ mv wp-cli-nightly.phar /usr/local/bin/wp
アップデートを行うには以下のコマンドで。
$ wp cli update --nightly
ドキュメントが整備される前のバージョンがインストールされますので、ドキュメントにないコマンドがあったり、コマンドの仕様がドキュメントとやや違う場合もありますのでご注意ください。
GitHub から clone してインストール
たとえば WP-CLI に頻繁にプルリクエストを送ったりするなど、開発に参加するには以下の方法でインストールしてください。
$ git clone git@github.com:wp-cli/wp-cli.git
リポジトリをフォークしてる場合は、clone する URL は適当に置き換えてください。
次に clone してできたディレクトリに移動して、依存関係があるライブラリをインストールします。
$ cd wp-cli
$ composer install
bin/ 以下に wp というファイルがあります。これが実行用のファイルです。
~/.bash_profile 等に以下のように記述することで、wp コマンドとして利用可能になります。
export PATH=/path/to/wp-cli/bin:$PATH
/path/to/wp-cli の部分はみなさんが clone したディレクトリへのパスです。