| QUICKEMU(1) | Quickemu User Manual | QUICKEMU(1) |
quickemu - A quick VM builder and manager
quickemu [OPTION]...
quickemu will create and run highly optimised desktop virtual machines for Linux, macOS and Windows
You can also pass optional parameters
Quickemu is a wrapper for the excellent QEMU that automatically "does the right thing" when creating virtual machines. No requirement for exhaustive configuration options. You decide what operating system you want to run and Quickemu takes care of the rest 🤖
The original objective of the project was to https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines enable quick testing of Linux distributions where the virtual machines and their configuration can be stored anywhere (such as external USB storage or your home directory) and no elevated permissions are required to run the virtual machines.
Today, Quickemu includes comprehensive support for https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines macOS, https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines Windows, most of the BSDs, novel non-Linux operating systems such as FreeDOS, Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
Linux Matters podcast! The presenters of Linux Matters 🐧🎙️ are the creators of each of the principle Quickemu projects. We discussed Quickemu's 2024 reboot in Episode 30 - Quickemu Rising From the Bashes.
Linux Matters Podcast
When installing from source, you will need to install the following requirements manually:
For Ubuntu, Arch and NixOS hosts, the ppa, AUR or https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu nix packaging will take care of the dependencies. For other host distributions or operating systems it will be necessary to install the above requirements or their equivalents.
These examples may save a little typing:
This also applies to derivatives:
sudo apt-get install bash coreutils curl genisoimage grep jq mesa-utils ovmf pciutils procps python3 qemu sed socat spice-client-gtk swtpm-tools unzip usbutils util-linux xdg-user-dirs xrandr zsync
sudo dnf install bash coreutils curl edk2-tools genisoimage grep jq mesa-demos pciutils procps python3 qemu sed socat spice-gtk-tools swtpm unzip usbutils util-linux uuidgen-runtime xdg-user-dirs xrandr zsync
Please note that you may have to use sys-firmware/edk2-ovmf instead of sys-firmware/edk2-ovmf-bin - depending on how your system is configured.
sudo emerge --ask --noreplace app-emulation/qemu \
app-shells/bash \
sys-apps/coreutils \
net-misc/curl \
sys-firmware/edk2-ovmf-bin \
sys-apps/gawk \
sys-apps/grep \
x11-apps/mesa-progs \
app-misc/jq \
sys-apps/pciutils \
sys-process/procps \
app-cdr/cdrtools \
sys-apps/usbutils \
sys-apps/util-linux \
sys-apps/sed \
net-misc/socat \
app-emulation/spice \
app-crypt/swtpm \
x11-misc/xdg-user-dirs \
x11-apps/xrandr \
net-misc/zsync \
app-arch/unzip
Install the Quickemu requirements using brew:
brew install bash cdrtools coreutils jq python3 qemu usbutils samba socat swtpm zsync
Now clone the project:
git clone https://github.com/quickemu-project/quickemu
cd quickemu
While quickemu and quickget are designed for the terminal, a graphical user interface is also available:
To install Quickgui on Ubuntu:
sudo add-apt-repository ppa:yannick-mauray/quickgui
sudo apt update
sudo apt install quickgui
Many thanks to Luke Wesley-Holley and Philipp Kiemle for creating the Quickemu icons 🎨
quickget will automatically download an Ubuntu release and create the virtual machine configuration.
quickget ubuntu 22.04
quickemu --vm ubuntu-22.04.conf
quickget can also download/refresh daily-live images via zsync for Ubuntu developers and testers.
quickget ubuntu daily-live
quickemu --vm ubuntu-daily-live.conf
You can run quickget ubuntu daily-live to refresh your daily development image as often as you like, it will even automatically switch to a new series.
All the official Ubuntu flavours are supported, just replace ubuntu with your preferred flavour.
The project https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines wiki may have further information.
You can also use quickget with advanced options :
--download <os> <release> [edition] : Download image; no VM configuration
--create-config <os> [path/url] [flags] : Create VM config for an OS image
--open-homepage <os> : Open homepage for the OS
--show [os] : Show OS information
--version : Show version
--help : Show this help message
--disable-unattended : Force quickget not to set up an unattended installation
--url [os] [release] [edition] : Show image URL(s)
--check [os] [release] [edition] : Check image URL(s)
--list : List all supported systems
--list-csv : List everything in csv format
--list-json : List everything in json format
Here are some typical uses
# show an OS ISO download URL for {os} {release} [edition]
quickget --url fedora 38 Silverblue
# test if an OS ISO is available for {os} {release} [edition]
quickget --check nixos unstable plasma5
# open an OS distribution homepage in a browser
quickget --open-homepage ubuntu-mate
# Only download image file into current directory, without creating VM
quickget --download elementary 7.1
The --url, --check, and --download options are fully functional for all operating systems, including Windows and macOS.
Further information is available from the project https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features wiki
quickget also supports:
Custom Linux guestsOr you can download a Linux image and manually create a VM configuration.
guest_os="linux"
disk_img="debian-bullseye/disk.qcow2"
iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso"
quickemu --vm debian-bullseye.conf
If you want to run an old Linux , from 2016 or earlier, change the guest_os to linux_old. This will enable the vmware-svga graphics driver which is better supported on older distros.
Creating macOS Guests 🍏 Installing macOS in a VM can be a bit finicky, if you encounter problems, check the Discussions for solutions or ask for help there 🛟
quickget automatically downloads a macOS recovery image and creates a virtual machine configuration.
quickget macos big-sur
quickemu --vm macos-big-sur.conf
macOS mojave, catalina, big-sur, monterey, ventura and sonoma are supported.
sudo trimforce enable
You will be prompted to enter your account's password to gain the privilege needed. Once you've entered your password and pressed enter the command will request confirmation in the form of two questions that require you to type y (for a "yes" response) followed by enter to confirm.
If you press enter without first typing y the system will consider that a negative response as though you said "no":
IMPORTANT NOTICE: This tool force-enables TRIM for all relevant attached devices, even though such devices may not have been validated for data integrity while using TRIM. Use of this tool to enable TRIM may result in unintended data loss or data corruption. It should not be used in a commercial operating environment or with important data. Before using this tool, you should back up all of your data and regularly back up data while TRIM is enabled. This tool is provided on an "as is" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS TOOL OR ITS USE ALONE OR IN COMBINATION WITH YOUR DEVICES, SYSTEMS, OR SERVICES. BY USING THIS TOOL TO ENABLE TRIM, YOU AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, USE OF THE TOOL IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU.
Are you sure you with to proceed (y/N)?
And a second confirmation once you've confirmed the previous one:
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
As the last message states, your system will automatically reboot as soon as the command completes.
The default macOS configuration looks like this:
guest_os="macos"
img="macos- big-sur/RecoveryImage.img"
disk_img="macos- big-sur/disk.qcow2"
macos_release=" big-sur"
There are some considerations when running macOS via Quickemu.
If you see "Your device or computer could not be verified" when you try to login to the App Store, make sure that your wired ethernet device is en0. Use ifconfig in a terminal to verify this.
If the wired ethernet device is not en0, then then go to System Preferences -> Network, delete all the network devices and apply the changes. Next, open a terminal and run the following:
sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
Now reboot, and the App Store should work.
There may be further advice and information about macOS guests in the project https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests wiki.
Creating Windows guests 🪟 quickget can download Windows 10 and Windows 11 automatically and create an optimised virtual machine configuration. This configuration also includes the VirtIO drivers for Windows.
Windows 8.1 is also supported but doesn't feature any automated installation or driver optimisation.
quickget can also download https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise Windows 10 LTSC and Windows Server https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2 2012-r2, https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016 2016, https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019 2019, and https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022 2022. No automated installation is supported for these releases.
quickget windows 11
quickemu --vm windows-11.conf
Further information is available from the project https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines wiki
Here are the usage instructions:
Usage
quickemu --vm ubuntu.conf <arguments> Arguments
--access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'
--braille : Enable braille support. Requires SDL.
--delete-disk : Delete the disk image and EFI variables
--delete-vm : Delete the entire VM and its configuration
--display : Select display backend. 'sdl' (default), 'cocoa', 'gtk', 'none', 'spice' or 'spice-app'
--fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
--ignore-msrs-always : Configure KVM to always ignore unhandled machine-specific registers
--kill : Kill the VM process if it is running
--offline : Override all network settings and start the VM offline
--shortcut : Create a desktop shortcut
--snapshot apply <tag> : Apply/restore a snapshot.
--snapshot create <tag> : Create a snapshot.
--snapshot delete <tag> : Delete a snapshot.
--snapshot info : Show disk/snapshot info.
--status-quo : Do not commit any changes to disk/snapshot.
--viewer <viewer> : Choose an alternative viewer. @Options: 'spicy' (default), 'remote-viewer', 'none'
--width <width> : Set VM screen width; requires '--height'
--height <height> : Set VM screen height; requires '--width'
--ssh-port <port> : Set SSH port manually
--spice-port <port> : Set SPICE port manually
--public-dir <path> : Expose share directory. @Options: '' (default: xdg-user-dir PUBLICSHARE), '<directory>', 'none'
--monitor <type> : Set monitor connection type. @Options: 'socket' (default), 'telnet', 'none'
--monitor-telnet-host <ip/host> : Set telnet host for monitor. (default: 'localhost')
--monitor-telnet-port <port> : Set telnet port for monitor. (default: '4440')
--monitor-cmd <cmd> : Send command to monitor if available. (Example: system_powerdown)
--serial <type> : Set serial connection type. @Options: 'socket' (default), 'telnet', 'none'
--serial-telnet-host <ip/host> : Set telnet host for serial. (default: 'localhost')
--serial-telnet-port <port> : Set telnet port for serial. (default: '6660')
--keyboard <type> : Set keyboard. @Options: 'usb' (default), 'ps2', 'virtio'
--keyboard_layout <layout> : Set keyboard layout: 'en-us' (default)
--mouse <type> : Set mouse. @Options: 'tablet' (default), 'ps2', 'usb', 'virtio'
--usb-controller <type> : Set usb-controller. @Options: 'ehci' (default), 'xhci', 'none'
--sound-card <type> : Set sound card. @Options: 'intel-hda' (default), 'ac97', 'es1370', 'sb16', 'usb-audio', 'none'
--sound-duplex <type> : Set sound card duplex. @Options: 'hda-micro' (default: speaker/mic), 'hda-duplex' (line-in/line-out), 'hda-output' (output-only)
--extra_args <arguments> : Pass additional arguments to qemu
--version : Print version
Desktop shortcuts can be created for a VM, the shortcuts are saved in ~/.local/share/applications. Here is an example of how to create a shortcut.
quickemu --vm ubuntu-22.04-desktop.conf --shortcut
Useful reference that assisted the development of Quickemu.
Written by Martin Wimpress.
Submit bug reports online at: https://github.com/quickemu-project/quickemu/issues
Full sources at: https://github.com/quickemu-project/quickemu
Martin Wimpress.
| August 2, 2024 | quickemu |