Tạo dự án Lightbuild từ dòng lệnh

Lightbuild CLI là công cụ dòng lệnh chính thức cho Lightbuild. Sử dụng lệnh lightbuild để tạo bản dựng và kiểm thử dự án, tìm mục tiêu bản dựng và giải quyết các phần phụ thuộc. Các tác nhân AI của bạn có thể chạy cùng một lệnh. Các dự án mà bạn tạo từ mẫu Lightbuild sẽ có một tệp AGENTS.md cho các tác nhân AI biết cách làm việc với Lightbuild và Lightbuild CLI.

Để biết thêm thông tin về các lệnh và tuỳ chọn của Lightbuild CLI, hãy xem Tài liệu tham khảo về Lightbuild CLI.

Cài đặt Lightbuild CLI

Lightbuild CLI được phân phối dưới dạng một gói SDK Android mà bạn cài đặt bằng Android CLI. Bạn có thể cài đặt và thiết lập bằng một lệnh duy nhất hoặc cài đặt theo cách thủ công.

Cài đặt và thiết lập trong một bước

Để cài đặt Lightbuild CLI, hãy chạy lệnh cho hệ điều hành của bạn. Lệnh này sẽ cài đặt gói Lightbuild CLI trong SDK Android, sau đó chạy tập lệnh thiết lập của gói. Tập lệnh này sẽ sao chép Lightbuild CLI vào ~/.local/bin trên macOS và Linux hoặc vào $HOME\AppData\LightbuildCLI trên Windows, đồng thời đảm bảo rằng thư mục đó nằm trong PATH:

  • macOS và 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 (Dấu nhắc lệnh):

    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

Sau khi lệnh hoàn tất, hãy xác minh quá trình cài đặt.

Cài đặt thủ công

Ngoài ra, để tự cài đặt Lightbuild CLI và thêm vào PATH, hãy làm theo các bước sau:

  1. Nếu bạn chưa có Android CLI, hãy cài đặt.

  2. Cài đặt gói Lightbuild:

    android sdk install build/lightbuild/0.0.30

  3. Sao chép Lightbuild CLI vào một thư mục trong PATH để bạn có thể chạy lightbuild từ bất kỳ thư mục nào. Bạn có thể sao chép tệp này vào bất kỳ thư mục nào đã có trong PATH hoặc sử dụng cùng một thư mục mà tập lệnh thiết lập sử dụng:

    • macOS và Linux: Sao chép tệp lightbuild vào ~/.local/bin:

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

      Nếu ~/.local/bin không có trong PATH, hãy thêm dòng sau vào tệp khởi động của shell, chẳng hạn như ~/.zshrc hoặc ~/.bashrc:

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

    • Windows: Chạy các lệnh sau trong PowerShell. Các lệnh này sao chép lightbuild.exe vào $HOME\AppData\LightbuildCLI, thêm thư mục đó vào Path của người dùng nếu chưa có, sau đó áp dụng thay đổi trong phiên hiện tại và trong các thiết bị đầu cuối mà bạn mở sau này:

      $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. Xác minh quá trình cài đặt

Xác minh quá trình cài đặt

Để xác minh rằng Lightbuild CLI đã được cài đặt, hãy kiểm tra phiên bản của công cụ này:

lightbuild --version

Nếu thiết bị đầu cuối của bạn không tìm thấy lệnh lightbuild, hãy mở một cửa sổ dòng lệnh mới để các thay đổi về PATH có hiệu lực.

Tìm mục tiêu bản dựng của dự án

Các lệnh Lightbuild CLI nhận một mục tiêu, xác định phần dự án cần tạo bản dựng, kiểm thử hoặc kiểm tra. Mục tiêu có thể là tên của mô-đun, chẳng hạn như app hoặc một tên cụ thể hơn, chẳng hạn như app:app-debug.apk. Để so khớp tất cả mục tiêu trong một mô-đun, hãy sử dụng tên của mô-đun, theo sau là /..., chẳng hạn như app/.... Để so khớp tất cả mục tiêu trong dự án, hãy sử dụng ....

Để liệt kê tất cả mục tiêu trong dự án, hãy truy vấn các mục tiêu đó từ thư mục gốc của dự án:

lightbuild query ...

Để liệt kê các tệp mà một mục tiêu tạo ra, hãy thêm --output=files. Ví dụ: đối với mục tiêu app, hãy chạy:

lightbuild query app --output=files

Để liệt kê các lệnh có sẵn cho dự án, hãy chạy lightbuild help.

Tạo ứng dụng

Để tạo một mục tiêu, hãy chạy lightbuild build với mục tiêu đó. Ví dụ: để tạo mô-đun app, hãy chạy:

lightbuild build app

Để tạo tất cả mục tiêu trong dự án, hãy chạy:

lightbuild build

Để tạo một gói ứng dụng phát hành có chữ ký mà bạn có thể tải lên Google Play, hãy xem bài viết Phát hành ứng dụng Lightbuild.

Để xoá kết quả bản dựng và bộ nhớ đệm của dự án, hãy chạy:

lightbuild clean

Chạy ứng dụng

Lightbuild CLI sẽ tạo ứng dụng nhưng không cài đặt hoặc chạy ứng dụng. Để chạy ứng dụng trên một thiết bị thông minh đã kết nối hoặc trình mô phỏng đang chạy, hãy tạo ứng dụng rồi chạy ứng dụng đó bằng lệnh android run trong Android CLI:

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

Để xem vị trí ghi kết quả của từng mục tiêu trong mô-đun, hãy chạy lệnh lightbuild query app/... --output=files. Vị trí tương ứng với thư mục của mô-đun.

Chạy chương trình kiểm thử

Để chạy tất cả các kiểm thử trong dự án, hãy chạy:

lightbuild test

Lệnh này chạy các kiểm thử cục bộ (chạy trên máy phát triển) và kiểm thử đo lường (chạy trên thiết bị thông minh đã kết nối hoặc trình mô phỏng đang chạy).

Để chạy các bài kiểm thử trong một mô-đun, hãy thêm mục tiêu của mô-đun, chẳng hạn như app-core. Để chỉ chạy một loại kiểm thử, hãy thêm :hostTest cho kiểm thử cục bộ hoặc :deviceTest cho kiểm thử đo lường vào mục tiêu của mô-đun. Ví dụ:

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

Giải quyết các phần phụ thuộc

Mỗi mô-đun ghi lại các phần phụ thuộc đã phân giải trong tệp resolved.deps. Để tạo tệp resolved.deps cho một mô-đun, hãy chạy lightbuild resolve với mục tiêu của mô-đun. Ví dụ: đối với mô-đun app, hãy chạy:

lightbuild resolve app

Để phân giải tất cả mục tiêu trong dự án, hãy chạy lệnh:

lightbuild resolve

Để biết thêm thông tin, hãy xem phần Phần phụ thuộc đã phân giải.