Google Git
Sign in
android / device / google / cuttlefish / d5d3c1f65c0b64bca47bf07f7509c7d8f6b0071e
commitd5d3c1f65c0b64bca47bf07f7509c7d8f6b0071e[log] [tgz]
authorA. Cody Schuffelen <[email protected]>Tue Aug 11 18:54:14 2020 -0700
committerA. Cody Schuffelen <[email protected]>Thu Aug 13 16:20:16 2020 -0700
treef2e3abcf0719a85823cb6faec64e101b0e3bf87b
parentdf606da7c84caef6d7c010b6dca37162d04e2b12 [diff]
Add more information to the README, and improve formatting

 - Virtualization check
 - GCE nested virtualization guide
 - Clarified the relationship between the dpkg and apt commands
 - Added a reminder to reboot

Test: Validated that the `dpkg || apt` command works
Change-Id: Id5ffc411bc649e1de12ef1b3107fc8ff921d0ed2
1 file changed
tree: f2e3abcf0719a85823cb6faec64e101b0e3bf87b
  1. common/
  2. guest/
  3. host/
  4. recovery/
  5. shared/
  6. tests/
  7. tools/
  8. vsoc_arm64/
  9. vsoc_arm64_only/
  10. vsoc_x86/
  11. vsoc_x86_64/
  12. vsoc_x86_64_only/
  13. vsoc_x86_noapex/
  14. Android.bp
  15. Android.mk
  16. AndroidProducts.mk
  17. CleanSpec.mk
  18. dtb.img
  19. fetcher.mk
  20. host_package.mk
  21. METADATA
  22. OWNERS
  23. README.md
  24. required_images
  25. TEST_MAPPING
README.md

Cuttlefish Getting Started

Try Cuttlefish

  1. Make sure virtualization with KVM is available.

     grep -cw vmx /proc/cpuinfo

    This should return a non-zero value. If running on a cloud machine, this may take cloud-vendor-specific steps to enable. For Google Compute Engine specifically, see the GCE guide.

  2. Download, build, and install the host debian package:

    git clone https://github.com/google/android-cuttlefish
cd android-cuttlefish
debuild -i -us -uc -b
sudo dpkg -i ../cuttlefish-common_*_amd64.deb || sudo apt-get install -f
sudo reboot

    The reboot will trigger installing additional kernel modules and applying udev rules.

  3. Go to http://ci.android.com/

  4. Enter a branch name. Start with aosp-master if you don‘t know what you’re looking for

  5. Navigate to aosp_cf_x86_phone and click on userdebug for the latest build

  6. Click on Artifacts

  7. Scroll down to the OTA images. These packages look like aosp_cf_x86_phone-img-xxxxxx.zip -- it will always have img in the name. Download this file

  8. Scroll down to cvd-host_package.tar.gz. You should always download a host package from the same build as your images.

  9. On your local system, combine the packages:

    mkdir cf
cd cf
tar xvf /path/to/cvd-host_package.tar.gz
unzip /path/to/aosp_cf_x86_phone-img-xxxxxx.zip

  10. Launch cuttlefish with:

$ HOME=$PWD ./bin/launch_cvd

  1. Stop cuttlefish with:

$ HOME=$PWD ./bin/stop_cvd

Debug Cuttlefish

You can use adb to debug it, just like a physical device:

$ ./bin/adb -e shell

Launch Viewer

You can use the TightVNC JViewer. Once you have downloaded the TightVNC Java Viewer JAR in a ZIP archive, run it with

$ java -jar tightvnc-jviewer.jar -ScalingFactor=50 -Tunneling=no -host=localhost -port=6444

Click “Connect” and you should see a lock screen!