$ cubic run --help
Create and start VM instances
This command is a shortcut for the three subcommands `create`, `start` and `ssh`.
Examples:
Run a VM instance with 8 vCPUs, 10G of RAM, 200G of storage:
$ cubic run example1 --cpus 8 --memory 10G --disk 200G -i debian:trixie
Run a VM instance and forward the instance's HTTP port to the host port 8000:
$ cubic run example2 --port 8000:80 -i ubuntu:noble
Run a VM instance and forward the instance's DNS port to the host port 5353:
$ cubic run example3 --port 5353:53/udp -i ubuntu:noble
Run a VM instance with multiple port forwarding rules:
$ cubic run example4 -p 8000:80/tcp -p 5353:53/udp -i ubuntu:noble
Run a VM instance and install Vim:
$ cubic run example5 -e "sudo apt install -y vim" -i ubuntu:noble
Run a VM instance without network access:
$ cubic run example6 --isolate ubuntu:noble
Usage: cubic run [OPTIONS] --image <IMAGE> <INSTANCE_NAME>
Arguments:
<INSTANCE_NAME>
VM instance name (e.g. 'my-instance')
Options:
-i, --image <IMAGE>
VM image name (e.g. 'debian:trixie')
-u, --user <USER>
Username (default: 'cubic')
-c, --cpus <CPUS>
Number of vCPUs for the VM instance
[default: 4]
-m, --memory <MEMORY>
Memory amount of the VM instance
[default: 4G]
-d, --disk <DISK>
Disk size of the VM instance
[default: 100G]
-p, --port <PORT>
Forward ports from guest to host (e.g. -p 8000:80 or -p 9000:90/tcp)
-e, --execute <EXECUTE>
Execute a command once on the first boot (e.g. "sudo apt install ...")
--isolate
Isolate the VM instance from network
--env <KEY[=VALUE]>
Environment variables to pass to the guest (KEY=VALUE or KEY to forward from host)
-v, --verbose
Increase logging output
-q, --quiet
Reduce logging output
-h, --help
Print help (see a summary with '-h')