Criar projetos do Lightbuild na linha de comando

A CLI do Lightbuild é a ferramenta de linha de comando oficial do Lightbuild. Use o comando lightbuild para criar e testar seu projeto, encontrar os destinos de build e resolver as dependências. Seus agentes de IA podem executar os mesmos comandos. Os projetos criados com um modelo do Lightbuild incluem um arquivo AGENTS.md que informa aos agentes de IA como trabalhar com o Lightbuild e a CLI do Lightbuild.

Para mais informações sobre os comandos e as opções da CLI do Lightbuild, consulte a referência da CLI do Lightbuild.

Instalar a CLI do Lightbuild

A CLI do Lightbuild é distribuída como um pacote do SDK do Android que você instala com a CLI do Android. É possível instalar e configurar o agente com um único comando ou manualmente.

Instalar e configurar em uma única etapa

Para instalar a CLI do Lightbuild, execute o comando do seu sistema operacional. O comando instala o pacote da CLI do Lightbuild no SDK do Android e executa o script de configuração do pacote, que copia a CLI do Lightbuild para ~/.local/bin no macOS e no Linux ou para $HOME\AppData\LightbuildCLI no Windows, além de garantir que esse diretório esteja no PATH:

  • macOS e Linux:

    android sdk install build/lightbuild/0.0.30 && bash "$(android info sdk)/build/lightbuild/0.0.30/cli/install.sh"

  • Windows (PowerShell):

    android sdk install build/lightbuild/0.0.30; if ($LASTEXITCODE -eq 0) { & "$(android info sdk)\build\lightbuild\0.0.30\cli\install.cmd" }; if ($LASTEXITCODE -eq 0) { $env:Path += ";$HOME\AppData\LightbuildCLI"; setx LIGHTBUILD_REFRESH 1 | Out-Null; reg delete HKCU\Environment /v LIGHTBUILD_REFRESH /f | Out-Null }

  • Windows (prompt de comando):

    android sdk install build/lightbuild/0.0.30 && for /f "delims=" %p in ('android info sdk') do call "%p\build\lightbuild\0.0.30\cli\install.cmd" && setx LIGHTBUILD_REFRESH 1 >nul && reg delete HKCU\Environment /v LIGHTBUILD_REFRESH /f >nul

Depois que o comando for concluído, verifique a instalação.

Instalar manualmente

Como alternativa, para instalar a CLI do Lightbuild e adicioná-la ao PATH, siga estas etapas:

  1. Se você não tiver a CLI do Android, faça a instalação.

  2. Instale o pacote do Lightbuild:

    android sdk install build/lightbuild/0.0.30

  3. Copie a CLI do Lightbuild para um diretório no seu PATH para poder executar lightbuild em qualquer diretório. É possível copiá-lo para qualquer diretório que já esteja no PATH ou usar o mesmo diretório que o script de configuração usa:

    • macOS e Linux: copie o arquivo lightbuild para ~/.local/bin:

      mkdir -p ~/.local/bin
cp "$(android info sdk)/build/lightbuild/0.0.30/cli/lightbuild" ~/.local/bin/

      Se ~/.local/bin não estiver em PATH, adicione a seguinte linha ao arquivo de inicialização do shell, como ~/.zshrc ou ~/.bashrc:

      export PATH="$PATH:$HOME/.local/bin"

    • Windows: execute os comandos a seguir no PowerShell. Eles copiam lightbuild.exe para $HOME\AppData\LightbuildCLI, adicionam esse diretório ao Path do usuário, se ainda não estiver lá, e fazem com que a alteração entre em vigor na sessão atual e nos terminais que você abrir mais tarde:

      $dir = "$HOME\AppData\LightbuildCLI"
New-Item -ItemType Directory -Force $dir | Out-Null
Copy-Item "$(android info sdk)\build\lightbuild\0.0.30\cli\lightbuild.exe" $dir
$userPath = (Get-ItemProperty HKCU:\Environment).Path
if (($userPath -split ";") -notcontains $dir) { Set-ItemProperty HKCU:\Environment Path "$userPath;$dir" -Type ExpandString }
setx LIGHTBUILD_REFRESH 1 | Out-Null; reg delete HKCU\Environment /v LIGHTBUILD_REFRESH /f | Out-Null
$env:Path += ";$dir"

  4. Verificar a instalação

Verifique a instalação

Para verificar se a CLI do Lightbuild está instalada, confira a versão dela:

lightbuild --version

Se o terminal não encontrar o comando lightbuild, abra uma nova janela do terminal para que as mudanças em PATH entrem em vigor.

Encontrar os destinos de build do projeto

Os comandos da CLI do Lightbuild usam um destino, que identifica a parte do projeto a ser criada, testada ou inspecionada. Um destino pode ser o nome de um módulo, como app, ou algo mais específico, como app:app-debug.apk. Para corresponder a todos os destinos em um módulo, use o nome do módulo seguido por /..., como app/.... Para corresponder a todos os destinos no projeto, use ....

Para listar todos os destinos no projeto, consulte-os no diretório raiz do projeto:

lightbuild query ...

Para listar os arquivos produzidos por um destino, adicione --output=files. Por exemplo, para o destino app, execute:

lightbuild query app --output=files

Para listar os comandos disponíveis para seu projeto, execute lightbuild help.

Criar o app

Para criar um destino, execute lightbuild build com o destino. Por exemplo, para criar o módulo app, execute:

lightbuild build app

Para criar todos os destinos no projeto, execute:

lightbuild build

Para criar um pacote de apps de lançamento assinado que pode ser enviado ao Google Play, consulte Publicar seu app do Lightbuild.

Para remover a saída de build e os caches do projeto, execute:

lightbuild clean

Executar o aplicativo

A CLI do Lightbuild cria o app, mas não o instala nem o executa. Para executar o app em um dispositivo conectado ou em um emulador em execução, crie o app e execute-o com o comando android run na CLI do Android:

lightbuild build app
android run --apks=app/build/app-debug.apk

Para ver onde cada um dos destinos de um módulo grava a saída, execute lightbuild query app/... --output=files. Os locais são relativos ao diretório do módulo.

Executar testes

Para executar todos os testes no projeto, execute:

lightbuild test

Esse comando executa os testes locais, que são executados na máquina de desenvolvimento, e os testes de instrumentação, que são executados em um dispositivo conectado ou em um emulador em execução.

Para executar os testes em um módulo, adicione o destino do módulo, como app-core. Para executar apenas um tipo de teste, adicione :hostTest para testes locais ou :deviceTest para testes de instrumentação ao destino do módulo. Exemplo:

lightbuild test app-core:hostTest
lightbuild test app-core:deviceTest

Resolver dependências

Cada módulo registra as dependências resolvidas em um arquivo resolved.deps. Para gerar o arquivo resolved.deps de um módulo, execute lightbuild resolve com o destino do módulo. Por exemplo, para o módulo app, execute:

lightbuild resolve app

Para resolver todos os destinos no projeto, execute:

lightbuild resolve

Para mais informações, consulte Dependências resolvidas.