Pular para o conteúdo principal

Playground CLI

@wp-playground/cli é uma ferramenta de linha de comando que simplifica o fluxo de desenvolvimento e teste do WordPress. O Playground CLI suporta auto-montagem de um diretório com um plugin, tema ou instalação WordPress. Mas se você precisa de flexibilidade, o CLI suporta comandos de montagem para personalizar seu ambiente local.

Principais recursos:

  • Configuração Rápida: Configure um ambiente WordPress local em segundos.
  • Flexibilidade: Permite configuração para se adaptar a diferentes cenários.
  • Ambiente Simples: Sem configuração extra, apenas uma versão Node compatível, e você está pronto para usar.

Requisitos​

O Playground CLI requer Node.js 20.18 ou superior, que é a versão recomendada de Suporte de Longo Prazo (LTS). Você pode baixá-la no site do Node.js.

Início Rápido​

Executar o Playground CLI é tão simples quanto ir para uma linha de comando e executar:

npx @wp-playground/cli@latest server

Playground CLI em Ação

Com o comando anterior, você obtém apenas uma instância WordPress fresca para testar. A maioria dos desenvolvedores quer ver seu trabalho rodando. Se este é o seu caso, teste um plugin ou tema. Você pode executar o CLI na pasta do seu projeto e executar o Playground CLI com a flag --auto-mount:

cd my-plugin-or-theme-directory
npx @wp-playground/cli@latest server --auto-mount

Escolhendo uma Versão do WordPress e PHP​

Por padrão, o CLI carrega a versão estável mais recente do WordPress e PHP 8.3 devido ao seu desempenho melhorado. Para especificar suas versões preferidas, você pode usar as flags --wp=<version> e --php=<version>:

npx @wp-playground/cli@latest server --wp=6.8 --php=8.4

Carregando Blueprints​

Uma maneira de levar sua experiência de desenvolvimento do Playground CLI para o próximo nível é integrar com Blueprints. Para aqueles não familiarizados com esta tecnologia, ela permite que desenvolvedores configurem o estado inicial para suas instâncias WordPress Playground.

Usando a flag --blueprint=<blueprint-address>, desenvolvedores podem executar um Playground com um estado inicial personalizado. Usaremos o exemplo abaixo para fazer isso.

(meu-blueprint.json)

{
  "landingPage": "/wp-admin/options-general.php?page=akismet-key-config",
  "login": true,
  "plugins": [
    "hello-dolly",
    "https://raw.githubusercontent.com/adamziel/blueprints/trunk/docs/assets/hello-from-the-dashboard.zip"
  ]
}

Comando CLI carregando um blueprint:

npx @wp-playground/cli@latest server --blueprint=my-blueprint.json

Montando pastas manualmente​

Alguns projetos têm uma estrutura específica que requer uma configuração personalizada; por exemplo, seu repositório contém todos os arquivos na pasta /wp-content/. Então neste cenário, você pode especificar ao Playground CLI que ele montará seu projeto a partir dessa pasta usando a flag --mount.

npx @wp-playground/cli@latest server --mount=.:/wordpress/wp-content/plugins/MY-PLUGIN-DIRECTORY

Montando antes da instalação do WordPress​

Considere montar seus arquivos de projeto WordPress antes da instalação do WordPress começar. Esta abordagem é benéfica se você quer sobrescrever o processo de inicialização do Playground, pois pode ajudar a conectar o Playground com WP-CLI. A flag --mount-before-install suporta este processo.

npx @wp-playground/cli@latest server --mount-before-install=.:/wordpress/
info

No Windows, o formato de caminho /host/path:/vfs/path pode causar problemas. Para resolver isso, use as flags --mount-dir e --mount-dir-before-install. Estas flags permitem que você especifique caminhos do host e do sistema de arquivos virtual em um formato alternativo "/host/path" "/vfs/path".

Comandos e Argumentos​

O Playground CLI é simples, configurável e sem opiniões. Você pode configurá-lo de acordo com sua configuração WordPress única. Com o Playground CLI, você pode usar os seguintes comandos de nível superior:

  • server: (Padrão) Inicia um servidor WordPress local.
  • run-blueprint: Executa um arquivo Blueprint sem iniciar um servidor web.
  • build-snapshot: Constrói um snapshot ZIP de um site WordPress baseado em um Blueprint.

O comando server suporta os seguintes argumentos opcionais:

  • --port=<port>: O número da porta para o servidor escutar. Padrão é 9400.
  • --outfile: Ao construir, escrever neste arquivo de saída.
  • --wp=<version>: A versão do WordPress a usar. Padrão é a mais recente.
  • --auto-mount: Montar automaticamente o diretório atual (plugin, tema, wp-content, etc.).
  • --mount=<mapping>: Montar manualmente um diretório (pode ser usado múltiplas vezes). Formato: "/host/path:/vfs/path".
  • --mount-before-install: Montar um diretório no runtime PHP antes da instalação do WordPress (pode ser usado múltiplas vezes). Formato: "/host/path:/vfs/path".
  • --mount-dir: Montar um diretório no runtime PHP (pode ser usado múltiplas vezes). Formato: "/host/path" "/vfs/path".
  • --mount-dir-before-install: Montar um diretório antes da instalação do WordPress (pode ser usado múltiplas vezes). Formato: "/host/path" "/vfs/path"
  • --blueprint=<path>: O caminho para um arquivo JSON Blueprint para executar.
  • --blueprint-may-read-adjacent-files: Flag de consentimento: Permitir que recursos "empacotados" em um blueprint local leiam arquivos no mesmo diretório do arquivo blueprint.
  • --login: Fazer login automaticamente do usuário como administrador.
  • --skip-wordpress-setup: Não baixar ou instalar WordPress. Útil se você está montando um diretório WordPress completo.
  • --skip-sqlite-setup: Não configurar a integração do banco de dados SQLite.
  • --verbosity: Saída de logs e mensagens de progresso. Opções são "quiet", "normal" ou "debug". Padrão é "normal".
  • --debug: Imprimir o log de erro do PHP se um erro ocorrer durante a inicialização.

Precisa de ajuda com o CLI?​

Com o Playground CLI, você pode usar --help para obter suporte sobre os comandos disponíveis.

npx @wp-playground/cli@latest --help