Skip to content
Susant Sahani edited this page Oct 18, 2026 · 1 revision

Usage

All commands below appear in the repo README or docs/. Run zorvia --help and zorvia commands for the current syntax: since 0.4.0 the CLI uses nested subcommands (zorvia create became zorvia vm create).

First VM

zorvia profile show database
zorvia vm create prod-db --template ubuntu-22.04 --cpus 6 --memory 16Gi --disk-size 200Gi
zorvia vm start prod-db
zorvia guest wait-ready prod-db --timeout 120
zorvia vm status prod-db --watch
zorvia vm status                      # platform components + features

Blueprints (multi-VM stacks)

zorvia blueprint blueprints
zorvia blueprint deploy lamp --prefix myapp --start
zorvia vm list

Config files and templates

zorvia template validate examples/ubuntu-cloud-init.yaml
zorvia vm create my-vm --from-file examples/basic-vm.yaml
zorvia template generate web --template ubuntu --kubevirt -o web.yaml
zorvia config config-init && zorvia config config-show

Config file locations: ~/.config/zorvia/config.toml, /etc/zorvia/config.toml. Zorvia is also a Rust library (VMConfigBuilder); see docs/config-and-library.md.

Day-2 change gating

zorvia change drift and zorvia change plan (see docs/day-2-ops.md).

Web console and API

The console is served over HTTPS on NodePort 30152 (self-signed, use curl -sk) at /app. In-pod listen port is 5151.

curl -sk https://HOST:30152/api/v1/health | jq .
TOKEN=$(curl -sk -X POST https://HOST:30152/api/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"username":"admin","password":"..."}' | jq -r .token)
curl -sk -H "Authorization: Bearer $TOKEN" https://HOST:30152/api/vms | jq .
curl -sk -H "Authorization: Bearer $TOKEN" 'https://HOST:30152/api/audit/export?format=jsonl' | head

The lab admin password lives in the zorvia-auth Secret (see docs/LAB.md).

MCP for AI assistants (v0.7.0+, off by default)

Enable with ZORVIA_MCP_ENABLED=1 (Helm: mcp.enabled=true). Remote clients use POST /api/mcp; stdio clients use zorvia mcp:

claude mcp add --transport http zorvia https://HOST:30152/api/mcp --header "x-api-key: $ZORVIA_TOKEN"
export ZORVIA_URL=https://HOST:30152 ZORVIA_TOKEN=...
zorvia mcp --ca-cert ca.pem

Every tool call is replayed through the REST API with the caller's own token, so roles, namespace limits and audit apply. Use a scoped API token, not an admin login. See docs/MCP.md.

Importing from VMware (Experimental)

Needs ZORVIA_EXPERIMENTAL=1 and ZORVIA_H2KVM_IMAGE; h2kvm is licensed separately and not shipped. See docs/VM_IMPORT.md and Related-Projects.

Clone this wiki locally