Features Overview
Relevant source files
The following files were used as context for generating this wiki page:
Quickemu is a powerful Bash-based wrapper for QEMU designed to simplify the creation and management of optimized virtual machines. By automating hardware enumeration and configuration, it enables users to run Windows, macOS, and Linux guests with "optimum configuration" without requiring deep technical knowledge of QEMU's exhaustive command-line options.
The system is built around a modular architecture of Bash scripts that handle specific parts of the VM lifecycle, from OS image acquisition to runtime optimization and system diagnostics. It supports approximately 1000 operating system editions and provides native-like performance through various acceleration and integration features.
Sources: README.md:18-32, AGENTS.md:3-5
Core System Architecture
The Quickemu project is composed of several specialized Bash scripts, each handling a distinct stage of the virtual machine lifecycle. The architecture separates the concerns of downloading/configuring and executing the virtual environment.
The diagram above illustrates the relationship between the primary utility scripts and the flow from OS acquisition to VM execution.
Sources: AGENTS.md:7-15, README.md:88-95
Key Components
| Component | Description | File Path |
|---|---|---|
| quickget | Downloads upstream OS ISOs and generates the initial VM configuration file. | quickget |
| quickemu | Main launcher; detects host hardware and starts the VM with optimized QEMU parameters. | quickemu |
| quickreport | System diagnostics tool used to gather information for troubleshooting. | quickreport |
| chunkcheck | Utility used for verifying the integrity of downloaded data chunks. | chunkcheck |
Sources: AGENTS.md:7-15
Operating System Support
Quickemu provides comprehensive support for a wide array of guest operating systems across multiple architectures.
- macOS Support: Includes versions from Mojave (10.14) through Sequoia (15).
- Windows Support: Covers Windows 10, Windows 11 (including TPM 2.0 simulation), and Windows Server (2016, 2019, 2022).
- Linux/BSD: Supports Ubuntu (and its flavors), various BSD distributions, and niche OSs like FreeDOS, Haiku, and ReactOS.
- Architecture: Native support for x86_64 and ARM64 (aarch64). ARM64 guests use AAVMF firmware and the
virtmachine type.
Sources: README.md:34-45, AGENTS.md:75-80
Virtualization and Integration Features
Quickemu integrates several advanced QEMU features to provide a high-quality guest experience, including file sharing, hardware acceleration, and peripheral pass-through.
Hardware and Performance Features
- VirGL Acceleration: Provides GPU acceleration for guests.
- EFI/BIOS: Support for EFI (including SecureBoot) and Legacy BIOS.
- ARM64 Emulation: Cross-architecture emulation using TCG (Tiny Code Generator) when KVM is unavailable.
- Smartcard & USB: Support for device pass-through to the guest.
Integration and Sharing
- File Sharing: Support for VirtIO-webdavd (Linux/Windows), VirtIO-9p (Linux/macOS), and Samba (cross-platform if
smbdis installed on host). - SPICE Support: Enables host/guest clipboard sharing and enhanced display interaction.
- Networking: Automatic SSH port forwarding and general network port forwarding.
Sources: README.md:46-63, AGENTS.md:78-80
Implementation and Contribution
The project follows strict development standards to ensure reliability across the supported platforms (Linux and macOS hosts).
Development Flow
The development of Quickemu is governed by Conventional Commits and automated CI workflows.
Sources: AGENTS.md:48-65, CONTRIBUTING.md:5-10
Security and Maintenance
Quickemu maintains a security policy focusing on the most recent versions (currently 4.9.x). Vulnerabilities are handled on a best-effort basis as the project is community-driven.
| Version | Security Support Status |
|---|---|
| 4.9.x | Supported |
| < 4.8 | Not Supported |
Sources: SECURITY.md:5-15
Quickemu automates the complexities of QEMU, providing a streamlined workflow for developers and testers to deploy optimized virtual environments across nearly 1000 OS editions. Through its specialized tools like quickget and quickemu, it handles everything from ISO verification to hardware-specific performance tuning.