Studio CLI icon

Studio CLI

Studio CLI 是 WordPress Studio 的终端界面,可通过命令行管理本地站点、预览站点、身份验证和基于 Blueprint 的站点创建。

Studio CLI

来自终端的 WordPress Studio

Studio CLI 是 WordPress Studio 的命令行界面。无论 Studio 应用是否打开,它都允许你从终端控制 Studio 功能,并且它随 Studio 一起提供,也作为独立的 npm 模块 `wp-studio` 提供。

该 CLI 旨在满足需要脚本或终端控制的本地 WordPress 开发工作流。其文档涵盖身份验证、托管在 WordPress.com 上的预览站点、本地站点管理以及基于 Blueprint 的站点创建,并支持从站点根目录运行命令或通过显式传递站点路径来运行命令。

核心功能

本地站点管理

通过终端管理本地 Studio 站点,包括状态检查、创建、启动、停止、删除和配置更新。

预览站点工作流

创建、列出、更新和删除托管在 WordPress.com 上的临时预览站点,以便在没有本地环境时共享本地工作成果。

身份验证命令

为需要登录用户的 WordPress.com 功能登录、登出并检查身份验证状态,例如预览站点。

适合终端的命令结构

使用一致的模式调用命令,例如 `studio <area> <command> [options]`,并使用 `--path` 目标指向当前工作目录之外的站点目录。

基于 Blueprint 的站点创建

通过 Studio 从 Blueprints 创建站点,包括精选蓝图和自定义 JSON Blueprint 文件。

常见工作流

  • 本地开发维护

    使用 CLI 从终端创建和管理本地 Studio 站点,包括检查状态、启动或停止站点,以及在不打开应用的情况下调整设置。

  • 共享进行中的工作

    为本地项目创建预览站点,共享生成的 URL 给协作者,之后再用同一组命令更新或删除该预览站点。

  • 自动化站点工作流

    当你需要可重复的终端自动化而不是手动应用交互时,可在脚本或构建步骤中运行由 Studio 管理的站点工作流。

  • 基于账户的功能

    在运行依赖登录会话的命令之前,使用身份验证命令连接 WordPress.com 账户,例如预览站点操作。

  • 基于 Blueprint 的设置

    当你想要可复现的起始环境时,可通过 Blueprints 流程创建新的本地站点或应用 Blueprint 文件。

Pros and Cons

Pros

  • 可从终端运行,适合脚本和构建步骤工作流。
  • 无需打开桌面应用即可管理本地 Studio 站点。
  • 支持可共享的、托管在 WordPress.com 上的预览站点。
  • 包含身份验证命令和清晰的 `--help` 入口,可查看命令详情。
  • 可与基于 Blueprint 的站点创建和自定义站点路径配合使用。

Cons

  • 所提供的文档侧重于命令参考,并未完整说明每个命令组,包括页面文本中提到的后续 WP-CLI 部分。
  • 若干功能依赖 WordPress.com 身份验证,这为与预览站点相关的工作流增加了额外的设置步骤。

FAQ

什么是 Studio CLI?

Studio CLI 是 WordPress Studio 的终端界面。它通过 `studio` 命令调用,支持身份验证、预览站点和本地站点管理相关命令。

如何获取 Studio CLI?

该 CLI 随 Studio 捆绑提供,也可作为独立的 npm 模块 `wp-studio` 使用。如果你已经安装了 Studio,可以在 Studio 应用设置中启用 CLI。

我可以使用 Studio CLI 做什么?

源文档介绍了预览站点命令、本地站点管理命令以及基于 Blueprints 的站点创建。文档还提到可通过 Studio 运行 WP-CLI 命令并将 Studio 集成到脚本和构建步骤中,但所提供文本并未展开详细的 WP-CLI 流程。

我需要为每个命令都使用 WordPress.com 账户吗?

某些命令,例如创建预览站点,需要 WordPress.com 身份验证。如果你在未登录状态下运行需要身份验证的命令,CLI 会返回错误并提示你登录。

我应该在哪里运行 Studio CLI 命令?

大多数命令设计为在 Studio 管理站点的根目录中运行,不过你也可以使用 `--path` 选项指向其他站点目录。

Quick Facts

类别
开发工具
产品
Studio CLI
平台
WordPress Studio 桌面应用和 npm(`wp-studio`)
主要命令
`studio`
相关工作流
身份验证、预览站点、本地站点管理、Blueprints