vmexec-run(1)               General Commands Manual              vmexec-run(1)

NAME
       vmexec-run - Run a command in a new virtual machine

SYNOPSIS
       vmexec run [-d|--detach] [--rm] [--vmid] [--disable-kvm] [-m|--memory]
       [-e|--env] [-w|--workdir] [-v|--volume] [--pmem] [-p|--publish]
       [-s|--ssh-timeout] [-i|--interactive] [-t|--tty] [--show-vm-window]
       [--pull] [-h|--help] <IMAGE_SOURCE> [ARGS]

DESCRIPTION
       Run a command in a new virtual machine

OPTIONS
       -d, --detach
              Run virtual machine in background and print virtual machine ID

       --rm   Remove virtual machine runtime data after exit

       --vmid <VMID>
              Virtual machine identifier

              If not provided, a random identifier will be generated.

       --disable-kvm
              Run virtual machine with TCG instead of KVM

              This would be mostly useful in environments where KVM is not
              available. It will be a lot slower but might be acceptable in
              some contexts.

       -m, --memory <MEMORY>
              Memory limit for the virtual machine in GBs

              Must be an integer of at least 1.

              If not provided, all available host memory is used.

       -e, --env <ENV>
              Set environment variables for the process inside the virtual
              machine

              Can be provided multiple times.

              Expected format: KEY=VALUE

       -w, --workdir <WORKDIR>
              Working directory inside the virtual machine

              The default wokring directory for running binaries within a
              virtual machine is dependent on the image. Most commonly, it'll
              be /root.

       -v, --volume <VOLUMES>
              Bind mount a volume into the virtual machine

              Can be provided multiple times.

              Expected format: source:dest[:ro]

              `ro` can optionally be provided to mark the mount as read-only.

              Example: $PWD/src:/mnt:ro

       --pmem <PMEMS>
              Mount a virtio-pmem device file into the virtual machine

              You might want to do this to bypass the guest page cache. This
              is important if you're overprovisioning your host (i.e. giving
              VMs more combined memory than the host actually has) and have a
              write-heavy workload. For more info, see:
              https://www.qemu.org/docs/master/system/devices/virtio-pmem.html

              Can be provided multiple times.

              Size is in gigabytes.

              Expected format: dest:<size>

              Example: /var/lib:20

       -p, --publish <PUBLISHED_PORTS>
              Publish a port on the virtual machine to the host

              Can be provided multiple times.

              Expected format: [[hostip:][hostport]:]vmport

              `hostip` is optional and if not provided, the port will be bound
              on all host IPs.

              `hostport` is optional and if not provided, the same value of
              `vmport` will be used for the host port.

              Currently only IPv4 is supported for `hostip`.

       -s, --ssh-timeout <SSH_TIMEOUT> [default: 20]
              SSH connection timeout

              Try for this long (in seconds) to connect to the virtual
              machine's SSH server.

       -i, --interactive <INTERACTIVE> [default: auto]
              Make STDIN available to the virtual machine's process

              If 'auto', this will try to read from stdin if it is available,
              and do nothing when stdin is not available. If 'always', this
              will try to read from stdin and abort when stdin is not
              available.

              Possible values:

                     o always

                     o never

                     o auto

       -t, --tty <TTY> [default: auto]
              Allocate a pseudo-TTY for the virtual machine

              If 'auto', this will be enabled in case vmexec is run from an
              interactive terminal.

              Possible values:

                     o always

                     o never

                     o auto

       --show-vm-window
              Show a window with the virtual machine running in it

              This is mostly useful for debugging boot failures.

       --pull <PULL> [default: missing]
              When to pull a new image

              Possible values:

                     o missing

                     o never

                     o newer

       -h, --help
              Print help (see a summary with '-h')

       <IMAGE_SOURCE>
              Either an operating system (e.g. archlinux) or a path to an
              image

              Possible OS types: archlinux

       [ARGS] Arguments to run in the virtual machine

                                     run                         vmexec-run(1)