Getting Started with GuestKit
Offline VM intelligence — inspect disks without booting, score boot readiness, and produce hypervisor-aware fix plans.
What you need
| Requirement | Notes |
|---|---|
| Linux host | qemu-img / losetup / qemu-nbd (qemu-utils) |
| Disk image | qcow2 / vmdk / raw (guest shut down for writes) |
| Optional UI | :8088 zyvor-ui via GHCR compose |
1. Install
curl -fsSL -O https://github.com/zyvorai/guestkit/releases/download/v1.2.5/guestkit-1.2.5-linux-amd64.tar.gz
# crates.io `guestkit` is still 0.3.2
qemu-img --version
guestkit version
2. First doctor run
guestkit doctor /path/to/disk.qcow2 --target kvm --explain
Optional TUI: guestctl tui /path/to/disk.qcow2.
3. Orient yourself
- Onboarding — Getting Started, CLI Guide, Interactive Mode, TUI
- Inspection — Inspect, Filesystems, Packages, Network, Files
- Assurance — Doctor, Migration Plan, Policy, Passport, Fleet
- Fix — Fix Plans, Repair / Rescue
Next steps
- Using the Dashboard (TUI / optional web)
- Admin basics
- Common workflows
- Page guides