Studio CLI

O que é o Studio CLI?

O Studio CLI é uma utilidade de linha de comando globalmente disponível para interagir com recursos do WordPress Studio pelo terminal. Ele foi projetado para funcionar mesmo com o app desktop do Studio fechado, e é usado para gerenciar sites locais do Studio e ambientes de preview hospedados no WordPress.com.

O CLI pode ser instalado com o Studio (vem em bundle) ou usado como um módulo npm standalone chamado wp-studio. Seu propósito principal é permitir que você controle tarefas relacionadas ao Studio — como criação, atualização e autenticação de sites de preview — a partir de scripts e etapas de build.

Principais Recursos

• Comando global no terminal (studio): Execute ações relacionadas ao Studio de qualquer lugar sem precisar manter o Studio aberto.
• Sintaxe de comando estruturada (studio <area> <command> [options]): Aplique padrões previsíveis para fluxos de sites e previews.
• Alvo de caminho (--path): Direcione comandos para um diretório específico de site Studio em vez de depender do diretório de trabalho atual.
• Gerenciamento de autenticação no WordPress.com: Use studio auth login, studio auth logout e studio auth status para conectar ações do CLI a uma conta autenticada no WordPress.com quando necessário.
• Operações em sites de preview: Crie, liste, atualize e exclua sites de preview temporários e compartilháveis no WordPress.com com comandos como studio preview create, studio preview list, studio preview update e studio preview delete.
• Comandos de gerenciamento de sites locais: Gerencie sites locais do Studio (status, criar, listar, iniciar, parar, excluir e configurar) pelo terminal usando comandos studio site ....

Como Usar o Studio CLI

1. Ative o Studio CLI no app Studio (recomendado se você já usa o Studio):

   • Abra o aplicativo “WordPress Studio”.
   • No menu principal, abra o modal de Configurações (ou clique no ícone de engrenagem).
   • Ative “Studio CLI” e clique em Salvar.
   • No macOS, você pode ser solicitado a inserir a senha da sua conta para permitir a instalação.

2. Abra um terminal e verifique a disponibilidade:

   • Use studio --help para ver uma visão geral de alto nível.

3. Autentique para tarefas que exigem acesso ao WordPress.com (ex.: sites de preview):

   • Execute studio auth login.
   • O comando abre um fluxo baseado em navegador; você receberá um token de autenticação para colar no terminal.
   • Confirme com studio auth status.

4. Crie e compartilhe um site de preview a partir do seu site local do Studio:

   • Da raiz do seu site local do Studio, execute:

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

   • O CLI constrói e envia seu site local para um ambiente de preview e retorna uma URL de preview para compartilhar.

5. Atualize ou exclua previews usando o nome do host do preview:

   • Liste previews com studio preview list para obter o identificador host.
   • Atualize:

     studio preview update <host>
     

   • Exclua:

     studio preview delete <host>
     

6. Alvo um diretório de site diferente quando necessário:

   • Adicione --path /path/to/site aos comandos em vez de mudar de diretório:

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

Casos de Uso

• Gerencie sites locais do Studio sem sair do terminal: Use studio site status, studio site start, studio site stop e studio site list para controlar ambientes locais em fluxos de trabalho com muitos scripts.

• Crie ambientes de preview para compartilhar com colegas ou stakeholders: Execute studio preview create da raiz do seu site local do Studio para gerar uma URL de preview temporária e compartilhável hospedada no WordPress.com.

• Itere em um preview conforme as mudanças chegam: Após a criação inicial do preview, use studio preview update <host> para reconstruir e redeployar mudanças do site local para o ambiente de preview existente.

• Limpe ambientes de preview: Use studio preview delete <host> para remover permanentemente um site de preview quando não for mais necessário.

• Automatize fluxos de trabalho do Studio em etapas de build: Use comandos studio em scripts para integrar tarefas como criação/atualização de previews e gerenciamento de sites na sua pipeline de desenvolvimento.

FAQ

Preciso manter o app desktop do Studio aberto para usar o Studio CLI? Não. O Studio CLI foi projetado para interagir com recursos do Studio pelo terminal independentemente de o Studio estar aberto.

Como aponto um comando para um diretório específico de site Studio? A maioria dos comandos assume que você os executa da raiz de um site gerenciado pelo Studio. Se não estiver, use a opção --path (por exemplo, studio preview create --path /path/to/site).

O que acontece se eu executar um comando de preview sem estar logado? Comandos que exigem autenticação (como studio preview create) retornarão um erro e o guiarão para fazer login.

Como encontro o nome do host do preview para atualizar/excluir? Execute studio preview list para exibir previews associados e seus valores de host. Use esse host com studio preview update <host> ou studio preview delete <host>.

De onde vem a informação de autenticação para studio auth login? O comando de login inicia um fluxo baseado em navegador para conectar o CLI à sua conta WordPress.com, depois fornece um token de autenticação que você cola no terminal para completar o processo.

Alternativas

• Fluxo manual na UI do Studio: Se você não precisa de automação no terminal, usar o aplicativo Studio diretamente pode cobrir a criação de previews e controle de sites locais sem integração com CLI.
• Ferramentas genéricas de linha de comando para WordPress (ex.: WP-CLI + scripts personalizados): Onde ambientes de preview específicos do Studio não são necessários, você pode combinar ferramentas de linha de comando do WordPress com seus próprios scripts para gerenciar tarefas de sites, embora hospedagem de previews e recursos específicos do Studio possam não ser cobertos.
• Outras abordagens de orquestração local para WordPress: Em vez dos comandos de gerenciamento de sites do Studio, você pode usar configurações locais diferentes para WordPress (containerizadas ou com scripts) e lidar com previews via etapas de deploy separadas, ao custo de perder o fluxo unificado do Studio CLI para preview/atualização/exclusão e sites gerenciados pelo Studio.