WP-CLI

A command line interface for WordPress

WP-CLI は WordPress を管理するためのコマンドラインツールです。 プラグインのアップデートやマルチサイトのセットアップなどの多くのことをブラウザ無しで行うことができます。

最新情報を得たい人は、@wpcli on Twitter をフォローするか、メーリングリストにサインアップしてください。

Build Status Dependency Status Average time to resolve an issue Percentage of issues still open

Quick links: 使い方 | インストール方法 | サポート | 拡張 | 貢献 | クレジット

使い方

WP-CLI のゴールは、みなさんが WordPress の管理画面でやりたいと思うことをコマンドラインで提供することです。 たとえば、wp plugin install --activate (ドキュメント) は、プラグインをインストールし有効化します。

$ 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 は、WordPress の管理画面ではできない多くのことが可能です。たとえば、wp transient delete --all (doc) は、Transient に保存されているすべてのデータを削除することを可能にしています。

$ wp transient delete --all
Success: 34 transients deleted from the database.

WP-CLI の使い方に関するさらに詳しい情報は、クイックスタートガイドを読んでください。

もし、すでに基本的なことを理解しているなら、コマンドリストにジャンプして、テーマやプラグインの管理、データのインポートやエクスポート、データベースの操作などについての詳細をみてください。

インストール方法

Phar ファイルをダウンロードする方法が、私たちが推奨するインストール方法です。必要なら上級者向けインストール方法(英語)を見てください。

WP-CLI をインストールする前に、動作環境を確認してください。

動作条件を再度確認してから、wgetまたはcurlを使用して wp-cli.phar をダウンロードしてください。

$ curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

次に、それが動作しているかを確認してください。

$ php wp-cli.phar --info

WP-CLI コマンドをwpで実行するには、それに実行権限があることと環境変数PATHに登録されていることが必要です。

$ chmod +x wp-cli.phar
$ sudo mv wp-cli.phar /usr/local/bin/wp

もし、WP-CLI のインストールが成功していれば、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: 0.25.0

アップデート

WP-CLI をアップデートするには、wp cli update (doc) を実行するか、上述のインストール方法を再度行う必要があります。

もっととんがった生き方をしたい？ wp cli update --nightly を実行すれば、最新の開発者向けバージョンの WP-CLI を使用することができます。開発者向けバージョンは、あなたの開発環境で使用するのに十分な信頼性があり、つねに最新の機能を使用することができます。

タブ補完

WP-CL には、Bash 及び ZSH 用のタブ補完用のスクリプトがあります。 wp-completion.bash をダウンロードして、~/.bash_profile から読み込んでください。

source /FULL/PATH/TO/wp-completion.bash

source ~/.bash_profile を実行するのを忘れないでください。

サポート

WP-CLI のメンテナーとプロジェクトの貢献者たちは、新しい Issue に対して、より迅速に返信したいと思っています。これらのボランティアの時間を節約するために、過去に同じ質問に対する回答がないかを確認してください。

もし、あなたの疑問に対する回答がこれらのサイトから見つからなければ、WordPress.org Slack organization の#cliチャンネルに参加するとコミュニティメンバーが答えを知っているかもしれません。企業ユーザーのみなさんは runcommand でプレミアムサポートをうけることもできます。

GitHub Issues は、既存のコマンドの改良やバグを追跡するために使用されており、一般的なサポートのためには使用されていません。バグレポートを投稿する際には、ベストプラクティスを確認して、あなたが抱える問題が適時確実に伝わるように心がけてください。

Twitterでサポート用の質問をたずねるのはおやめください。Twitterは、文字数が140文字以下であり会話を行うのが難しい、過去の会話から他の人の同じ質問を検索することが難しい、等の理由によりサポートを行う場としてふさわしくありません。

自由は無料とは違います。オープンソースはあなたに自由に使ったり編集したりする権利を保証しますが、他の誰かの時間を浪費することを保証しているわけではありません。敬意をもって、過度な期待をしないように心がけてください。

拡張

それぞれの コマンド は、WP-CLI の関数の一つとして定義されています。wp plugin install (doc) はそのうちのひとつであり、wp plugin activate (doc) は別のもうひとつです。

WP-CLI では、様々な実行可能なクラス、関数、クロージャをコマンドとして実行することが可能です。コマンドとして実行されるために必要な情報は、PHPdoc によって記述します。 WP_CLI::add_command() (doc) は、内部コマンド及びサードパーティコマンドの登録に使用されています。

/**
 * Delete an option from the database.
 *
 * Returns an error if the option didn't exist.
 *
 * ## OPTIONS
 *
 * <key>
 * : Key for the option.
 *
 * ## EXAMPLES
 *
 *     $ wp option delete my_option
 *     Success: Deleted 'my_option' option.
 */
$delete_option_cmd = function( $args ) {
	list( $key ) = $args;

	if ( ! delete_option( $key ) ) {
		WP_CLI::error( "Could not delete '$key' option. Does it exist?" );
	} else {
		WP_CLI::success( "Deleted '$key' option." );
	}
};
WP_CLI::add_command( 'option delete', $delete_option_cmd );

WP-CLI は、多くのコマンドにより構成されており、カスタムコマンドを作ることは意外と簡単です。commands cookbookを読んでください。

貢献

ようこそ、そしてありがとう！

私たちは、みなさんが率先して貢献してくれることに感謝しています。あなたやあなたのまわりのコミュニティによって、WP-CLIはすばらしいプロジェクトになります。

貢献は単にコードだけではありません。 私たちは、チュートリアルを書く、地元のミートアップでデモを行う、ユーザーの質問への回答、ドキュメントの改訂など、あなたの日々の活動に応じた貢献をお願いしています。

すこしだけ時間を使ってガイドラインをよく読んでください。ここに書かれていることに従うことで、本プロジェクトの他の貢献者たちとのコミュニケーションを円滑にすることができます。彼らは、世界をまたがってあなたと一緒に働くことに、最大限の敬意を払う努力をします。

プロジェクトリーダー

WP-CLIは以下の個人によってリードされています。

プロジェクトのガバナンスと完全な貢献者リストも読んでください。

クレジット

composer.json に記載されているライブラリに依存しており、以下のプロジェクトからコードやアイディアを得ています。