Как создавать проекты Lightbuild из командной строки

Lightbuild CLI – это официальный инструмент командной строки для Lightbuild. Используйте команду lightbuild, чтобы создать и протестировать проект, найти его цели сборки и разрешить зависимости. Ваши ИИ-агенты могут выполнять те же команды. Проекты, созданные на основе шаблона Lightbuild, включают файл AGENTS.md, который сообщает ИИ-агентам, как работать с Lightbuild и Lightbuild CLI.

Дополнительную информацию о командах и параметрах Lightbuild CLI можно найти в справочнике по Lightbuild CLI.

Установите Lightbuild CLI

Lightbuild CLI распространяется как пакет Android SDK, который устанавливается с помощью Android CLI. Вы можете установить и настроить его с помощью одной команды или вручную.

Установка и настройка за один шаг

Чтобы установить Lightbuild CLI, выполните команду для своей операционной системы. Эта команда устанавливает пакет Lightbuild CLI в Android SDK, а затем запускает скрипт настройки пакета, который копирует Lightbuild CLI в ~/.local/bin на macOS и Linux или в $HOME\AppData\LightbuildCLI на Windows и проверяет, что этот каталог находится в PATH:

  • macOS и 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" }

  • Windows (командная строка):

    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"

После выполнения команды проверьте установку.

Установка вручную

Чтобы установить Lightbuild CLI и добавить его в PATH, выполните следующие действия:

  1. Если у вас нет Android CLI, установите его.

  2. Установите пакет Lightbuild:

    android sdk install build/lightbuild/0.0.30

  3. Скопируйте Lightbuild CLI в каталог в PATH, чтобы вы могли запускать lightbuild из любого каталога. Вы можете скопировать его в любой каталог, который уже есть в PATH, или использовать тот же каталог, что и скрипт настройки:

    • macOS и Linux. Скопируйте файл lightbuild в ~/.local/bin:

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

      Если ~/.local/bin нет в PATH, добавьте следующую строку в файл запуска оболочки, например ~/.zshrc или ~/.bashrc:

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

    • Windows. Выполните следующие команды в PowerShell: Они копируют lightbuild.exe в $HOME\AppData\LightbuildCLI и добавляют этот каталог в пользовательскую переменную Path, если ее там ещё нет.

      $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 = [Environment]::GetEnvironmentVariable("Path", "User")
if (($userPath -split ";") -notcontains $dir) { [Environment]::SetEnvironmentVariable("Path", "$userPath;$dir", "User") }

  4. Проверка правильности установки

Проверьте установку

Чтобы убедиться, что Lightbuild CLI установлен, проверьте его версию:

lightbuild --version

Если терминал не может найти команду lightbuild, откройте новое окно терминала, чтобы изменения в PATH вступили в силу.

Как найти целевые платформы проекта

Команды Lightbuild CLI принимают цель, которая определяет часть проекта для сборки, тестирования или проверки. Целью может быть название модуля, например app, или что-то более конкретное, например app:app-debug.apk. Чтобы сопоставить все цели в модуле, используйте название модуля, за которым следует /..., например app/.... Чтобы сопоставить все цели в проекте, используйте ....

Чтобы получить список всех целей в проекте, выполните запрос из корневого каталога проекта:

lightbuild query ...

Чтобы получить список файлов, созданных целью, добавьте --output=files. Например, для цели app выполните следующую команду:

lightbuild query app --output=files

Чтобы посмотреть список команд, доступных для вашего проекта, выполните lightbuild help.

Создайте приложение

Чтобы создать цель, запустите lightbuild build с целью. Например, чтобы собрать модуль app, выполните следующую команду:

lightbuild build app

Чтобы создать все цели в проекте, выполните следующую команду:

lightbuild build

Чтобы удалить выходные данные сборки и кеш проекта, выполните следующую команду:

lightbuild clean

Запуск приложения

Lightbuild CLI собирает приложение, но не устанавливает и не запускает его. Чтобы запустить приложение на подключенном устройстве или в работающем эмуляторе, соберите его, а затем выполните команду android run в Android CLI:

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

Чтобы узнать, куда записываются выходные данные каждой цели модуля, выполните команду lightbuild query app/... --output=files. Местоположения указываются относительно каталога модуля.

Запустить тесты

Чтобы запустить все тесты в проекте, выполните следующую команду:

lightbuild test

Эта команда запускает локальные тесты на компьютере для разработки и инструментальные тесты на подключенном устройстве или в запущенном эмуляторе.

Чтобы запустить тесты в одном модуле, добавьте цель модуля, например app-core. Чтобы запустить только один тип теста, добавьте :hostTest для локальных тестов или :deviceTest для инструментальных тестов в целевой объект модуля. Пример:

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

Разрешение зависимостей

Каждый модуль записывает свои разрешенные зависимости в файл resolved.deps. Чтобы создать файл resolved.deps для модуля, запустите lightbuild resolve с целевым объектом модуля. Например, для модуля app выполните следующую команду:

lightbuild resolve app

Чтобы разрешить все цели в проекте, выполните следующую команду:

lightbuild resolve

Подробнее о разрешенных зависимостях…