Studio CLI

Studio CLIとは？

Studio CLIは、ターミナルからWordPress Studioの機能とやり取りするためのグローバルに利用可能なコマンドラインツールです。Studioデスクトップアプリが閉じていても動作するよう設計されており、ローカルStudioサイトやWordPress.com上でホストされるプレビュー環境を管理するために使用します。

CLIはStudioにバンドルされてインストール可能、またはwp-studioという独立したnpmモジュールとして使用できます。主な目的は、スクリプトやビルドステップからプレビューサイトの作成・更新・認証などのStudio関連タスクを制御することです。

主な機能

• グローバルターミナルコマンド（studio）: Studioを開いたままにしなくても、どこからでもStudio関連アクションを実行。
• 構造化されたコマンド構文（studio <area> <command> [options]）: サイトやプレビュー作業に予測可能なパターンを適用。
• パス指定（--path）: 現在の作業ディレクトリに頼らず、特定のStudioサイトディレクトリを対象にコマンドを実行。
• WordPress.com認証管理: studio auth login、studio auth logout、studio auth statusを使用して、必要な場合にCLIアクションを認証済みWordPress.comアカウントに接続。
• プレビューサイト操作: studio preview create、studio preview list、studio preview update、studio preview deleteなどのコマンドでWordPress.com上の共有可能な一時プレビューサイトを作成・一覧・更新・削除。
• ローカルサイト管理コマンド: studio site ...コマンドでターミナルからローカルStudioサイト（ステータス、作成、一覧、開始、停止、削除、設定）を管理。

Studio CLIの使い方

1. StudioアプリでStudio CLIを有効化（Studioをすでに使用中の場合のおすすめ）：

   • 「WordPress Studio」アプリケーションを開く。
   • メインメニューから設定モーダルを開く（または歯車アイコンをクリック）。
   • 「Studio CLI」を有効にして保存をクリック。
   • macOSではインストール許可のためアカウントパスワードの入力を求められる場合があります。

2. ターミナルを開いて利用可能かを確認：

   • studio --helpを実行して概要を表示。

3. WordPress.comアクセスが必要なタスク（例: プレビューサイト）の認証：

   • studio auth loginを実行。
   • ブラウザベースのフローが開き、ターミナルに貼り付ける認証トークンを取得。
   • studio auth statusで確認。

4. ローカルStudioサイトからプレビューサイトを作成・共有：

   • ローカルStudioサイトのルートから実行：

     cd /path/to/your/studio-site
     studio preview create
     

   • CLIがローカルサイトをビルド・アップロードし、共有用のプレビューURLを返却。

5. プレビューホスト名を使ってプレビューを更新・削除：

   • studio preview listでhost識別子を取得。
   • 更新：

     studio preview update <host>
     

   • 削除：

     studio preview delete <host>
     

6. 必要な場合に別のサイトディレクトリを対象に：

   • ディレクトリ変更の代わりに--path /path/to/siteを追加：

     studio preview create --path /path/to/your/studio-site
     

ユースケース

• ターミナルからローカルStudioサイトを管理： スクリプト中心のワークフローでstudio site status、studio site start、studio site stop、studio site listを使用してローカル環境を制御。

• チームメンバーやステークホルダーと共有するためのプレビュー環境作成： ローカルStudioサイトルートからstudio preview createを実行してWordPress.com上でホストされる一時共有プレビューURLを生成。

• 変更を適用しながらプレビューを反復： 初回プレビュー作成後、studio preview update <host>でローカルサイトの変更を既存プレビュー環境に再構築・再デプロイ。

• プレビュー環境のクリーンアップ： 不要になったらstudio preview delete <host>でプレビューサイトを永久削除。

• ビルドステップでStudioワークフローを自動化： スクリプトからstudioコマンドを使用してプレビュー作成・更新やサイト管理を開発パイプラインに統合。

FAQ

Studio CLIを使用するのにStudioデスクトップアプリを開く必要はありますか？ いいえ。Studio CLIはStudioが開いていなくてもターミナルからStudio機能とやり取りするよう設計されています。

コマンドを特定のStudioサイトディレクトリに指定する方法は？ ほとんどのコマンドはStudio管理サイトのルートからの実行を想定しています。それ以外の場合、--pathオプションを使用（例: studio preview create --path /path/to/site）。

ログアウト状態でプレビューコマンドを実行するとどうなりますか？ 認証が必要なコマンド（例: studio preview create）はエラーを返し、ログインを案内します。

更新・削除に使用するプレビューホスト名はどこで確認？ studio preview listを実行して関連プレビューとhost値を表示。そのhostをstudio preview update <host>やstudio preview delete <host>で使用。

studio auth loginの認証情報はどこから？ ログインコマンドがブラウザベースのフローを開始し、CLIをWordPress.comアカウントに接続。ターミナルに貼り付ける認証トークンを提供して完了。

代替案

• 手動のStudio UIワークフロー： ターミナル自動化が必要ない場合、Studioアプリケーションを直接使用することで、CLI統合なしにプレビュー作成とローカルサイト制御が可能です。
• 汎用WordPressコマンドラインツール（例：WP-CLI + カスタムスクリプト）： Studio固有のプレビュー環境が不要な場合、コマンドラインツールと独自スクリプトを組み合わせてサイトタスクを管理できますが、プレビューホスティングやStudio固有の機能はカバーされない可能性があります。
• その他のローカルWordPressオーケストレーションアプローチ： Studioのサイト管理コマンドの代わりに、異なるローカルWordPressセットアップ（コンテナ化やスクリプト化）を使用し、プレビューを別途デプロイステップで処理できますが、Studio CLIのプレビュー/更新/削除とStudio管理サイトの統一ワークフローを失います。