distros/skills/qemu-guest-agent/SKILL.md
QEMU guest agent for host-guest communication in virtual machines. Use when working with QEMU/KVM VMs, guest agent setup, or libvirt channel configuration.
npx skillsauth add overthinkos/overthink-plugins qemu-guest-agentInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
| Property | Value |
|----------|-------|
| Install files | charly.yml |
qemu-guest-agent -- QEMU guest agent daemon. The package name is identical on
Arch/CachyOS (pac) and Fedora (rpm), so the top-level package: covers both
— this is a cross-distro candy, not RPM-only.The candy exposes the complete guest-agent surface — guest-exec,
guest-file-*, guest-fsfreeze-*, guest-set-*. The package default blocks no
RPCs; the candy's /etc/qemu/qemu-ga.conf makes that explicit and turns on the
fsfreeze hook (the one capability not active by default), so the host can take
application-consistent snapshots. The hook is a standard dispatcher
(/etc/qemu/fsfreeze-hook) that runs every executable in
/etc/qemu/fsfreeze-hook.d/ with freeze/thaw; drop per-app scripts there.
The candy also enables the qemu-guest-agent.service (system scope) and
contributes the virtio-serial channel (below). On a kind: vm entity the channel
is usually declared structurally instead — channels: [{type: unix, name: org.qemu.guest_agent.0}] (see /charly-internals:libvirt-renderer).
# charly.yml -- add to a bootc image's layer list
my-vm-image:
bootc: true
candy:
- qemu-guest-agent
# or applied to a VM guest at deploy time:
# charly bundle add vm:<name> qemu-guest-agent
Composed into bootc images directly, or applied to a VM guest at deploy time (charly bundle add vm:<name> qemu-guest-agent).
The candy contributes a raw libvirt XML snippet that the libvirt renderer places in the VM's <devices> section:
<channel type='unix'>
<target type='virtio' name='org.qemu.guest_agent.0'/>
</channel>
Emitted in charly.yml as:
libvirt:
snippets:
- "<channel type='unix'><target type='virtio' name='org.qemu.guest_agent.0'/></channel>"
This is the / classification case: isDeviceElement flags it as device-scoped, so the renderer injects it inside <devices> rather than before </domain>. See /charly-internals:libvirt-renderer for the injection pipeline and /charly-vm:vm for the QEMU-user-net caveat (the agent shows as enabled/inactive under charly's QEMU backend; libvirt backend activates it).
/charly-coder:sshd -- SSH server (commonly paired in bootc/VM images)Use when the user asks about:
org.qemu.guest_agent.0 channel/charly-image:layer — candy authoring reference (charly.yml schema, task verbs, service declarations, libvirt.snippets:)/charly-vm:vm — VM lifecycle; bootc VM caveats; QEMU-user-net limitation/charly-vm:vms-catalog — kind: vm entity schema that consumes this candy's contribution/charly-internals:libvirt-renderer — renderer that injects this candy's snippet into <devices>/charly-check:check — declarative testing (check: block, charly check box, charly check live)tools
Use when authoring or modifying a charly PLUGIN — a candy with a `plugin:` block that contributes Providers (verbs/kinds/deploy-targets/steps/builders/commands), its own CUE schema, builtin (compiled-in) or external (out-of-tree git repo). Covers the unified Provider model, the per-plugin CUE-schema contract (single source → Go params for dev + schema-over-Describe RPC for runtime), the SDK, and the loader.
tools
The CUE data-validation / configuration CLI (cue), pinned to v0.16.1. Use when working with the cue candy, installing the cue binary into a box or onto a target:local dev host, or running the offline schema-vendoring pipeline that feeds charly's egress validation.
tools
CUE EGRESS validation — validating (and, where it adds value, generating) the config files charly WRITES to a system BEFORE the bytes hit disk. MUST be invoked before working on charly/egress.go, the vendored schemas under candy/plugin-egress/egress-schemas/vendor/, the ValidateEgress / registerVendoredEgressKind path, the offline `task cue:vendor` pipeline, or adding an egress schema for any written artifact (cloud-init, k8s manifests, traefik routes, runtime config, install ledger, systemd/quadlet units, ssh_config, libvirt XML).
tools
Kubernetes cluster-probe declarative check verb — the `kube:` check verb (nodes, pods, ingress, storage class, addon health, apply/delete, and arbitrary resource GETs) served out-of-process by the candy/plugin-kube plugin (vendored client-go; no external kubectl required).