Studio CLI icon

Studio CLI

Studio CLI is the terminal interface for WordPress Studio. It lets you manage local sites, preview sites, authentication, and Blueprint-based site creation from the command line.

Studio CLI

WordPress Studio from the terminal

Studio CLI is the command-line interface for WordPress Studio. It lets you control Studio features from the terminal whether or not the Studio app is open, and it ships with Studio as well as as the standalone npm module `wp-studio`.

The CLI is designed for local WordPress development workflows that need scripting or terminal control. The documented areas include authentication, preview sites hosted on WordPress.com, local site management, and Blueprint-based site creation, with support for running commands from a site root or by passing a site path explicitly.

Core capabilities

Local site management

Manage local Studio sites from the terminal, including status checks, creation, starting, stopping, deleting, and configuration updates.

Preview site workflows

Create, list, update, and delete temporary preview sites hosted on WordPress.com so local work can be shared without a local environment.

Authentication commands

Log in, log out, and check auth status for WordPress.com features that require a signed-in user, such as preview sites.

Terminal-friendly command structure

Invoke commands with a consistent pattern like `studio <area> <command> [options]`, and use `--path` to target a site directory outside the current working directory.

Blueprint-based site creation

Create sites from Blueprints through Studio, including featured blueprints and custom JSON Blueprint files.

Common workflows

  • Local development maintenance

    Use the CLI to create and manage local Studio sites from the terminal, including checking status, starting or stopping a site, and adjusting settings without opening the app.

  • Sharing work in progress

    Create a preview site for a local project, share the generated URL with collaborators, and later update or delete that preview from the same command set.

  • Automated site workflows

    Run Studio-managed site workflows inside scripts or build steps when you need repeatable terminal automation rather than manual app interaction.

  • Account-based features

    Use the auth commands to connect a WordPress.com account before running commands that depend on a logged-in session, such as preview-site actions.

  • Blueprint-driven setup

    Create a new local site from the Blueprints flow or apply a Blueprint file when you want a reproducible starting environment.

Pros and Cons

Pros

  • Works from the terminal, which fits scripting and build-step workflows.
  • Can manage local Studio sites without needing the desktop app to be open.
  • Supports shareable preview sites hosted on WordPress.com.
  • Includes authentication commands and clear `--help` entry points for command details.
  • Can be used with Blueprint-based site creation and custom site paths.

Cons

  • The provided documentation is focused on command reference and does not fully document every command family, including the later WP-CLI section mentioned in the page text.
  • Several capabilities depend on WordPress.com authentication, which adds an extra setup step for preview-site-related workflows.

FAQ

What is Studio CLI?

Studio CLI is the terminal interface for WordPress Studio. It is invoked with the `studio` command and supports commands for authentication, preview sites, and local site management.

How do I get Studio CLI?

The CLI comes bundled with Studio and is also available as the standalone npm module `wp-studio`. If Studio is already installed, you can enable the CLI from the Studio app settings.

What can I do with Studio CLI?

The source documents preview site commands, local site management commands, and Blueprints-based site creation. They also mention running WP-CLI commands through Studio and integrating Studio into scripts and build steps, but the detailed WP-CLI flow is not expanded on in the provided text.

Do I need a WordPress.com account for every command?

Some commands, such as preview site creation, require WordPress.com authentication. If you run a command that needs auth while logged out, the CLI returns an error and prompts you to log in.

Where do I run Studio CLI commands?

Most commands are designed to be run from the root directory of a Studio-managed site, though you can point to another site directory with the `--path` option.

Quick Facts

Category
Developer Tool
Product
Studio CLI
Platform
WordPress Studio desktop app and npm (`wp-studio`)?
Primary command
`studio`
Related workflows
Authentication, preview sites, local site management, Blueprints