quickemu README

The project's README from github.com/quickemu-project/quickemu. As one markdown file: README.md.

Quickemu

Quickemu

Quickly create and run optimised Windows, macOS and Linux virtual machines:

Made with 💝 for Tux (Linux) & Apple (macOS)

 Discord   Mastodon   Twitter   LinkedIn 

Introduction

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 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 macOS, Windows, most of the BSDs, novel non-Linux operating systems such as FreeDOS, Haiku, KolibriOS, OpenIndiana, ReactOS, and more.

Features

The presenters of Linux Matters 🐧🎙️ are the creators of each of the principal Quickemu projects. We discussed Quickemu's 2024 reboot in Episode 30 - Quickemu Rising From the Bashes.

Linux Matters Podcast
Linux Matters Podcast

Quick start

Once Quickemu is installed, there are two simple steps to create and run a virtual machine:

quickget nixos unstable minimal
quickemu --vm nixos-unstable-minimal.conf

Execute quickget (with no arguments) to see a list of all the supported operating systems.

Demo

Documentation

The wiki describes how to get up and running with Quickemu and also covers more advanced configuration and usage.

quickemu (quickemu-project/quickemu)

Searching Database…

16.5K ·GitHub
What is this?Quickemu is a command-line wrapper around QEMU that creates and runs optimised Windows, macOS and Linux virtual machines. You pick the OS; quickget downloads it and quickemu handles the configuration and launch.
How is it different from just using QEMU directly?You write no VM configuration yourself: quickget downloads the OS image and generates the config file, and quickemu enumerates your hardware and launches the machine with the settings best suited to your computer.
How do I create and run my first VM?Install Quickemu (the wiki has per-platform instructions), then run 'quickget' — with no arguments it lists all supported operating systems — to download the OS you want and create its configuration file, then pass that file to quickemu to start the VM.
What does my computer need to host these VMs?A Linux or macOS host. QEMU is the one core dependency since Quickemu wraps it, and Samba file sharing additionally requires smbd to be installed on the host.
Do I need admin rights to run the VMs?No. VMs and their configuration can be stored anywhere, such as your home directory or external USB storage, and no elevated permissions are required to run them.
Which operating systems can I run as guests?Nearly 1000 editions: macOS from Mojave to Sequoia, Windows 10 and 11 plus Windows Server, Ubuntu and its official flavours, most BSDs, plus FreeDOS, Haiku, KolibriOS, OpenIndiana and ReactOS. aarch64 guests run natively on ARM hosts and emulated on x86_64.
What host-guest integration is built in beyond just booting the OS?Full SPICE support including host/guest clipboard sharing, file sharing via VirtIO-9p, VirtIO-webdavd or Samba, and both USB and smartcard pass-through.
How does it handle Windows 11's TPM 2.0 requirement?Windows 10 and 11 are supported including TPM 2.0, and VMs can boot via EFI with or without SecureBoot or via Legacy BIOS.
Can I SSH into a VM or reach services running inside it?Yes — Quickemu sets up automatic SSH port forwarding to guests and also supports general network port forwarding.
Why did the author build this?The original objective was quick testing of Linux distributions — disposable VMs you can keep on external USB storage with no root — before growing into today's macOS, Windows and BSD coverage.
Size
2.5 MB
Stars
16.5K
Age
6y
Commits · 90 Days