CLI do Studio

Este texto foi traduzido usando IA. Se você deseja ver o texto original em inglês, clique aqui.

O Studio CLI é um utilitário de linha de comando disponível globalmente que permite interagir com os recursos do WordPress Studio a partir do seu terminal, independentemente de o Studio estar aberto ou não.

Ele é especialmente útil para:

• Gerenciar sites locais do Studio.
• Criar e atualizar sites de prévia no WordPress.com.
• Executar comandos WP-CLI.
• Integrar com agentes de codificação por IA. Cada site vem com um arquivo AGENTS.md.
• Integrar o Studio em scripts e etapas de build.

Instalação

1. Abra o aplicativo “WordPress Studio”.
2. No menu principal, abra o modal de Configurações. Você também pode clicar no ícone de engrenagem no canto superior direito do aplicativo.
3. Ative a opção “Studio CLI” e clique em Salvar.
4. No macOS, será solicitada a senha da sua conta para permitir a instalação.

Uso

O Studio CLI é invocado com o comando studio. Todos os comandos seguem o padrão:

studio <area> <command> [options]

Você pode ver uma visão geral a qualquer momento com:

studio --help

A maioria dos comandos foi projetada para ser executada a partir do diretório raiz de um site gerenciado pelo Studio. Para direcionar um diretório de site diferente do seu diretório de trabalho atual, use a opção --path:

studio <area> <command> --path /path/to/site

Comandos de autenticação

Use os comandos auth para gerenciar sua autenticação no WordPress.com para recursos do Studio que exigem um usuário que efetuou login (por exemplo, sites de prévia).

studio auth login      # Log in to WordPress.com
studio auth logout     # Log out and clear WordPress.com authentication
studio auth status     # Check authentication status

• studio auth login abre um fluxo no navegador para conectar o CLI à sua conta do WordPress.com. Você receberá um token de autenticação para colar no terminal e concluir o processo de login.
• studio auth status informa se você está autenticado no momento e mostra qual conta está em uso.
• studio auth logout desconecta o CLI da sua conta do WordPress.com e limpa as credenciais armazenadas.

Se você executar um comando que requer autenticação (como studio preview create) enquanto estiver com logout efetuado, a CLI retornará um erro e orientará você a fazer login.

Use a flag --help para ver opções detalhadas de qualquer comando de autenticação:

studio auth --help
studio auth login --help

Comandos de site de prévia

Sites de prévia são ambientes temporários e compartilháveis hospedados no WordPress.com que espelham seu site local do Studio. Use-os para compartilhar trabalhos com colegas de equipe ou partes interessadas sem a necessidade de um ambiente local.

studio preview create          # Create a preview site
studio preview list            # List preview sites
studio preview update <host>   # Update an existing preview site
studio preview delete <host>   # Delete a preview site

Criando um site de prévia

A partir da raiz do seu site local do Studio:

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

Isso irá:

• Compilar e enviar seu site local para um ambiente de prévia.
• Retornar uma URL de prévia que você pode compartilhar com outras pessoas.
• Exigir que você tenha efetuado login com studio auth login.

Você também pode especificar um diretório de site explicitamente:

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

Listando sites de prévia

Para visualizar todos os sites de prévia associados à sua conta:

studio preview list

Isso mostra o host de cada prévia (por exemplo, example-preview.wpcomstaging.com), que você usará com os comandos update e delete.

Atualizando e excluindo sites de prévia

Cada site de prévia é identificado pelo seu nome de host:

# Rebuild and redeploy changes from your local site to the preview site:
studio preview update <host>

# Permanently remove a preview site:
studio preview delete <host>

Use studio preview list para descobrir o valor apropriado de <host> caso você não o tenha em mãos.

Para o conjunto completo de opções:

studio preview --help
studio preview create --help
studio preview update --help
studio preview delete --help

Comandos de gerenciamento de site local

Use os comandos site para gerenciar sites locais do Studio na sua máquina: criando, iniciando, parando, listando e configurando-os.

