From box to badge, in four steps.
The deploy script handles version bumps, hash-cache pruning, free-space guards, and secrets generation. You hold the BOOT button, you wait, you tap A.
- 01
Flash MicroPython
Download the ESP32-S3 build, hold the BOOT button, flash via esptool. Two-minute job.
- 02
Clone the OS
`git clone https://github.com/elixpo/oreo` and copy `.env.example` → `.env` with your WiFi credentials.
- 03
Deploy
`python tools/deploy.py` — pushes everything over USB, skips unchanged files, bumps the version.
- 04
Install the oreo CLI
Run the installer from the oreo CLI docs (it checks the release's SHA-256 and installs with pipx or uv), then `oreo` opens the full-screen view. To send photos and documents, open Tools > Transfer on the badge, run `oreo send <files>` and type the code the badge shows.
Need help?
Run oreo doctor first: it checks the cable, port, permissions and firmware and ends with next steps (see troubleshooting). Still stuck? Open an issue with its output and the console log from oreo logs --restart.