UStackUStack
Studio CLI icon

Studio CLI

使用 Studio CLI 在终端控制 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