GuestKit
Offline VM intelligence and migration assurance.
Inspect QCOW2, VMDK, and RAW images without powering them on. Score boot probability, generate hypervisor-aware fix plans, and explore disks from a carbon-themed TUI — pure Rust, no libguestfs appliance.
┌──────────────────────────────────────────────────────────────┐
│ Interfaces guestkit CLI · guestctl TUI · Python bindings │
├──────────────────────────────────────────────────────────────┤
│ Engine Pure Rust disk parser · boot scoring · fixes │
├──────────────────────────────────────────────────────────────┤
│ Outputs JSON · YAML · HTML · PDF · CI gate artifacts │
└──────────────────────────────────────────────────────────────┘
Why GuestKit
| Problem | GuestKit answer |
|---|---|
| "Will it boot?" answered at power-on | Offline doctor score before cutover |
| guestfish scripts don't scale | Structured assurance APIs + exports |
| Migration surprises cost weekends | Fix plans with driver injections |
| Fleet drift is invisible | fleet analyze and forensic diff |
| No VM boot for deep inspection | Carbon TUI explores partitions in place |
Pairs with: hyper2kvm for VMware → KVM pipelines.
Platform at a Glance
| Layer | What's in the repo |
|---|---|
| Core | Pure Rust disk engine — crates/, src/ |
| CLI | guestkit + guestctl — doctor, migrate-plan, fleet |
| TUI | Carbon-themed multi-view dashboard |
| Python | hypersdk-guestkit on PyPI |
| K8s | KubeVirt integration hooks — k8s/ |
| Web stack | Prebuilt GHCR images — ghcr.io/hypersdk/{zyvor-ui,zyvor-api,guestkit-worker} |
| Deploy | Docker/Helm, remote deploy scripts — deploy/ |
Quick Start
cargo install guestkit # guestkit + guestctl
guestkit doctor vm.qcow2 --target proxmox --explain
# → boot probability · blockers · root-cause chain
guestkit migrate-plan vm.vmdk --target proxmox --export plan.yaml
# → migration score · driver injections · fix plan
guestctl tui vm.qcow2
# → carbon TUI · Assurance · fix-plan preview
| Scenario | Path |
|---|---|
| Getting started | docs/user-guides/getting-started.md |
| CLI reference | docs/user-guides/cli-guide.md |
| Migration assurance | docs/features/migration-assurance.md |
| CE vs Enterprise | docs/ce-vs-enterprise.md |
Web console: packaged installs seed a default admin — admin / Admin@321. Change it on first login (see remote deploy).
Run from GHCR (prebuilt images)
The web stack is published to the GitHub Container Registry under ghcr.io/hypersdk — public images, no docker login required.
| Image | Role |
|---|---|
ghcr.io/hypersdk/zyvor-ui |
Web console + login |
ghcr.io/hypersdk/zyvor-api |
API backend |
ghcr.io/hypersdk/guestkit-worker |
Disk-inspection worker |
Tags: latest, vX.Y.Z (e.g. v0.3.13), per-commit SHA. Bring the whole stack up straight from GHCR:
docker compose -f deploy/docker-compose.ghcr.yml pull
docker compose -f deploy/docker-compose.ghcr.yml up -d
open http://localhost:8088 # web console
For clusters, use the Helm chart. Full details: docs/guides/DOCKER.md → Published images.
Three Commands Before Cutover
| Command | Outcome |
|---|---|
guestkit doctor |
Boot probability + blockers |
guestkit migrate-plan |
Executable fix plan YAML |
guestctl tui |
Interactive assurance workspace |
Documentation
| Goal | Document |
|---|---|
| Docs index | docs/README.md |
| Run from GHCR / Docker | docs/guides/DOCKER.md |
| Remote deploy | docs/guides/DEPLOY-REMOTE.md |
| User stories | docs/USER_STORIES.md |
| Architecture | docs/architecture/overview.md |
| Full index | docs/INDEX.md |
→ zyvor.dev/guestkit · Demo video
Zyvor Platform Stack
| Product | Role |
|---|---|
| hypercluster | Bare-metal Kubernetes bootstrap |
| machina | Physical hypervisor OS (libvirt/KVM) |
| zeus-os | Cloud / KubeVirt control plane |
| hermes | Application layer for Kubernetes |
| forge | AI infrastructure on Kubernetes |
| hypersdk / hyper2kvm | Multi-cloud VM migration |
| guestkit | Offline VM migration assurance |
| packetwolf | Kernel-native network intelligence |
| Aether | Universal runtime portability |
| Veyron | KubeVirt VM command center |
| IronWolf | Metal3 bare-metal automation |
| zyvor-fabric | systemd-native private cloud |
Development
See project docs for CI, testing, and contribution guidelines. Historical build summaries in the repo root are snapshots — docs/ and this README are authoritative.
License
See LICENSE or project-specific licensing files in docs/legal/.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hypersdk_guestkit-0.3.14-cp311-cp311-manylinux_2_39_x86_64.whl.
File metadata
- Download URL: hypersdk_guestkit-0.3.14-cp311-cp311-manylinux_2_39_x86_64.whl
- Upload date:
- Size: 1.8 MB
- Tags: CPython 3.11, manylinux: glibc 2.39+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
maturin/1.14.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
33233b5c4edbd0a60697dfaedc16418d471cdf011f1e826692cb94526cdee50c
|
|
| MD5 |
5034edfa5426715f387f0391c493d3c5
|
|
| BLAKE2b-256 |
9ed1bab5943dd125a3cbfb2d2e2a172383122c427fd10eeb3d860a4c4ebd96c8
|
