CLI Reference
Complete command reference for the Volt CLI (v0.3.0).
Host Setup & Lifecycle
| Command | Description |
|---|
volt init | Initialize the Volt environment on this host — config, data directories, the voltbr0 bridge (10.10.0.0/16) with NAT, and systemd unit templates. Idempotent; safe to re-run. |
volt compat | Host readiness preflight — checks kernel, systemd-nspawn, cgroup v2, overlayfs, user namespaces, iptables, and KVM (for VMs). |
volt compat image <ref> | Check whether an OCI/Docker image converts cleanly to a signed Volt manifest. |
volt uninstall | Remove Volt from this host. Data at /var/lib/volt is preserved unless you pass --purge. |
volt version | Show the Volt version. |
Container Commands
| Command | Description |
|---|
volt run | Create and start a container |
volt ps | List running containers |
volt stop <name> | Stop a container |
volt rm <name> | Remove a stopped container |
volt logs <name> | View container logs |
volt exec <name> <cmd> | Execute a command in a running container |
volt inspect <name> | Show detailed container information |
VM Commands
| Command | Description |
|---|
volt vm create | Create a new microVM |
volt vm start <name> | Start a VM |
volt vm stop <name> | Stop a VM |
volt vm list | List all VMs |
volt vm snapshot <name> | Create a VM snapshot |
volt vm restore <name> | Restore from snapshot |
Image Commands
| Command | Description |
|---|
volt image list | List local images |
volt image pull <ref> | Pull an image from a registry |
volt image rm <ref> | Remove a local image |
volt image inspect <ref> | Show image details |
Compose Commands
| Command | Description |
|---|
volt compose up | Start services defined in a compose file |
volt compose down | Stop and remove compose services |
volt compose ps | List compose services |
System Commands
| Command | Description |
|---|
volt system info | Show system information and capabilities |
volt security audit | Audit security configuration |
volt version | Show Volt version |
Common Flags
| Flag | Description |
|---|
-n, --name | Workload name |
-p, --port | Port mapping (host:container) |
-v, --volume | Volume mount (host:container) |
-e, --env | Environment variable |
--memory | Memory limit (e.g., 256M, 1G) |
--cpus | CPU limit (e.g., 0.5, 2) |
-d, --detach | Run in background |