Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.58 KB

File metadata and controls

33 lines (27 loc) · 1.58 KB

yolo documentation

A chapter-by-chapter tour of yolo, in reading order.

  1. Getting started — install, first run, what yolo actually does the first time you invoke it.
  2. Daily usage — common flows, one-off commands, named VMs, working with several at once, full CLI reference.
  3. Configuration — environment variables, CLI flags, CPU/memory/disk sizing.
  4. Provisioners — built-in language provisioners, auto-detection from $PWD, adding your own, optional AI agents.
  5. Yolofile reference — the per-project Yolofile format: front matter, body, re-provisioning, precedence.
  6. Networking — default NAT behaviour vs. YOLO_ALLOW= MITM allow-list mode and its TLS caveats.
  7. Export & import — snapshot a VM's rootfs and state, restore it on another host.
  8. Troubleshooting — KVM permissions, missing matchlock, broken auto-heal, dangling state, MITM cert errors.
  9. Backends — pick between matchlock (microVM) and podman (containers, GUI apps), capability matrix, how the abstraction is wired together.

Cookbook

Task-focused recipes for specific setups:

  1. 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.