Skip to main content
vee
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
Edit page

Command Reference

Complete reference for all vee commands.

VM lifecycle

CommandDescription
vee createCreate a new VM
vee startStart a VM
vee stopStop a running VM
vee deleteDelete a VM and its disks
vee autostartEnable or disable autostart for a VM
vee configEdit a VM’s configuration in a TUI

Inspect & monitor

CommandDescription
vee listList all VMs and their status
vee statusShow detailed VM status and guest info
vee checkRun health checks on an installed VM
vee ipPrint the VM’s IP address
vee portsList bound TCP ports inside a running VM
vee logsStream QEMU output
vee monitorReal-time CPU/memory/disk/network stats
vee dashboardStart a web dashboard for all VMs

Access

CommandDescription
vee sshOpen an SSH session
vee ssh-shareShare the host SSH agent into a VM via AF_VSOCK
vee tunnelForward a VM port to localhost via SSH
vee viewOpen the VM display (SPICE or GPU)
vee backupBack up guest directories to the host

Images

CommandDescription
vee pullDownload or build a base image into the cache
vee mirrorHost-side pacman caching proxy for Arch VMs

Advanced / infrastructure

CommandDescription
vee gpuManage GPU passthrough bindings
vee qmpSend a QMP command to a running VM
vee daemonRun the vee daemon (autostart supervision)
vee runnerManage self-hosted GitHub Actions runner VMs
vee versionPrint version, commit, and build date

Shell completion

vee ships Cobra-generated completions:

source <(vee completion bash)   # bash
source <(vee completion zsh)    # zsh
vee completion fish | source    # fish