Lightbuild-Projekte über die Befehlszeile erstellen

Die Lightbuild-Befehlszeile ist das offizielle Befehlszeilentool für Lightbuild. Verwenden Sie den Befehl lightbuild, um Ihr Projekt zu erstellen und zu testen, die Build-Ziele zu finden und die Abhängigkeiten aufzulösen. Ihre KI-Agenten können dieselben Befehle ausführen. Projekte, die Sie aus einer Lightbuild-Vorlage erstellen, enthalten eine AGENTS.md-Datei, die KI-Agenten mitteilt, wie sie mit Lightbuild und der Lightbuild-CLI arbeiten sollen.

Weitere Informationen zu den Befehlen und Optionen der Lightbuild-Befehlszeile finden Sie in der Referenz zur Lightbuild-Befehlszeile.

Lightbuild-Befehlszeile installieren

Die Lightbuild-Befehlszeile wird als Android SDK-Paket bereitgestellt, das Sie mit der Android-Befehlszeile installieren. Sie können ihn mit einem einzigen Befehl installieren und einrichten oder manuell installieren.

In einem Schritt installieren und einrichten

Führen Sie den Befehl für Ihr Betriebssystem aus, um die Lightbuild CLI zu installieren. Mit dem Befehl wird das Lightbuild-CLI-Paket in Ihrem Android SDK installiert. Anschließend wird das Setupskript des Pakets ausgeführt, das die Lightbuild-CLI unter macOS und Linux nach ~/.local/bin oder unter Windows nach $HOME\AppData\LightbuildCLI kopiert und dafür sorgt, dass sich dieses Verzeichnis in Ihrem PATH befindet:

  • macOS und 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 (Eingabeaufforderung):

    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"

Prüfen Sie die Installation, nachdem der Befehl ausgeführt wurde.

Manuell einbinden

So installieren Sie die Lightbuild-Befehlszeile und fügen sie selbst zu Ihrer PATH hinzu:

  1. Wenn Sie die Android-Befehlszeile nicht haben, installieren Sie sie.

  2. Installieren Sie das Lightbuild-Paket:

    android sdk install build/lightbuild/0.0.30

  3. Kopieren Sie die Lightbuild-Befehlszeile in ein Verzeichnis in Ihrem PATH, damit Sie lightbuild von jedem Verzeichnis aus ausführen können. Sie können sie in ein beliebiges Verzeichnis kopieren, das sich bereits in Ihrem PATH befindet, oder dasselbe Verzeichnis verwenden, das das Setupscript verwendet:

    • macOS und Linux: Kopieren Sie die Datei lightbuild nach ~/.local/bin:

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

      Wenn ~/.local/bin nicht in Ihrer PATH enthalten ist, fügen Sie der Startdatei Ihrer Shell, z. B. ~/.zshrc oder ~/.bashrc, die folgende Zeile hinzu:

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

    • Windows: Führen Sie die folgenden Befehle in PowerShell aus. Sie kopieren lightbuild.exe nach $HOME\AppData\LightbuildCLI und fügen dieses Verzeichnis Ihrem Nutzer-Path hinzu, falls es noch nicht vorhanden ist:

      $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. Installation prüfen

Installation überprüfen

Prüfen Sie, ob die Lightbuild-Befehlszeile installiert ist, indem Sie die Version abfragen:

lightbuild --version

Wenn Ihr Terminal den Befehl lightbuild nicht finden kann, öffnen Sie ein neues Terminalfenster, damit die Änderungen an PATH wirksam werden.

Build-Ziele Ihres Projekts finden

Lightbuild-CLI-Befehle verwenden ein Ziel, das den Teil Ihres Projekts identifiziert, der erstellt, getestet oder geprüft werden soll. Ein Ziel kann der Name eines Moduls sein, z. B. app, oder etwas Spezifischeres, z. B. app:app-debug.apk. Wenn Sie alle Ziele in einem Modul abgleichen möchten, verwenden Sie den Namen des Moduls gefolgt von /..., z. B. app/.... Verwenden Sie ..., um alle Ziele in Ihrem Projekt abzugleichen.

Wenn Sie alle Ziele in Ihrem Projekt auflisten möchten, fragen Sie sie im Stammverzeichnis Ihres Projekts ab:

lightbuild query ...

Fügen Sie --output=files hinzu, um die Dateien aufzulisten, die ein Ziel erzeugt. Führen Sie beispielsweise für das Ziel app Folgendes aus:

lightbuild query app --output=files

Führen Sie lightbuild help aus, um die für Ihr Projekt verfügbaren Befehle aufzulisten.

App erstellen

Führen Sie lightbuild build mit dem Ziel aus, um ein Ziel zu erstellen. Führen Sie beispielsweise Folgendes aus, um das Modul app zu erstellen:

lightbuild build app

Führen Sie folgenden Befehl aus, um alle Ziele in Ihrem Projekt zu erstellen:

lightbuild build

Führen Sie den folgenden Befehl aus, um die Build-Ausgabe und die Caches Ihres Projekts zu entfernen:

lightbuild clean

App ausführen

Die Lightbuild-Befehlszeile erstellt Ihre App, installiert sie aber nicht und führt sie auch nicht aus. Wenn Sie Ihre App auf einem verbundenen Gerät oder einem laufenden Emulator ausführen möchten, erstellen Sie die App und führen Sie sie dann mit dem Befehl android run in der Android-Befehlszeile aus:

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

Führen Sie lightbuild query app/... --output=files aus, um zu sehen, wohin die einzelnen Ziele eines Moduls ihre Ausgabe schreiben. Die Speicherorte sind relativ zum Verzeichnis des Moduls.

Tests ausführen

Führen Sie den folgenden Befehl aus, um alle Tests in Ihrem Projekt auszuführen:

lightbuild test

Mit diesem Befehl werden Ihre lokalen Tests, die auf Ihrer Entwicklungsmaschine ausgeführt werden, und Ihre Instrumentierungstests, die auf einem verbundenen Gerät oder einem laufenden Emulator ausgeführt werden, ausgeführt.

Wenn Sie die Tests in einem Modul ausführen möchten, fügen Sie das Ziel des Moduls hinzu, z. B. app-core. Wenn Sie nur einen Testtyp ausführen möchten, fügen Sie dem Ziel des Moduls :hostTest für lokale Tests oder :deviceTest für Instrumentierungstests hinzu. Beispiel:

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

Abhängigkeiten auflösen

Jedes Modul zeichnet seine aufgelösten Abhängigkeiten in einer resolved.deps-Datei auf. Führen Sie lightbuild resolve mit dem Ziel des Moduls aus, um die Datei resolved.deps für ein Modul zu generieren. Führen Sie beispielsweise für das Modul app Folgendes aus:

lightbuild resolve app

Führen Sie folgenden Befehl aus, um alle Ziele in Ihrem Projekt aufzulösen:

lightbuild resolve

Weitere Informationen finden Sie unter Aufgelöste Abhängigkeiten.