สร้างโปรเจ็กต์ Lightbuild จากบรรทัดคำสั่ง

Lightbuild CLI เป็นเครื่องมือบรรทัดคำสั่งอย่างเป็นทางการสำหรับ Lightbuild ใช้คำสั่ง lightbuild เพื่อสร้างและทดสอบโปรเจ็กต์ ค้นหาเป้าหมายบิลด์ และแก้ไขทรัพยากร Dependency AI Agent ของคุณสามารถเรียกใช้คำสั่งเดียวกันได้ โปรเจ็กต์ที่คุณสร้างจากเทมเพลต Lightbuild จะมีไฟล์ AGENTS.md ที่บอก AI Agent ถึงวิธีทำงานกับ 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" }; 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 (Command Prompt):

    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
    

หลังจากคำสั่งเสร็จสิ้น ให้ยืนยันการติดตั้ง

ติดตั้งด้วยตนเอง

หรือหากต้องการติดตั้ง 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 ให้เพิ่มบรรทัดต่อไปนี้ลงในไฟล์เริ่มต้นของ Shell เช่น ~/.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 = (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. ยืนยันการติดตั้ง

ยืนยันการติดตั้ง

หากต้องการยืนยันว่าติดตั้ง 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

หากต้องการสร้าง App Bundle ของแอปเวอร์ชันที่เผยแพร่ซึ่งรับรองแล้วซึ่งคุณสามารถอัปโหลดไปยัง Google Play ได้ โปรดดูหัวข้อเผยแพร่แอป Lightbuild

หากต้องการนำเอาต์พุตบิลด์และแคชของโปรเจ็กต์ออก ให้เรียกใช้คำสั่งต่อไปนี้

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

แก้ไขทรัพยากร Dependency

แต่ละโมดูลจะบันทึกทรัพยากร Dependency ที่แก้ไขแล้วในไฟล์ resolved.deps หากต้องการสร้างไฟล์ resolved.deps สำหรับโมดูล ให้เรียกใช้ lightbuild resolve โดยมีเป้าหมายเป็นโมดูล เช่น สำหรับโมดูล app ให้เรียกใช้คำสั่งต่อไปนี้

lightbuild resolve app

หากต้องการแก้ไขเป้าหมายทั้งหมดในโปรเจ็กต์ ให้เรียกใช้คำสั่งต่อไปนี้

lightbuild resolve

ดูข้อมูลเพิ่มเติมได้ที่ทรัพยากร Dependency ที่แก้ไขแล้ว