Google Git
Sign in
android / device / google / cuttlefish / d8255ad4b70d82b793c03c9b752abbc57de83ce6
commitd8255ad4b70d82b793c03c9b752abbc57de83ce6[log] [tgz]
authorSeth Moore <[email protected]>Mon May 03 17:55:21 2021 +0000
committerGerrit Code Review <[email protected]>Mon May 03 17:55:21 2021 +0000
treea856c71ee3969a04d6a1a2d4aa9c3bdbcc653ee4
parentb098d990c8dae7c89b484de2c72265da46a9513b [diff]
parentd6bf520581f8795448665b8432d20618a4d40985 [diff]
Merge "Set Cuttlefish KeyMint message version"
tree: a856c71ee3969a04d6a1a2d4aa9c3bdbcc653ee4
  1. build/
  2. common/
  3. guest/
  4. host/
  5. recovery/
  6. shared/
  7. tests/
  8. tools/
  9. vsoc_arm64/
  10. vsoc_arm64_only/
  11. vsoc_arm_only/
  12. vsoc_x86/
  13. vsoc_x86_64/
  14. vsoc_x86_64_only/
  15. vsoc_x86_noapex/
  16. vsoc_x86_only/
  17. rustfmt.toml ⇨ ../../../build/soong/scripts/rustfmt.toml
  18. .clang-format
  19. Android.bp
  20. Android.mk
  21. AndroidProducts.mk
  22. CleanSpec.mk
  23. default-permissions.xml
  24. dtb.img
  25. fetcher.mk
  26. host_package.mk
  27. METADATA
  28. OWNERS
  29. PREUPLOAD.cfg
  30. README.md
  31. required_images
  32. TEST_MAPPING
README.md

Cuttlefish Getting Started

Try Cuttlefish

  1. Make sure virtualization with KVM is available.

     grep -c -w "vmx\|svm" /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_64_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_64_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_64_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!