cli-volar.md

November 5, 2025 · View on GitHub

Source: internal/cli/standard.

Global flag

--api, -a: base URL for volantd (default from VOLANT_API_BASE or http://127.0.0.1:7777)

version — print CLI version
vms — manage microVMs
- list — list VMs
- get — show details
- create
  [flags] — create a VM
  - --image
  - --runtime
  - --cpu
  - --memory
  - --env KEY=VALUE (repeatable) — set environment variables
  - --expose [HOST_PORT:]CONTAINER_PORT[:PROTOCOL] (repeatable) — Docker-style port mapping
  - --no-expose — disable all port exposure (secure by default)
  - --kernel-cmdline
  - --config
  - --api-host / --api-port
  - --device (repeatable)
  - --device-allowlist (repeatable)
- delete
- start
- stop
- restart
- scale [--cpu N] [--memory MB] [--restart] | for deployments: --replicas N
- config
  - get [--raw] [--output file]
  - set --file
  - history [--limit N]
- console [--socket ] — attach to serial socket
- operations — list operations from the VM’s image OpenAPI
- call [--query k=v] [--body '{}'] [--body-file file] [--timeout 60s]
images — manage engine images
- list
- show
- enable
- disable
- install [--manifest | --url <http(s)>] (positional arg allowed)
- remove
deployments — manage VM groups
- list
- create --config [--replicas N]
- get [--output file]
- delete
- scale
setup — configure host networking and service (Linux)
- Flags: --bridge, --subnet, --host-ip, --dry-run, --runtime-dir, --log-dir, --service-file, --work-dir, --bzimage, --vmlinux