Studio CLI

¿Qué es Studio CLI?

Studio CLI es una utilidad de línea de comandos disponible globalmente para interactuar con las funciones de WordPress Studio desde tu terminal. Está diseñada para funcionar incluso cuando la aplicación de escritorio de Studio está cerrada, y se usa para gestionar sitios locales de Studio y entornos de previsualización alojados en WordPress.com.

La CLI se puede instalar con Studio (viene incluida) o usarse como un módulo npm independiente llamado wp-studio. Su propósito principal es permitirte controlar tareas relacionadas con Studio —como la creación, actualización y autenticación de sitios de previsualización— desde scripts y pasos de compilación.

Características principales

• Comando global en terminal (studio): Ejecuta acciones relacionadas con Studio desde cualquier lugar sin necesidad de mantener Studio abierto.
• Sintaxis de comandos estructurada (studio <area> <command> [options]): Aplica patrones predecibles para flujos de trabajo de sitios y previsualizaciones.
• Apuntado por ruta (--path): Dirige los comandos a un directorio específico de un sitio Studio en lugar de depender del directorio de trabajo actual.
• Gestión de autenticación de WordPress.com: Usa studio auth login, studio auth logout y studio auth status para conectar acciones de la CLI a una cuenta autenticada de WordPress.com cuando sea necesario.
• Operaciones en sitios de previsualización: Crea, lista, actualiza y elimina sitios de previsualización temporales y compartibles en WordPress.com con comandos como studio preview create, studio preview list, studio preview update y studio preview delete.
• Comandos de gestión de sitios locales: Gestiona sitios locales de Studio (estado, crear, listar, iniciar, detener, eliminar y configurar) desde la terminal con comandos studio site ....

Cómo usar Studio CLI

1. Habilita Studio CLI en la app de Studio (recomendado si ya usas Studio):

   • Abre la aplicación “WordPress Studio”.
   • En el menú principal, abre el modal de Settings (o haz clic en el icono de engranaje).
   • Habilita “Studio CLI” y haz clic en Save.
   • En macOS, es posible que se te solicite la contraseña de tu cuenta para permitir la instalación.

2. Abre una terminal y verifica la disponibilidad:

   • Usa studio --help para ver una visión general de alto nivel.

3. Autentícate para tareas que requieren acceso a WordPress.com (p. ej., sitios de previsualización):

   • Ejecuta studio auth login.
   • El comando abre un flujo basado en navegador; recibirás un token de autenticación para pegar en la terminal.
   • Confirma con studio auth status.

4. Crea y comparte un sitio de previsualización desde tu sitio local de Studio:

   • Desde la raíz de tu sitio local de Studio, ejecuta:

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

   • La CLI compila y sube tu sitio local a un entorno de previsualización y devuelve una URL de previsualización para compartir.

5. Actualiza o elimina previsualizaciones usando el nombre de host de previsualización:

   • Lista las previsualizaciones con studio preview list para obtener el identificador host.
   • Actualiza:

     studio preview update <host>
     

   • Elimina:

     studio preview delete <host>
     

6. Apunta a un directorio de sitio diferente cuando sea necesario:

   • Agrega --path /path/to/site a los comandos en lugar de cambiar de directorios:

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

Casos de uso

• Gestiona sitios locales de Studio sin salir de la terminal: Usa studio site status, studio site start, studio site stop y studio site list para controlar entornos locales mientras trabajas en un flujo de trabajo con muchos scripts.

• Crea entornos de previsualización para compartir con compañeros o interesados: Ejecuta studio preview create desde la raíz de tu sitio local de Studio para generar una URL de previsualización temporal y compartible alojada en WordPress.com.

• Itera en una previsualización a medida que se aplican cambios: Tras la creación inicial de la previsualización, usa studio preview update <host> para recompilar y redeplegar cambios del sitio local al entorno de previsualización existente.

• Limpia entornos de previsualización: Usa studio preview delete <host> para eliminar permanentemente un sitio de previsualización cuando ya no sea necesario.

• Automatiza flujos de trabajo de Studio en pasos de compilación: Usa comandos studio desde scripts para integrar tareas como creación/actualización de previsualizaciones y gestión de sitios en tu pipeline de desarrollo.

Preguntas frecuentes

¿Necesito tener la app de escritorio de Studio abierta para usar Studio CLI? No. Studio CLI está diseñada para interactuar con las funciones de Studio desde tu terminal independientemente de si Studio está abierto.

¿Cómo apunto un comando a un directorio específico de un sitio Studio? La mayoría de los comandos asumen que los ejecutas desde la raíz de un sitio gestionado por Studio. Si no es así, usa la opción --path (por ejemplo, studio preview create --path /path/to/site).

¿Qué pasa si ejecuto un comando de previsualización sin estar autenticado? Los comandos que requieren autenticación (como studio preview create) devolverán un error y te guiarán para iniciar sesión.

¿Cómo encuentro el nombre de host de previsualización para actualizar/eliminar? Ejecuta studio preview list para mostrar las previsualizaciones asociadas y sus valores de host. Usa ese host con studio preview update <host> o studio preview delete <host>.

¿De dónde viene la información de autenticación para studio auth login? El comando de inicio de sesión inicia un flujo basado en navegador para conectar la CLI a tu cuenta de WordPress.com, luego proporciona un token de autenticación que pegas en la terminal para completar el proceso.

Alternativas

• Flujo de trabajo manual de la interfaz de Studio: Si no necesitas automatización desde la terminal, usar directamente la aplicación Studio puede cubrir la creación de previsualizaciones y el control de sitios locales sin integración con CLI.
• Herramientas genéricas de línea de comandos para WordPress (p. ej., WP-CLI + scripts personalizados): Donde no se requieran entornos de previsualización específicos de Studio, puedes combinar herramientas de WordPress en línea de comandos con tus propios scripts para gestionar tareas de sitios, aunque el alojamiento de previsualizaciones y las funciones específicas de Studio podrían no estar cubiertas.
• Otros enfoques de orquestación local para WordPress: En lugar de los comandos de gestión de sitios de Studio, puedes usar configuraciones locales de WordPress diferentes (containerizadas o con scripts) y manejar previsualizaciones mediante pasos de implementación separados, a costa de perder el flujo de trabajo unificado de Studio CLI para previsualizar/actualizar/eliminar y sitios gestionados por Studio.