UStackUStack
Studio CLI icon

Studio CLI

用終端機控制 Studio 的 WordPress 相關功能;管理本機 Studio 站點、建立/更新/刪除 WordPress.com 預覽網站並進行認證。

Studio CLI

Studio CLI 是什麼?

Studio CLI 是一款全域可用的命令列工具,可讓您從終端機與 WordPress Studio 功能互動。即使 Studio 桌面應用程式已關閉,它仍可運作,用於管理本機 Studio 站點以及託管於 WordPress.com 的預覽環境。

CLI 可隨 Studio 安裝(已內建),或作為獨立的 npm 模組 wp-studio 使用。其核心目的是讓您從腳本與建置步驟控制 Studio 相關任務,例如預覽站點建立、更新與認證。

主要功能

  • 全域終端指令 (studio):無需保持 Studio 開啟,即可從任何位置執行 Studio 相關動作。
  • 結構化指令語法 (studio <area> <command> [options]):套用可預測模式,處理站點與預覽工作流程。
  • 路徑指定 (--path):將指令指向特定 Studio 站點目錄,而非依賴目前工作目錄。
  • WordPress.com 認證管理:使用 studio auth loginstudio auth logoutstudio auth status,在需要時將 CLI 動作連結至已認證的 WordPress.com 帳戶。
  • 預覽站點操作:使用 studio preview createstudio preview liststudio preview updatestudio 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 statusstudio site startstudio site stopstudio site list,在腳本密集工作流程中控制本機環境。

  • 建立預覽環境與團隊成員或利害關係人分享: 從本機 Studio 站點根目錄執行 studio preview create,產生託管於 WordPress.com 的臨時可分享預覽 URL。

  • 變更上線後迭代預覽: 初始預覽建立後,使用 studio preview update <host> 從本機站點重建並重新部署變更至現有預覽環境。

  • 清理預覽環境: 使用 studio preview delete <host> 永久移除不再需要的預覽站點。

  • 在建置步驟自動化 Studio 工作流程: 從腳本使用 studio 指令,將預覽建立/更新與站點管理等任務整合至開發流程。

常見問題

使用 Studio CLI 是否需要開啟 Studio 桌面應用程式? 不需要。Studio CLI 設計為無論 Studio 是否開啟,都可從終端機與 Studio 功能互動。

如何將指令指向特定 Studio 站點目錄? 大多數指令假設您從 Studio 管理站點根目錄執行。若非如此,請使用 --path 選項(例如 studio preview create --path /path/to/site)。

登出狀態下執行預覽指令會如何? 需要認證的指令(例如 studio preview create)會傳回錯誤並引導您登入。

如何找出用於更新/刪除的預覽主機名稱? 執行 studio preview list 顯示相關預覽及其主機值。使用該主機搭配 studio preview update <host>studio preview delete <host>

studio auth login 的認證資訊從何而來? 登入指令啟動瀏覽器流程,將 CLI 連結至您的 WordPress.com 帳戶,然後提供認證權杖供您貼至終端機完成程序。

替代方案

  • 手動 Studio UI 工作流程: 如果不需要終端機自動化,直接使用 Studio 應用程式即可涵蓋預覽建立與本機站點控制,而無需 CLI 整合。
  • 通用 WordPress 命令列工具(例如 WP-CLI + 自訂腳本): 若無需 Studio 專屬預覽環境,可結合命令列 WordPress 工具與自訂腳本管理站點任務,惟預覽託管與 Studio 專屬功能可能無法涵蓋。
  • 其他本機 WordPress 協調方式: 取代 Studio 的站點管理指令,可採用不同的本機 WordPress 設定(容器化或腳本化),並透過獨立部署步驟處理預覽,但將失去 Studio CLI 統一的工作流程,用於預覽/更新/刪除及 Studio 管理站點。
Studio CLI | UStack