RomanNum3ral
/
quickemu
mirror of https://github.com/quickemu-project/quickemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Quickly create and run optimised Windows, macOS and Linux virtual machines
2,099 Commits 4 Branches 43 Tags 10 MiB
Shell 95.7%
Nix 1.9%
Python 1.8%
Ruby 0.6%
Go to file
Martin Wimpress 2a9d455307 chore: bump version to 4.9.7 2024-12-30 12:23:26 +00:00
.github chore(deps): bump DeterminateSystems/nix-installer-action from 14 to 16 2024-12-30 10:57:53 +00:00
build-docs@3125ddc21a chore: regenerated docs with README changes incorporated 2024-06-25 11:22:23 +01:00
debian chore: Remove windowskey from packaging 2024-07-11 10:34:26 +01:00
docs docs: Move quickemu_conf manual to section 5 (#1454) 2024-10-04 11:35:36 +01:00
.editorconfig Update .editorconfig with correct spacing for quickget (4) and quickemu (2) 2022-02-23 11:50:31 +00:00
.envrc feat: add flake.nix to assist local development 2024-04-16 16:57:06 +01:00
.gitignore chore: update .gitignore 2024-05-14 11:15:29 +01:00
.gitmodules add build-doc submodule (#371) 2022-02-25 23:04:10 +00:00
CODE_OF_CONDUCT.md chore: correct a spelling mistake (#1495) 2024-11-05 12:30:07 +00:00
CONTRIBUTING.md docs: add CONTRIBUTING.md 2024-06-29 23:25:20 +01:00
LICENSE Initial commit 2020-03-15 23:11:48 +00:00
README.md chore: drop Windows Server 2012 R2 2024-06-30 16:17:30 +01:00
SECURITY.md docs: update SECURITY.md 2024-06-30 00:12:20 +01:00
chunkcheck fix: add #! to chunkcheck and correct skipVerification for macOS 2024-04-17 03:54:38 +01:00
devshell.nix chore: remove ncurses from nix package and devshell 2024-07-02 14:09:29 +01:00
flake.lock flake.lock: Update 2024-12-30 10:57:34 +00:00
flake.nix refactor: update Nix flake to be consistent with the quickgui flake 2024-07-02 02:27:01 +01:00
package.nix docs: Move quickemu_conf manual to section 5 (#1454) 2024-10-04 11:35:36 +01:00
quickemu chore: bump version to 4.9.7 2024-12-30 12:23:26 +00:00
quickget fix(solus): update Solus URLs 2024-12-30 10:58:46 +00:00
quickreport fix: running quickemu and quickreport in zsh. close #1268 2024-06-24 09:02:43 +01:00

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 🤖

  • quickget automatically downloads the upstream OS and creates the configuration 📀
  • quickemu enumerates your hardware and launches the virtual machine with the optimum configuration best suited to your computer ⚡️

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

  • Host support for Linux and macOS
  • macOS Sonoma, Ventura, Monterey, Big Sur, Catalina & Mojave
  • Windows 10 and 11 including TPM 2.0
  • Windows Server 2022 2019 2016
  • Ubuntu and all the official Ubuntu flavours
  • Nearly 1000 operating system editions are supported!
  • Full SPICE support including host/guest clipboard sharing
  • VirtIO-webdavd file sharing for Linux and Windows guests
  • VirtIO-9p file sharing for Linux and macOS guests
  • QEMU Guest Agent support; provides access to a system-level agent via standard QMP commands
  • Samba file sharing for Linux, macOS and Windows guests (if smbd is installed on the host)
  • VirGL acceleration
  • USB device pass-through
  • Smartcard pass-through
  • Automatic SSH port forwarding to guests
  • Network port forwarding
  • Full duplex audio
  • Braille support
  • EFI (with or without SecureBoot) and Legacy BIOS boot

As featured on 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
Linux Matters Podcast

Quick start

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

  • quickget automatically downloads the ISO image for the operating system you want to run and creates a configuration file for the virtual machine.
quickget nixos unstable minimal
  • quickemu starts the virtual machine using the configuration file created by quickget.
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.