Skip to main content

Using the Dashboard

GuestKit ships CLI, TUI, and an open-source web Image Vault (deploy/ui / GHCR zyvor-ui) over the same zyvor-api + guestkit-worker engine.

Surfaces​

SurfaceHow to open
CLIguestkit <cmd> / guestctl <cmd>
TUIguestctl tui IMAGE (aliases: guestkit tui, guestkit ui)
Interactive REPLguestkit interactive IMAGE
File explorer (CLI)guestkit explore IMAGE [/path]
Web Image VaultGHCR compose → http://<host>:8088 · or ./scripts/deploy-ui-remote.sh (HTTPS lab)

Web Image Vault (OSS zyvor-ui)​

Import a disk into the vault, then run the assure loop from the browser. The detail workspace mirrors TUI inventory + Assurance panes.

Ops (Live API)​

ButtonAPINotes
InspectPOST /api/v1/vms/:id/inspectFills Summary / Packages / Services / Users / Network / Storage / Kernel / Security
DoctorPOST /api/v1/vms/:id/doctorBoot score on Assurance
Migration planPOST /api/v1/vms/:id/migration-planRequired changes + download JSON
PassportPOST /api/v1/vms/:id/passportDownload passport JSON
Repair previewPOST /api/v1/vms/:id/repair-plan?dry_run=trueOps list (read-only)
Apply repairsame route dry_run=falseGated confirm in Assurance pane — mutates the vault disk
ProfilesPOST /api/v1/vms/:id/profileSecurity/compliance findings + severity filter
Provision YAMLPOST /api/v1/vms/:id/provisionKubeVirt manifests download
Browse filesPOST /api/v1/vms/:id/exploreRead-only ls / cat (worker guestkit.explore)

Offline mode: paste doctor JSON or load demo-doctor.json / demo-inspect.json.

Lab HTTPS UI (no nginx)​

./scripts/deploy-ui-remote.sh <host> <user> --port 27173 \
--api-upstream http://127.0.0.1:8080
# → https://<host>:27173/

Compose / Helm still use GHCR zyvor-ui (nginx) on :8088 — see DOCKER.md.

TUI keys (Assurance)​

KeyAction
dDoctor
tCycle migration target
pPreview plan
eExport plan
:Command palette
h / ?Help

Browse vs act​

Inspect / doctor / export / explore / profile are safe reads. Repair apply, plan apply, and rescue mutate disks — shut down the guest, dry-run first, keep a backup.