studio site status    # Get status of local site
studio site create    # Create a new local site
studio site list      # List local sites
studio site start     # Start local site
studio site stop      # Stop local site(s)
studio site delete    # Delete local site
studio site set       # Configure site settings

Criando um site local

Você pode executar o comando create a partir de um diretório vazio ou de um diretório que já contenha os arquivos de um site WordPress, mas que ainda não esteja listado no Studio.

Para criar um novo site local gerenciado pelo Studio:

# Create a new site in the current working directory, using all the default options
studio site create

# Create a new site with a custom domain and HTTPS
studio site create --https --domain hello.wp.local

# Create a new site in a different directory
studio site create --path /path/to/site

Isso criará um novo site no seu diretório de trabalho atual, iniciará o servidor WordPress e abrirá o wp-admin no seu navegador automaticamente quando finalizar.

Existem várias flags suportadas que você pode usar ao criar um novo site. Para ver o conjunto completo de opções:

studio site create --help

Criando um site local usando a Galeria de Blueprints

O Studio oferece acesso à Galeria de Blueprints, onde você pode escolher e ativar blueprints para criar um site. A Galeria de Blueprints também está disponível através do CLI. Os comandos para trabalhar com blueprints são:

# Show all available blueprints for creating a local Studio site
studio blueprint list

# Create a local site with selected blueprint
studio blueprint use <blueprint-slug> --name "<site-name>"

Listando e inspecionando sites

# Show all local sites known to Studio:
studio site list

# Show details and current status for the site in the current directory:
studio site status

# Or explicitly for a given path:
studio site status --path /path/to/site

A saída de status inclui informações como:

