Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

vmctl

The main entry point for the vmctl CLI.

Synopsis

vmctl <COMMAND>

Commands

CommandDescription
createCreate a new VM
startStart an existing VM
stopStop a running VM
destroyDestroy a VM and clean up resources
listList all VMs
statusShow detailed VM status
consoleAttach to serial console
sshSSH into a VM
suspendSuspend (pause) a running VM
resumeResume a suspended VM
imageManage VM images
upBring up VMs from VMFile.kdl
downBring down VMs from VMFile.kdl
reloadDestroy and recreate VMs from VMFile.kdl
provisionRe-run provisioners from VMFile.kdl
logShow VM logs

Environment Variables

VariableDescription
RUST_LOGControl log verbosity (e.g., RUST_LOG=debug vmctl up)
XDG_DATA_HOMEOverride data directory (default: ~/.local/share)