Getting Started

This section walks you through getting Beetroot running on your host machine — from installing system dependencies to booting your first research Android instance.

Steps

1. Prerequisites — Linux host, Docker, kernel modules, uv, ADB.
2. Installation — uv tool install git+https://github.com/Xiddoc/Beetroot.git, then beetroot build to build the base image. (If you're hacking on Beetroot itself, see CLAUDE.md for the editable uv sync workflow.)
3. Your First Instance — create → up → shell → down end-to-end.

If you've already done the one-time setup and want to spin up a second environment, jump straight to the Guides section.