Skip to content
docs.microagent.sh

microagent doctor

microagent doctor [--arch <arch>] [--supervisor <path>]

doctor reports host support for the installed host backend and the default kernel status. Run it first when something isn’t working.

Use host when you want the same information as an inspectable capability report rather than a health check.

What it checks

Section titled “What it checks”
  • Apple VF (macOS): Virtualization.framework available, supervisor reachable, default kernel installed, interactive console available.
  • Firecracker (Linux): firecracker binary on PATH (or MICROAGENT_FIRECRACKER), /dev/kvm present, /dev/vhost-vsock present, /dev/net/tun present, pasta available for user-mode networking, unprivileged user namespaces enabled, default kernel installed, interactive console available.
  • Windows Hyper-V (experimental): Windows Host Compute Service available, Hyper-V / Windows Hypervisor Platform support available, HCS access allowed for the current user, HCN/HNS networking available, Hyper-V sockets available, default kernel installed, guest-init available, and HVSock console support available.

On Linux, run microagent doctor outside sandboxed agent environments so KVM visibility is honest. On Windows, run it from the same user account that will start workspaces. HCS access usually requires Administrator or membership in the Hyper-V Administrators group.

Flags

Section titled “Flags”
FlagDescription
--backend <name>Backend override (apple-vf, firecracker, or windows-hyperv)
--arch <arch>Guest architecture (amd64, arm64)
--supervisor <path>Override the installed host backend supervisor path
--jsonGlobal flag before doctor; print structured JSON output

Example

Section titled “Example”
Terminal window
microagent doctor
microagent --json doctor
Section titled “Related”