• Se o site está em execução.
• URL local (por exemplo, http://localhost:PORT).
• Detalhes importantes de configuração (versão do PHP, status do banco de dados, etc.).

Iniciando e parando sites

# From inside a site directory:
studio site start
studio site stop

# Or by path:
studio site start --path /path/to/site
studio site stop --path /path/to/site

Iniciar um site vai executar os serviços locais necessários para acessá-lo em um navegador, enquanto pará-lo encerra esses serviços.

Excluindo um site local

# Delete a site from Studio
studio site delete

# Delete the site and move the site directory to the system trash
studio site delete --files

Isso remove o site do Studio e, opcionalmente, os arquivos do site do disco.

Configurando as definições do site

Use studio site set para ajustar as configurações de um site local específico.

studio site set [options]

Exemplos do que pode ser feito com este comando incluem:

• Alterar a versão do PHP ou a versão do WordPress.
• Ajustar o domínio local ou a porta.
• Ativar ou desativar recursos que afetam o funcionamento do ambiente local.

Para ver a lista completa de opções configuráveis, execute:

studio site set --help

Usando o WP-CLI pelo Studio

O comando studio wp dá acesso ao WP-CLI dentro do contexto de um site gerenciado pelo Studio, sem a necessidade de instalar ou configurar o WP-CLI separadamente.

studio wp [<wp-cli-command>] [<wp-cli-arguments>...]

Exemplos (execute a partir do diretório raiz do seu site):

# Check WordPress version:
studio wp core version

# List installed plugins:
studio wp plugin list

# Run database upgrades:
studio wp core update-db

Pontos importantes:

• Você não precisa de uma instalação separada do WP-CLI; o Studio fornece e configura tudo para você.
• Variáveis de ambiente, caminhos e credenciais são definidos automaticamente com base no site selecionado, garantindo que os comandos operem no banco de dados e nos arquivos corretos.
• Você pode usar --path se não estiver no diretório do site:

  studio wp plugin list --path /path/to/site

Para uma lista completa dos subcomandos e argumentos suportados do WP-CLI, consulte a documentação do WP-CLI ou execute:

studio wp help
studio wp help <command>

Usando o Studio CLI com agentes de codificação com IA

O Studio CLI funciona muito bem com ferramentas e agentes de desenvolvimento assistidos por IA, como Claude Code, Cursor e outras extensões de IDE que podem executar comandos de terminal em seu nome.

Como essas ferramentas podem ver os arquivos do seu projeto e executar comandos no terminal, elas podem:

• Detectar que você está trabalhando em um projeto WordPress gerenciado pelo Studio.
• Executar comandos studio automaticamente para gerenciar sites locais, prévias e tarefas do WP-CLI.
• Usar a saída dos comandos para orientar alterações de código ou etapas de depuração adicionais.

Fluxos de trabalho típicos com agentes de IA

Abaixo estão algumas formas práticas de combinar o Studio CLI com um agente de codificação com IA.

1. Criando e gerenciando um site local

Você pode instruir seu agente de IA a criar e executar um site WordPress local via Studio. Por exemplo, no seu editor:

“Configure um novo site WordPress local usando a versão 8.2 do PHP com o Studio nesta pasta, inicie-o e me informe a URL local.”

Nos bastidores, o agente pode executar:

studio site create --php 8.2
studio site start
studio site status

Isso é útil quando:

• Você está prototipando rapidamente um novo plugin ou tema.
• Você está iniciando em um projeto existente e quer que o agente configure o ambiente para você.

2. Depuração automatizada e operações com WP-CLI

Quando o agente sugere uma correção ou alteração, ele também pode executar verificações usando studio wp:

# Run database upgrades:
studio wp core update-db

# Check for current plugins:
studio wp plugin list

Você pode perguntar:

“Execute as verificações de WP-CLI que você precisar pelo Studio para diagnosticar por que o site está retornando um erro 500 e, em seguida, proponha correções.”

O agente pode, de forma iterativa:

1. Executar comandos studio wp para coletar diagnósticos.
2. Atualizar código ou configuração.
3. Reexecutar comandos para verificar a correção.

3. Criando e atualizando sites de prévia para revisão

Os agentes podem ajudar você a configurar e manter ambientes de prévia vinculados à sua branch ou funcionalidade:

“Crie um site de prévia para este projeto e me forneça a URL compartilhável. Depois, após cada alteração de código, atualize a mesma prévia.”

O que se traduz em:

studio auth login              # if needed
studio preview create          # initial deployment
studio preview update <host>   # after subsequent changes

Isso é particularmente útil quando:

• Compartilhar o progresso com partes interessadas não técnicas.
• Colaborar com colegas de equipe que precisam ver o comportamento ao vivo sem configurar um ambiente local.

Boas práticas ao usar agentes de IA com o Studio CLI

• Permaneça na raiz de um site Studio: Muitos comandos assumem que o diretório atual é um site gerenciado pelo Studio. Lembre seu agente de usar cd para entrar na pasta correta ou de usar --path.
• Seja explícito nas instruções: Ao dar instruções a um agente, mencione “use o CLI do studio” e quaisquer restrições, por exemplo:
  • “Não exclua sites existentes.”
  • “Peça confirmação antes de executar migrações de banco de dados.”
  • “Execute apenas comandos studio wp somente leitura.”
• Revise operações destrutivas: Comandos como studio site delete e studio preview delete podem remover ambientes. Peça ao agente para mostrar os comandos que planeja executar antes de executá-los.
• Use a autenticação de forma deliberada: Para comandos que exigem acesso ao WordPress.com (studio auth login, studio preview ...), certifique-se de que você está confortável com o agente iniciando fluxos de login e confirme qual conta está sendo usada.

Ao combinar o Studio CLI com agentes de codificação com IA, você pode delegar grande parte da configuração repetitiva de ambientes, testes e orquestração de implantação, e focar mais em escrever e revisar seu código WordPress.

Obtendo ajuda

Todos os comandos e subcomandos suportam --help para documentação inline, uso e opções disponíveis. Por exemplo:

studio --help
studio auth --help
studio preview create --help
studio site start --help
studio site set --help
studio wp help

Esta é a melhor maneira de explorar as funcionalidades da versão específica do Studio CLI que você tem instalada.