Skip to content

CLI reference

CommandPurpose
runBoot an image and run a command, then tear down
createCreate a named, persistent workspace
startBoot a stopped workspace
stopGraceful shutdown
killHard terminate
deleteRemove a workspace and its state
statusShow workspace state
psList workspaces
logsShow boot/serial output
connectOpen the workspace console (Apple VF)
doctorCheck the host for backend support
rootfsBuild a rootfs from an OCI image
kernelInstall or verify a custom kernel
versionPrint the version
  • --json — print JSON output
  • --text — print human-readable output
  • --output <json|text> — select output format
  • --supervisor <path> — override the Apple VF supervisor path (MICROAGENT_APPLEVF_SUPERVISOR works too)

All commands return structured output. With --json (or MICROAGENT_OUTPUT=json), the response matches the shape documented in the Apple VF supervisor protocol. Scripts should consume JSON; humans get the text format by default.