Créer des projets Lightbuild à partir de la ligne de commande

La CLI Lightbuild est l'outil de ligne de commande officiel pour Lightbuild. Utilisez la commande lightbuild pour compiler et tester votre projet, trouver ses cibles de compilation et résoudre ses dépendances. Vos agents IA peuvent exécuter les mêmes commandes. Les projets que vous créez à partir d'un modèle Lightbuild incluent un fichier AGENTS.md qui indique aux agents IA comment utiliser Lightbuild et la CLI Lightbuild.

Pour en savoir plus sur les commandes et les options de la CLI Lightbuild, consultez la documentation de référence de la CLI Lightbuild.

Installer la CLI Lightbuild

La CLI Lightbuild est distribuée sous la forme d'un package du SDK Android que vous installez avec la CLI Android. Vous pouvez l'installer et le configurer à l'aide d'une seule commande, ou l'installer manuellement.

Installer et configurer en une seule étape

Pour installer la CLI Lightbuild, exécutez la commande correspondant à votre système d'exploitation. La commande installe le package Lightbuild CLI dans votre SDK Android, puis exécute le script de configuration du package, qui copie Lightbuild CLI dans ~/.local/bin sur macOS et Linux, ou dans $HOME\AppData\LightbuildCLI sur Windows, et s'assure que ce répertoire se trouve dans votre PATH :

  • macOS et 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 (invite de commande) :

    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

Une fois la commande terminée, vérifiez l'installation.

Installer manuellement

Vous pouvez également installer la CLI Lightbuild et l'ajouter vous-même à votre PATH en procédant comme suit :

  1. Si vous n'avez pas installé la CLI Android, installez-la.

  2. Installez le package Lightbuild :

    android sdk install build/lightbuild/0.0.30

  3. Copiez la CLI Lightbuild dans un répertoire de votre PATH afin de pouvoir exécuter lightbuild depuis n'importe quel répertoire. Vous pouvez le copier dans n'importe quel répertoire déjà présent dans votre PATH ou utiliser le même répertoire que celui utilisé par le script de configuration :

    • macOS et Linux : copiez le fichier lightbuild dans ~/.local/bin :

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

      Si ~/.local/bin ne figure pas dans votre PATH, ajoutez la ligne suivante au fichier de démarrage de votre shell, par exemple ~/.zshrc ou ~/.bashrc :

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

    • Windows : exécutez les commandes suivantes dans PowerShell. Elles copient lightbuild.exe dans $HOME\AppData\LightbuildCLI, ajoutent ce répertoire à votre Path utilisateur s'il n'y figure pas déjà, puis appliquent la modification à votre session actuelle et aux terminaux que vous ouvrirez ultérieurement :

      $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. Vérifier l'installation

Vérifier l'installation

Pour vérifier que la CLI Lightbuild est installée, vérifiez sa version :

lightbuild --version

Si votre terminal ne trouve pas la commande lightbuild, ouvrez une nouvelle fenêtre de terminal pour que les modifications apportées à PATH prennent effet.

Rechercher les cibles de compilation de votre projet

Les commandes de la CLI Lightbuild acceptent une cible, qui identifie la partie de votre projet à compiler, tester ou inspecter. Une cible peut être le nom d'un module, tel que app, ou quelque chose de plus spécifique, tel que app:app-debug.apk. Pour faire correspondre toutes les cibles d'un module, utilisez le nom du module suivi de /..., par exemple app/.... Pour faire correspondre toutes les cibles de votre projet, utilisez ....

Pour lister toutes les cibles de votre projet, interrogez-les à partir du répertoire racine de votre projet :

lightbuild query ...

Pour lister les fichiers produits par une cible, ajoutez --output=files. Par exemple, pour la cible app, exécutez la commande suivante :

lightbuild query app --output=files

Pour lister les commandes disponibles pour votre projet, exécutez lightbuild help.

Concevoir votre application

Pour créer une cible, exécutez lightbuild build avec la cible. Par exemple, pour compiler le module app, exécutez la commande suivante :

lightbuild build app

Pour compiler toutes les cibles de votre projet, exécutez la commande suivante :

lightbuild build

Pour créer un app bundle de version signé que vous pouvez importer sur Google Play, consultez Publier votre application Lightbuild.

Pour supprimer le résultat de compilation et les caches de votre projet, exécutez la commande suivante :

lightbuild clean

Exécuter votre application

La CLI Lightbuild compile votre application, mais ne l'installe pas et ne l'exécute pas. Pour exécuter votre application sur un appareil connecté ou un émulateur en cours d'exécution, compilez l'application, puis exécutez-la avec la commande android run dans la CLI Android :

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

Pour voir où chacune des cibles d'un module écrit sa sortie, exécutez lightbuild query app/... --output=files. Les emplacements sont relatifs au répertoire du module.

Exécuter des tests

Pour exécuter tous les tests de votre projet, exécutez la commande suivante :

lightbuild test

Cette commande exécute vos tests locaux, qui s'exécutent sur votre ordinateur de développement, et vos tests d'instrumentation, qui s'exécutent sur un appareil connecté ou un émulateur en cours d'exécution.

Pour exécuter les tests dans un module, ajoutez la cible du module, par exemple app-core. Pour n'exécuter qu'un seul type de test, ajoutez :hostTest pour les tests locaux ou :deviceTest pour les tests d'instrumentation à la cible du module. Exemple :

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

Résoudre les dépendances

Chaque module enregistre ses dépendances résolues dans un fichier resolved.deps. Pour générer le fichier resolved.deps d'un module, exécutez lightbuild resolve avec la cible du module. Par exemple, pour le module app, exécutez :

lightbuild resolve app

Pour résoudre toutes les cibles de votre projet, exécutez la commande suivante :

lightbuild resolve

Pour en savoir plus, consultez Dépendances résolues.