CLI

Rudelはコマンドをwp rudelに登録します。WP-CLIでは、ここに記載されていないオプションを指定するとunknown --<name> parameterで拒否されます。

プラグインの読み込み前にwp-config.phpでRUDEL_CLI_COMMANDを定義すると、組み込み用途向けにルートコマンドの名前を変更できます。

define( 'RUDEL_CLI_COMMAND', 'sandbox' );

これにより、wp rudel createがwp sandbox createに変わります。コマンドの動作は変わりません。

コマンドはデフォルトでホストに対して実行されます。別のWP-CLIコマンドをサンドボックス内で実行するには、RUDEL_ENVIRONMENTを設定します。

RUDEL_ENVIRONMENT=alpha-3be7 wp option get blogname

作成

wp rudel create [--name=<name>] [--theme=<slug>] [--clone-from=<id>] [--owner=<owner>] [--labels=<labels>] [--purpose=<purpose>] [--protected] [--ttl-days=<days>] [--expires-at=<timestamp>] [--git=<remote>] [--type=<theme|plugin>] [--template=<label>]

サンドボックスを作成し、そのIDを表示します。

--clone-db、--clone-themes、--clone-plugins、--clone-uploads、--clone-all、--shared-plugins、--shared-uploadsは非推奨です。進行状況メッセージを変えるだけで、どのサンドボックスもテーブルを複製し、テーマを1つコピーし、プラグインとアップロードを共有します。

このコマンドは、サンドボックスディレクトリにcdしてwp post listを実行するよう案内して終了します。サンドボックスディレクトリ内のwp-cli.ymlがホストのURLを指しているため、これはホストに対して実行されます。代わりにRUDEL_ENVIRONMENTを使ってください。

一覧

wp rudel list [--format=<table|json|csv|yaml|count>]

サンドボックスのID、名前、所有者、保護状態、有効期限、ステータス、テンプレートラベル、作成日時、ディレクトリサイズを一覧表示します。

情報

wp rudel info <id> [--format=<table|json|yaml>]

テーブル接頭辞、テーマ、ラベル、複製メタデータ、URL、コンテンツパスを含むサンドボックスのレコードを表示します。

更新

wp rudel update <id> [--owner=<owner>] [--labels=<labels>] [--purpose=<purpose>] [--protected] [--unprotected] [--ttl-days=<days>] [--expires-at=<timestamp>] [--clear-expiry]

メタデータを更新します。--ttl-daysは現在からの相対値です。サンドボックスのサイトコンテンツは変更しません。

削除

wp rudel destroy <id> [--force]

サンドボックスのテーブルを削除し、ディレクトリとリンクされたワークツリーを取り除いて、レコードを削除します。コマンドは確認を求めます。--forceを指定すると確認を省略します。保護設定はdestroyを妨げないため、保護されたサンドボックスも他と同様に破棄されます。

状態

wp rudel status

ブートストラップの状態、現在のサンドボックス、サンドボックスのディレクトリと件数、rudel_configの値、自動化がスケジュールされているかどうかを表に出力します。常に表を出力し、--formatは無視します。

クリーンアップ

wp rudel cleanup [--dry-run] [--max-age-days=<days>] [--max-idle-days=<days>] [--merged]

--mergedを指定しない場合、有効期限切れ、または経過期間の上限を超えたサンドボックスや、アイドル期間の上限を超えた保護されていないサンドボックスを削除します。--max-age-daysと--max-idle-daysを指定すると、この実行に限りrudel_configを上書きします。--mergedを指定すると、リンクされたGitワークツリーのブランチがマージ済みのサンドボックスを削除します。保護されたサンドボックスは常に対象外です。クリーンアップを参照してください。

ログ

wp rudel logs <id> [--lines=<lines>] [--follow] [--clear]

サンドボックスのdebug.logの末尾（デフォルトは50行）を表示します。--followはtail -fを実行し、--clearはファイルを空にします。エラーログを参照してください。

スナップショット

wp rudel snapshot <id> --name=<name>

名前付きスナップショットを作成します。

復元

wp rudel restore <id> --snapshot=<name> [--force]

スナップショットを復元します。コマンドは確認を求めます。--forceを指定すると確認を省略します。スナップショットを参照してください。

テンプレート

wp rudel template save <id> --name=<name> [--description=<description>]
wp rudel template list [--format=<table|json|csv|yaml|count>]
wp rudel template delete <name> [--force]

テンプレートのコピーを保存、一覧表示、削除します。保存済みテンプレートからサンドボックスを作成するコマンドはありません。テンプレートを参照してください。

プッシュ

wp rudel push <id> [--git=<remote>] [--dir=<dir>] [--message=<message>]

サンドボックスディレクトリ内のチェックアウトをブランチrudel/<id>にコミットしてプッシュします。

Gitを参照してください。