Skip to content

Commit 1f0e0a4

Browse files
committed
Update README
1 parent f6b0c7f commit 1f0e0a4

File tree

1 file changed

+62
-1
lines changed

1 file changed

+62
-1
lines changed

README.md

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ You'll be prompted for:
2222
- The install path (default: `/opt/vume`)
2323
- The ZFS pool device (leave empty for file-backed dev mode; a real device/partition is recommended for production)
2424

25+
Vume requires root because it manages KVM virtual machines, ZFS datasets, and network interfaces (bridge, tap, iptables NAT).
26+
2527
If you install to a non-default path, set `VUME_HOME` in your shell profile:
2628

2729
```bash
@@ -61,6 +63,65 @@ All configuration is stored in `$VUME_HOME/vume.toml` (default: `/opt/vume/vume.
6163

6264
See `config/vume.toml` for default values.
6365

66+
## CLI Usage
67+
68+
All `vume` commands require root privileges.
69+
70+
### Start a VM
71+
72+
```bash
73+
sudo vume start # auto-generated ID
74+
sudo vume start --id my-vm # specific ID
75+
```
76+
77+
Running `start` with an existing stopped VM's ID will resume it.
78+
79+
### List VMs
80+
81+
```bash
82+
sudo vume list # all VMs
83+
sudo vume list --status running # filter by status (running, stopped, error)
84+
```
85+
86+
### Execute a command in a VM
87+
88+
```bash
89+
sudo vume exec my-vm "uname -a"
90+
sudo vume exec my-vm "apt install -y python3" --timeout 120
91+
```
92+
93+
### Manage background processes
94+
95+
```bash
96+
sudo vume process start my-vm my-server "python3 -m http.worker"
97+
sudo vume process stop my-vm my-server
98+
sudo vume process list my-vm
99+
sudo vume process logs my-vm my-server --lines 100
100+
```
101+
102+
### Stop / destroy VMs
103+
104+
```bash
105+
sudo vume stop my-vm # stop a running VM
106+
sudo vume destroy my-vm # remove a VM completely
107+
sudo vume destroy # destroy all VMs (with confirmation)
108+
```
109+
110+
### View configuration
111+
112+
```bash
113+
sudo vume config get vcpu
114+
sudo vume config get network.bridge
115+
sudo vume config path
116+
```
117+
118+
### Help
119+
120+
```bash
121+
vume --help
122+
vume <command> --help
123+
```
124+
64125
## Customizing the rootfs
65126

66127
You can create a custom base image from a running VM. The active rootfs version is tracked
@@ -69,7 +130,7 @@ affecting existing VMs.
69130

70131
```bash
71132
# 1. Customize a running VM, e.g.
72-
vume exec <vm-id> "apt install -y python3 nginx"
133+
sudo vume exec <vm-id> "apt install -y python3 nginx"
73134

74135
# 2. Snapshot the customized VM and create a new rootfs version
75136
sudo zfs snapshot vume/<vm-id>@<version>

0 commit comments

Comments
 (0)