A chapter-by-chapter tour of yolo, in reading order.
- Getting started — install, first run, what
yoloactually does the first time you invoke it. - Daily usage — common flows, one-off commands, named VMs, working with several at once, full CLI reference.
- Configuration — environment variables, CLI flags, CPU/memory/disk sizing.
- Provisioners — built-in language provisioners,
auto-detection from
$PWD, adding your own, optional AI agents. - Yolofile reference — the per-project
Yolofileformat: front matter, body, re-provisioning, precedence. - Networking — default NAT behaviour vs.
YOLO_ALLOW=MITM allow-list mode and its TLS caveats. - Export & import — snapshot a VM's rootfs and state, restore it on another host.
- Troubleshooting — KVM permissions, missing
matchlock, broken auto-heal, dangling state, MITM cert errors. - Backends — pick between matchlock (microVM) and podman (containers, GUI apps), capability matrix, how the abstraction is wired together.
Task-focused recipes for specific setups:
- Podman on matchlock — run Podman inside a matchlock microVM (container-complete guest kernel + privileged mode).
For internals (auto-heal algorithm, state file layout, provisioner markers, project source layout) see architecture.md.