Lightbuild CLI 是 Lightbuild 的官方指令列工具。使用 lightbuild 指令建構及測試專案、找出建構目標,以及解析依附元件。AI 代理也能執行相同指令。從 Lightbuild 範本建立的專案包含 AGENTS.md 檔案,可指示 AI 代理如何使用 Lightbuild 和 Lightbuild CLI。
如要進一步瞭解 Lightbuild CLI 的指令和選項,請參閱 Lightbuild CLI 參考資料。
安裝 Lightbuild CLI
Lightbuild CLI 是以 Android SDK 套件的形式發布,您可以使用 Android CLI 安裝。您可以使用單一指令安裝及設定,也可以手動安裝。
只要一個步驟就能完成安裝和設定
如要安裝 Lightbuild CLI,請依據您的作業系統執行對應指令。這個指令會在 Android SDK 中安裝 Lightbuild CLI 套件,然後執行套件的設定指令碼,將 Lightbuild CLI 複製到 macOS 和 Linux 上的 ~/.local/bin,或 Windows 上的 $HOME\AppData\LightbuildCLI,並確保該目錄位於 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,請按照下列步驟操作:
- 如果沒有 Android CLI,請安裝。
安裝 Lightbuild 套件:
android sdk install build/lightbuild/0.0.30將 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/如果
PATH中沒有~/.local/bin,請在殼層的啟動檔案 (例如~/.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") }
驗證安裝
如要確認是否已安裝 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 CLI 中使用 android run 指令執行:
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
詳情請參閱「已解析的依附元件」。
為您推薦
- 注意:系統會在 JavaScript 關閉時顯示連結文字
- Lightbuild CLI 參考資料
- 開始使用 Lightbuild
- Lightbuild 設定參考資料