GuestKit

Offline VM intelligence. Migration assurance you can prove.

Score boot readiness before power-on. Generate reviewable fix plans. Repair disks offline. Certify cutover with a signed Passport — then hand off to hyper2kvm / HyperSDK.

Demos · Wiki · Feature guide · Quick start · GHCR · Docs · zyvor.dev

  disk.qcow2 / .vmdk / .vhdx
           │
           ▼
   ┌───────────────────┐     doctor 0–100     migrate-plan YAML
   │  Pure-Rust engine │ ──────────────────►  passport emit
   │  NBD/loop mount   │     rescue / plan apply (offline)
   └───────────────────┘
           │
     CLI · TUI · Python · Web · Agent

70+ commands · 6 disk formats · 0 libguestfs appliances · 8 migration targets · Apache-2.0

See it in action

Machina × GuestKit Live Linux guest agent — health, TRIM, netplan, services	CLI & TUI Offline VM intelligence, explained
Web Dashboard Tour Server Image Vault, live KubeVirt cluster	Web Dashboard Tutorial Sources, live cluster, one-click intelligence

Recorded live against real deployments — no staged screenshots.

Why teams use it

Pairs with: hyper2kvm for VMware → KVM. GuestKit certifies; hyper2kvm converts.

What you can do

Assurance before cutover

guestkit doctor vm.qcow2 --target proxmox --explain
guestkit migrate-plan vm.vmdk --target proxmox --export plan.yaml
guestkit passport emit vm.qcow2 --target kvm -o passport.json
guestkit passport verify passport.json --fail-below 80

Targets: kvm · proxmox · qemu · aws · azure · gcp · cloud · hyperv

GitHub Actions: gate conversion on the same score, no CLI install step — see action.yml and the runbook at docs/devops/01-passport-ci-gate.md.

- uses: hypersdk/guestkit@v1
  with:
    disk: vm.qcow2
    target: kvm
    fail-below: '80'

Offline repair (no boot required)

# Day-0 plans
guestkit plan generate win.qcow2 -p windows-rdp -o rdp.yaml
guestkit plan generate win.qcow2 -p windows-domain-leave --workgroup WORKGROUP
guestkit plan generate disk.qcow2 -p linux-ssh --user ubuntu --key-file ~/.ssh/id_ed25519.pub

# Rescue shortcuts
guestkit rescue disk.qcow2 -o enable-ssh
guestkit rescue disk.qcow2 -o fix-grub --force          # BIOS or UEFI ESP
guestkit rescue win.qcow2 -o reset-password --user Administrator --password '…'
# → AES/RC4 SAM NT-hash when registry-write is built; RunOnce fallback

guestkit plan apply plan.yaml --vm disk.qcow2 --yes     # backups + rollback

PackageInstall can stage from cache, host-fetch (GUESTKIT_PACKAGE_FETCH=1), or HTTP mirror (GUESTKIT_PACKAGE_MIRROR). Service enable/disable and CommandExec stage first-boot oneshots when chroot can’t run them live.

Live control + platform

• In-guest agent (Linux + Windows) over virtio-serial / QGA — inject offline, then agent-proxy / agent-call
• AI copilot (optional, --features ai) — read-only tool-calling loop over the offline evidence snapshot: doctor --explain --ai, migrate-plan --ai. Native tool-calling for OpenAI (rig-core), cross-run memory across repeated runs on the same VM, and an MCP server (guestkit mcp-serve, --features mcp) for external hosts like Claude Desktop. OpenAI/xAI/Anthropic/Ollama. Not the in-guest agent above — see AI Guest Agent roadmap
• KubeVirt boot-inspect hooks and Guest Control Fabric
• Web console + worker on GHCR; Helm chart under deploy/helm/zyvor
• Python: pip install hypersdk-guestkit → from guestkit import Guestfs

Full map: Customer Feature Guide (PDF) · Customer manuals

Quick start

cargo install guestkit          # installs guestkit + guestctl

guestkit doctor vm.qcow2 --target proxmox --explain
guestkit migrate-plan vm.vmdk --target proxmox --export plan.yaml
guestctl tui vm.qcow2           # Assurance · preview · export

Host needs: Linux with qemu-img, losetup, and qemu-nbd (mount/repair may need root).

Run from GHCR

Public images under ghcr.io/hypersdk — no docker login required.

docker compose -f deploy/docker-compose.ghcr.yml pull
docker compose -f deploy/docker-compose.ghcr.yml up -d
open http://localhost:8088

Eval only — unauthenticated stack. Do not expose beyond localhost.
Production: deploy/docker-compose.prod.example.yml · Docker guide · Helm

Default console login for packaged installs is documented in remote deploy — change it before any network exposure.

Platform layout

┌────────────────────────────────────────────────────────────┐
│  guestkit CLI · guestctl TUI · Python · Web · Agent        │
├────────────────────────────────────────────────────────────┤
│  Rust evidence engine · boot scoring · fix-plan apply      │
├────────────────────────────────────────────────────────────┤
│  JSON · YAML · HTML · PDF · Passport · CI exit codes       │
└────────────────────────────────────────────────────────────┘

Documentation

→ zyvor.dev/guestkit · Full Zyvor platform

Development

cargo build --release
cargo test

See CONTRIBUTING and CI under .github/workflows/. docs/ and this README are authoritative over any historical build notes in the tree.

License

Apache-2.0 · additional notes in docs/legal/ where applicable.