$ cubic run --help
Create and start a VM instance
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
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
Run a VM instance with multiple port forwarding rules:
$ cubic run example4 -p 8000:80/tcp -p 5353:53/udp -i ubuntu:latest
Run a VM instance and install Vim:
$ cubic run example5 -e "sudo apt install -y vim" -i ubuntu
Run a VM instance without network access:
$ cubic run example6 --isolate -i ubuntu
Run a VM instance and delete it when you exit:
$ cubic run --rm example7 -i debian:trixie
Every distribution has the tags latest and stable. The tag latest is the
newest release and the tag stable is the newest long term release. A plain
name is a shortcut for stable, so --image ubuntu gives you the last LTS.
Usage: cubic run [OPTIONS] <INSTANCE>
Arguments:
<INSTANCE>
Name of the virtual machine instance
Options:
-t, --template <TEMPLATE>
Template file with default values (e.g. --template ./my-template.toml)
-i, --image <IMAGE>
VM image name (e.g. 'debian:trixie', 'debian:latest' or 'debian')
-u, --user <USER>
Username of the guest account (default: your user name on the host)
-c, --cpus <CPUS>
Number of vCPUs for the VM instance (default: derived from host resources)
-m, --memory <MEMORY>
Memory amount of the VM instance (default: derived from host resources)
-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 (repeatable, e.g. -e "sudo apt install ...")
--isolate
Isolate the VM instance from network
--no-isolate
Connect the VM instance to the network, even if the template isolates it
--rm
Delete the VM instance when the session ends
--accel <accel>
Set hardware acceleration
[default: auto]
[possible values: auto, on, off]
--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')