Showing preview only (469K chars total). Download the full file or copy to clipboard to get everything.
Repository: quickemu-project/quickemu
Branch: master
Commit: b541fe1c58ff
Files: 44
Total size: 451.8 KB
Directory structure:
gitextract_4b3igp5s/
├── .editorconfig
├── .envrc
├── .github/
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ ├── dependabot.yml
│ ├── pull_request_template.md
│ └── workflows/
│ ├── flake-checker.yml
│ ├── flake-updater.yml
│ ├── lint-pr.yml
│ ├── lint-shellcheck.yml
│ ├── publish-release.yml
│ ├── test-build-quickemu.yml
│ └── test-quickget.yml
├── .gitignore
├── .gitmodules
├── AGENTS.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── chunkcheck
├── debian/
│ ├── changelog
│ ├── control
│ ├── copyright
│ ├── install
│ ├── rules
│ └── source/
│ └── format
├── devshell.nix
├── docs/
│ ├── Makefile
│ ├── pandoc-man.mk
│ ├── quickemu.1
│ ├── quickemu.1.md
│ ├── quickemu_conf.5
│ ├── quickemu_conf.5.md
│ ├── quickget.1
│ └── quickget.1.md
├── flake.lock
├── flake.nix
├── package.nix
├── quickemu
├── quickget
└── quickreport
================================================
FILE CONTENTS
================================================
================================================
FILE: .editorconfig
================================================
root = true
[quickemu]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
[quickget]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false
================================================
FILE: .envrc
================================================
use flake
================================================
FILE: .github/FUNDING.yml
================================================
# These are supported funding model platforms
github: [flexiondotorg, philclifford, lj3954]
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
name: Bug report
about: Create a report to help us improve
title: 'bug: description of the bug you encountered'
labels: ''
assignees: ''
---
**I confirm this bug has not already been reported**
- [ ] I have searched the issues and this bug has not been reported previously
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behaviour:
1. Run `quickemu` with arguments '...'
2. See error
**Expected behaviour**
A clear and concise description of what you expected to happen.
**Quickemu output**
Run `quickemu` or `quickemu` and include the output of the failure below:
<details>
<summary>Quickemu output</summary>
```text
quickemu/quickget output here
```
</details>
**System information**
Run `quickreport` and include the output here; if you can't run `quickreport`,
please provide the output of the following:
<details>
<summary>Quickreport output</summary>
```text
quickreport output here
```
</details>
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Additional context**
Add any other context about the problem here.
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.md
================================================
---
name: Feature request
about: Suggest an idea for this project
title: 'feat: describe the feature you are requesting'
labels: ''
assignees: ''
---
**I confirm this feature has not been previously requested**
- [ ] I have searched the issues and this feature has not previously been requested
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
================================================
FILE: .github/dependabot.yml
================================================
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
# Check for updates to GitHub Actions every week
interval: "weekly"
================================================
FILE: .github/pull_request_template.md
================================================
# Description
Please include a summary of the changes along with any relevant motivation and context.
<!-- Close any related issues. Delete if not relevant -->
- Closes #
- Fixes #
- Resolves #
## Type of change
<!-- Delete any that are not relevant -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Packaging (updates the packaging)
- [ ] Documentation (updates the documentation)
# Checklist:
- [ ] I have performed a self-review of my code
- [ ] I have tested my code in common scenarios and confirmed there are no regressions
- [ ] I have added comments to my code, particularly in hard-to-understand sections
- [ ] I have made corresponding changes to the documentation (*remove if no documentation changes were required*)
================================================
FILE: .github/workflows/flake-checker.yml
================================================
name: Flake ❄️ Checker ✅
on:
push:
branches:
- master
schedule:
- cron: '42 0 * * 6'
workflow_dispatch:
jobs:
flake-checker:
name: Flake Checker
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- uses: DeterminateSystems/nix-installer-action@v21
- uses: DeterminateSystems/magic-nix-cache-action@v9
- uses: DeterminateSystems/flake-checker-action@v12
================================================
FILE: .github/workflows/flake-updater.yml
================================================
name: Flake ❄️ Lock 🔒️ Updater ✨
on:
schedule:
- cron: '37 13 14,28 * *'
workflow_dispatch:
jobs:
lock-updater:
name: Flake Lock Updater
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- uses: DeterminateSystems/nix-installer-action@v21
- uses: DeterminateSystems/magic-nix-cache-action@v9
- uses: DeterminateSystems/update-flake-lock@v28
with:
pr-title: "chore: update flake.lock"
================================================
FILE: .github/workflows/lint-pr.yml
================================================
name: "Lint Pull Request 🐙"
on:
pull_request_target:
types:
- opened
- edited
- synchronize
permissions:
pull-requests: read
jobs:
main:
name: Validate pull request title
runs-on: ubuntu-22.04
steps:
- uses: amannn/action-semantic-pull-request@v6
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
# If the PR only contains a single commit, the action will validate that
# it matches the configured pattern.
validateSingleCommit: true
# Related to `validateSingleCommit` you can opt-in to validate that the PR
# title matches a single commit to avoid confusion.
validateSingleCommitMatchesPrTitle: true
================================================
FILE: .github/workflows/lint-shellcheck.yml
================================================
name: "Lint Shellcheck 🐚"
on:
pull_request:
branches: '**'
workflow_dispatch:
jobs:
shellcheck:
name: Shellcheck
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v6
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
format: gcc
severity: warning
================================================
FILE: .github/workflows/publish-release.yml
================================================
name: Publish Release 🏷️
on:
push:
tags:
- "v?[0-9]+.[0-9]+.[0-9]+*"
workflow_dispatch:
inputs:
tag:
description: "The existing tag to publish"
type: "string"
required: true
jobs:
version-check:
name: "Check versions ⚖️"
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- name: "Compare App and Git versions 🟰"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
APP_VERSION=$(grep "^readonly VERSION" quickemu | cut -d'"' -f2)
GIT_VERSION=$(git describe --tags | cut -d'-' -f1)
echo "App version: ${REL_VERSION}"
echo "Git version: ${GIT_VERSION}"
if [ "${APP_VERSION}" != "${GIT_VERSION}" ]; then
echo "ERROR! Version mismatch.";
exit 1
fi
draft-release:
needs: [version-check]
name: "Draft Release 📥️"
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v6
- name: Create release ${{ github.ref }} as a draft
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh release create "${{ github.ref }}" --draft --generate-notes
build-release:
needs: [draft-release]
name: "Build Release 👨🔧"
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v6
- name: Build and Upload .deb
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
sudo apt-get -y update
sudo apt-get -y install debhelper devscripts
REL_VER=$(grep "^readonly VERSION" quickemu | cut -d'"' -f2)
rm debian/changelog
dch --package quickemu --newversion="${REL_VER}-1" --distribution=unstable "New upstream release." --create
dpkg-buildpackage --build=binary --no-check-builddeps --compression=gzip
gh release upload "${{ github.ref }}" "../quickemu_${REL_VER}-1_all.deb" --clobber
publish-release:
needs: [build-release]
name: "Publish Release 📤️"
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v6
- name: Publish release ${{ github.ref }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
if [ "$(gh release view "${{ github.ref }}" --json assets --template '{{len .assets}}')" -lt 0 ]; then
exit 1
fi
gh release edit "${{ github.ref }}" --draft=false
publish-flakehub:
needs: [version-check]
name: "Publish FlakeHub ❄️"
runs-on: "ubuntu-22.04"
permissions:
id-token: "write"
contents: "read"
steps:
- uses: "actions/checkout@v6"
with:
ref: "${{ (inputs.tag != null) && format('refs/tags/{0}', inputs.tag) || '' }}"
- uses: "DeterminateSystems/nix-installer-action@main"
- uses: "DeterminateSystems/magic-nix-cache-action@main"
- uses: "DeterminateSystems/flakehub-push@main"
with:
visibility: "public"
name: "quickemu-project/quickemu"
tag: "${{ inputs.tag }}"
publish-ppa:
needs: [version-check]
name: "Publish PPA 📦️"
runs-on: ubuntu-22.04
steps:
- name: "Checkout 🥡"
uses: actions/checkout@v6
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: "Import gpg key 🔑"
uses: crazy-max/ghaction-import-gpg@v7
with:
gpg_private_key: ${{ secrets.PPA_GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.PPA_GPG_PASSPHRASE }}
- name: "Install dependencies 💾"
run: |
sudo apt-get -y update
sudo apt-get -y install debhelper-compat distro-info dput devscripts
- name: "Upload to PPA ⤴️"
env:
DEBEMAIL: ${{ secrets.DEBEMAIL }}
DEBFULLNAME: ${{ secrets.DEBFULLNAME }}
run: |
REL_VER=$(grep "^readonly VERSION" quickemu | cut -d'"' -f2)
STAMP=$(date +%y%j.%H%M)
for CODENAME in $(distro-info --supported); do
rm debian/changelog
dch --package quickemu --newversion="${REL_VER}-1~${CODENAME}${STAMP}" --distribution=${CODENAME} "New upstream release." --create
dpkg-buildpackage -d -S -sa
dput ppa:flexiondotorg/quickemu ../quickemu_${REL_VER}-1~${CODENAME}${STAMP}_source.changes
done
================================================
FILE: .github/workflows/test-build-quickemu.yml
================================================
name: Test build quickemu 🚧
on:
pull_request:
branches:
- master
paths:
- quickemu
- quickget
- debian/**
- flake.nix
- package.nix
push:
branches:
- master
paths:
- quickemu
- quickget
- debian/**
- flake.nix
- package.nix
workflow_dispatch:
# TODO: arm64 runner
# https://github.blog/changelog/2024-06-03-actions-arm-based-linux-and-windows-runners-are-now-in-public-beta/
jobs:
test-deb-build:
runs-on: ubuntu-22.04
steps:
- name: "Checkout 🥡"
uses: actions/checkout@v6
- name: "Build & Test .deb 🍥"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
sudo apt-get -y update
sudo apt-get -y install debhelper devscripts
REL_VER=$(grep "^readonly VERSION" quickemu | cut -d'"' -f2)
rm debian/changelog
dch --package quickemu --newversion="${REL_VER}-1" --distribution=unstable "New upstream release." --create
dpkg-buildpackage --build=binary --no-check-builddeps --compression=gzip
sudo apt-get -y install ../quickemu_${REL_VER}-1_all.deb
quickemu --help
quickget --help
test-nix-build:
runs-on: ubuntu-22.04
permissions:
id-token: "write"
contents: "read"
steps:
- name: "Checkout 🥡"
uses: "actions/checkout@v6"
- name: "Install Nix ❄️"
uses: "DeterminateSystems/nix-installer-action@v21"
- name: "Enable Magic Nix Cache 🪄"
uses: "DeterminateSystems/magic-nix-cache-action@v9"
- name: "Build & Test .nix ❄️"
run: |
nix build .#quickemu
tree ./result
./result/bin/quickemu --help
./result/bin/quickget --help
./result/bin/quickreport
# Text a VM if the Nix Installer successfully enabled KVM
if [ $DETERMINATE_NIX_KVM -eq 1 ]; then
./result/bin/quickget alpine v3.20
./result/bin/quickemu --vm alpine-v3.20.conf --display none
sleep 5
if pgrep -F ./alpine-v3.20/alpine-v3.20.pid; then
echo "Test VM is running"
else
echo "Test VM is not running"
exit 1
fi
# Test a few more quickemu commands to clean up
./result/bin/quickemu --vm alpine-v3.20.conf --kill
./result/bin/quickemu --vm alpine-v3.20.conf --delete-disk
./result/bin/quickemu --vm alpine-v3.20.conf --delete-vm
fi
================================================
FILE: .github/workflows/test-quickget.yml
================================================
name: "Test quickget 🧪"
on:
workflow_dispatch:
push:
branches:
- master
paths:
- quickget
pull_request:
branches:
- '**'
paths:
- quickget
jobs:
detect-distros:
name: "Detect distros 🔍"
runs-on: ubuntu-22.04
outputs:
distros: ${{ steps.get-distros.outputs.distros }}
steps:
- uses: actions/checkout@v6
- name: "Extract unique distros 📋"
id: get-distros
run: |
# Get unique distros, excluding windows variants
DISTROS=$(./quickget --list | tail -n +2 | cut -d' ' -f1 | sort -u | grep -v '^windows$' | grep -v '^windows-server$')
# Convert to JSON array
JSON=$(echo "$DISTROS" | jq -R -s -c 'split("\n") | map(select(length > 0))')
echo "distros=${JSON}" >> "$GITHUB_OUTPUT"
echo "Found $(echo "$DISTROS" | wc -l | tr -d ' ') distros to test"
test-distro:
name: "Test ${{ matrix.distro }} 🧪"
needs: detect-distros
runs-on: ubuntu-22.04
continue-on-error: true
strategy:
fail-fast: false
matrix:
distro: ${{ fromJson(needs.detect-distros.outputs.distros) }}
steps:
- uses: actions/checkout@v6
- name: "Install dependencies 📦️"
run: |
sudo apt-get -y update
sudo apt-get -y install curl qemu-utils
- name: "Check ${{ matrix.distro }} downloads 💿️"
id: check
run: |
mkdir -p results
./quickget --check-all-arch "${{ matrix.distro }}" | tee results/check.txt
# Count results (use wc -l to avoid grep exit code issues)
PASSED=$(grep '^PASS' results/check.txt | wc -l | tr -d ' ')
FAILED=$(grep '^FAIL' results/check.txt | wc -l | tr -d ' ')
SKIPPED=$(grep '^SKIP' results/check.txt | wc -l | tr -d ' ')
echo "passed=${PASSED}" >> "$GITHUB_OUTPUT"
echo "failed=${FAILED}" >> "$GITHUB_OUTPUT"
echo "skipped=${SKIPPED}" >> "$GITHUB_OUTPUT"
# Extract failed URLs for reporting
grep '^FAIL' results/check.txt > results/failed.txt || true
echo "Results for ${{ matrix.distro }}: PASS=${PASSED} FAIL=${FAILED} SKIP=${SKIPPED}"
- name: "Create result JSON 📝"
run: |
mkdir -p result
jq -n \
--arg distro "${{ matrix.distro }}" \
--argjson passed "${{ steps.check.outputs.passed }}" \
--argjson failed "${{ steps.check.outputs.failed }}" \
--argjson skipped "${{ steps.check.outputs.skipped }}" \
'{distro: $distro, passed: $passed, failed: $failed, skipped: $skipped}' \
> result/result.json
# Include failed URLs if any
if [ -s results/failed.txt ]; then
cp results/failed.txt result/failed.txt
fi
cat result/result.json
- name: "Upload result artifact 📤"
uses: actions/upload-artifact@v7
with:
name: result-${{ matrix.distro }}
path: result/
retention-days: 1
- name: "Fail if any failures ❌"
if: steps.check.outputs.failed != '0'
run: |
echo "::error::${{ matrix.distro }} has ${{ steps.check.outputs.failed }} failed downloads"
exit 1
report-results:
name: "Report results 📊"
needs: test-distro
runs-on: ubuntu-22.04
if: always()
steps:
- name: "Download all result artifacts 📥"
uses: actions/download-artifact@v8
with:
pattern: result-*
path: results
- name: "Generate summary report 📈"
run: |
# Aggregate all results
TOTAL_PASSED=0
TOTAL_FAILED=0
TOTAL_SKIPPED=0
HAS_FAILURES=false
# Temp file for collecting per-distro table rows
TEMP_ROWS=$(mktemp)
for json_file in results/result-*/result.json; do
[ -f "$json_file" ] || continue
DISTRO=$(jq -r '.distro' "$json_file")
PASSED=$(jq -r '.passed' "$json_file")
FAILED=$(jq -r '.failed' "$json_file")
SKIPPED=$(jq -r '.skipped' "$json_file")
TOTAL_PASSED=$((TOTAL_PASSED + PASSED))
TOTAL_FAILED=$((TOTAL_FAILED + FAILED))
TOTAL_SKIPPED=$((TOTAL_SKIPPED + SKIPPED))
if [ "$FAILED" -gt 0 ]; then
HAS_FAILURES=true
if [ "$PASSED" -eq 0 ]; then
STATUS="❌"
else
STATUS="⚠️"
fi
else
STATUS="✅"
fi
echo "| ${DISTRO} | ${PASSED} | ${FAILED} | ${SKIPPED} | ${STATUS} |" >> "$TEMP_ROWS"
done
# Write summary header
echo "## Test Results 📊" >> "$GITHUB_STEP_SUMMARY"
echo "" >> "$GITHUB_STEP_SUMMARY"
echo "| Metric | Count |" >> "$GITHUB_STEP_SUMMARY"
echo "|--------|-------|" >> "$GITHUB_STEP_SUMMARY"
echo "| ✅ Passed | ${TOTAL_PASSED} |" >> "$GITHUB_STEP_SUMMARY"
echo "| ❌ Failed | ${TOTAL_FAILED} |" >> "$GITHUB_STEP_SUMMARY"
echo "| ⏭️ Skipped | ${TOTAL_SKIPPED} |" >> "$GITHUB_STEP_SUMMARY"
# Write per-distro breakdown
echo "" >> "$GITHUB_STEP_SUMMARY"
echo "### Per-distro breakdown" >> "$GITHUB_STEP_SUMMARY"
echo "" >> "$GITHUB_STEP_SUMMARY"
echo "| Distro | Passed | Failed | Skipped | Status |" >> "$GITHUB_STEP_SUMMARY"
echo "|--------|--------|--------|---------|--------|" >> "$GITHUB_STEP_SUMMARY"
sort "$TEMP_ROWS" >> "$GITHUB_STEP_SUMMARY"
# Collect and display failed URLs if any
if [ "$HAS_FAILURES" = true ]; then
echo "" >> "$GITHUB_STEP_SUMMARY"
echo "### ❌ Failed URLs" >> "$GITHUB_STEP_SUMMARY"
echo "" >> "$GITHUB_STEP_SUMMARY"
echo '```' >> "$GITHUB_STEP_SUMMARY"
for failed_file in results/result-*/failed.txt; do
[ -f "$failed_file" ] && cat "$failed_file" >> "$GITHUB_STEP_SUMMARY"
done
echo '```' >> "$GITHUB_STEP_SUMMARY"
fi
# Print summary to log as well
echo "===== SUMMARY ====="
echo "Total Passed: ${TOTAL_PASSED}"
echo "Total Failed: ${TOTAL_FAILED}"
echo "Total Skipped: ${TOTAL_SKIPPED}"
echo "=================="
# Clean up temp file
rm -f "$TEMP_ROWS"
# Exit with failure if any distro had failures
if [ "$HAS_FAILURES" = true ]; then
echo "::error::Some distros have failed downloads. Check the summary for details."
exit 1
fi
================================================
FILE: .gitignore
================================================
*.chunklist
*.conf
*.dmg
*.fd
*.fixed
*.img
*.iso
*.ISO
*.lock
!flake.lock
*.log
*.markdownlint.jsonc
*.markdownlint.yaml
*.msi
*.part
*.permall
*.pid
*.ports
*.qcow2
*.sh
*.sock
*.xml
*.zs-old
.direnv/
================================================
FILE: .gitmodules
================================================
[submodule "build-docs"]
path = build-docs
url = https://github.com/philclifford/quickemu-docs.git
================================================
FILE: AGENTS.md
================================================
# AGENTS.md
Quickemu is a Bash wrapper around QEMU that automates VM creation for ~1000 operating systems (Linux, macOS, Windows, BSDs). Two main tools: `quickget` downloads ISOs and creates configs; `quickemu` launches VMs with optimised hardware detection.
## Project structure
```
quickemu # Main VM launcher script (Bash)
quickget # OS downloader and config generator (Bash)
quickreport # System diagnostics tool (Bash)
chunkcheck # Download verification utility (Bash)
flake.nix # Nix flake for packaging
package.nix # Nix package definition
devshell.nix # Development environment
```
## Development environment
```shell
nix develop # Enter devshell with all dependencies
direnv reload # Update .direnv/bin/quickemu for testing
```
The devshell patches `quickemu` to use Nix store paths for OVMF and Samba, writing to `.direnv/bin/quickemu`.
## Build and test commands
- Lint scripts: `shellcheck quickemu quickget quickreport chunkcheck`
- Test quickget URLs: `./quickget --check <os> [release] [edition]`
- Test ARM64 downloads: `./quickget --arch arm64 --check <os> [release] [edition]`
- Test all architectures: `./quickget --check-all-arch <os> [release] [edition]`
- List all supported OSes: `./quickget --list`
- Run VM: `./quickemu --vm <name>.conf`
## Code style
All scripts are Bash 4.0+ with ShellCheck compliance.
| File | Indent | Notes |
|------|--------|-------|
| quickemu | 2 spaces | Main VM launcher |
| quickget | 4 spaces | OS definitions and download logic |
**General conventions:**
- UTF-8, LF line endings, final newline
- Trim trailing whitespace (except Markdown)
- Functions use `function name() {` syntax
- Many functions are invoked indirectly via dynamic dispatch - `SC2317` is disabled globally in quickget
## Adding a new OS to quickget
Follow the [guide in the wiki](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features#adding-a-new-os-to-quickget). Each OS requires:
1. Entry in `os_info()` case statement
2. `releases_<os>()` function returning available versions
3. `editions_<os>()` function if multiple editions exist
4. `arch_<os>()` function if ARM64 is supported (defaults to amd64 only if omitted)
5. Download URL construction logic
## Commit message format
Commits must follow [Conventional Commits](https://www.conventionalcommits.org/). PR titles are validated against this format.
**Common prefixes:**
- `fix(quickget):` - Fix distro downloads, update editions/releases
- `fix(quickemu):` - Fix VM configuration or runtime issues
- `feat(quickget):` - Add new OS support
- `feat(quickemu):` - Add new VM features
- `ci:` - CI/workflow changes
- `docs:` - Documentation updates
**Examples from recent history:**
```
fix(quickget): update Zorin OS download method and editions
fix(quickget): handle Solus Xfce beta naming for older releases
fix(quickget): remove Athena OS (no longer getting updates)
```
## Pull request guidelines
- PR titles must match Conventional Commits format (enforced by CI)
- Single-commit PRs: commit message must match PR title
- Run `shellcheck` before submitting
- Test affected OS downloads with `./quickget --check <os> <release>`
## CI workflows
| Workflow | Trigger | Purpose |
|----------|---------|---------|
| lint-shellcheck | PR | ShellCheck with severity: warning |
| lint-pr | PR | Validates PR title matches Conventional Commits |
| test-quickget | PR | Tests quickget functionality |
| test-build-quickemu | PR | Build verification |
| flake-checker | PR | Nix flake validation |
## Platform support
- Host: Linux (x86_64, aarch64), macOS (x86_64, aarch64)
- Guest: x86_64 (default), aarch64 (set `arch="aarch64"` in VM config)
- ARM64 guests use AAVMF firmware and `virt` machine type
- Cross-arch emulation uses TCG (no KVM acceleration)
- OVMF/UEFI firmware: Linux only
- Bash 4.0+ required (explicit version check at runtime)
## Key dependencies
Runtime: qemu, cdrtools, curl, jq, spice-gtk, swtpm, samba, zsync
Linux-specific: OVMF (x86_64 guests), AAVMF (aarch64 guests), usbutils, mesa-demos
================================================
FILE: CODE_OF_CONDUCT.md
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behaviour that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behaviour include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behaviour and will take appropriate and fair corrective action in
response to any behaviour that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
reported to the community leaders responsible for enforcement at
#quickemu channel on Discord.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behaviour deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behaviour was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behaviour. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behaviour.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behaviour, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
================================================
FILE: CONTRIBUTING.md
================================================
# Contributing
We welcome contributions to Quickemu.
- Help other Quickemu users by answering questions in the [Quickemu Discussions](https://github.com/quickemu-project/quickemu/discussions) 🛟
- Improve the documentation in [this README](https://github.com/quickemu-project/quickemu/edit/master/README.md) and the [Quickemu Wiki](https://github.com/quickemu-project/quickemu/wiki) 📖
- File bug reports and feature requests in the [Quickemu Issues](https://github.com/quickemu-project/quickemu/issues) 📁
- Submit [Quickemu Pull requests](https://github.com/quickemu-project/quickemu/pulls) to fix bugs 🐞 or add new features ✨
- Follow our [guide to adding a new OS to quickget](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features#adding-a-new-os-to-quickget)
- Commit messages must [conform to the Conventional Commits specification](https://www.conventionalcommits.org/).
- [Sponsor the project](https://github.com/sponsors/flexiondotorg) 💖
================================================
FILE: LICENSE
================================================
MIT License
Copyright (c) 2020 Wimpy's World
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: README.md
================================================
<div align="center">
<img src=".github/logo.png" alt="Quickemu" width="256" />
# Quickemu
**Quickly create and run optimised Windows, macOS and Linux virtual machines:**
**Made with 💝 for <img src=".github/tux.png" align="top" width="24" alt="Tux (Linux)"/> & <img src=".github/apple.png" align="top" width="24" alt="Apple (macOS)"/>**
</div>
<p align="center">
<a href="https://wimpysworld.io/discord" target="_blank"><img alt="Discord" src="https://img.shields.io/discord/712850672223125565?style=for-the-badge&logo=discord&logoColor=%23ffffff&label=Discord&labelColor=%234253e8&color=%23e4e2e2"></a>
<a href="https://fosstodon.org/@wimpy" target="_blank"><img alt="Mastodon" src="https://img.shields.io/badge/Mastodon-6468fa?style=for-the-badge&logo=mastodon&logoColor=%23ffffff"></a>
<a href="https://twitter.com/m_wimpress" target="_blank"><img alt="Twitter" src="https://img.shields.io/badge/Twitter-303030?style=for-the-badge&logo=x&logoColor=%23ffffff"></a>
<a href="https://linkedin.com/in/martinwimpress" target="_blank"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-1667be?style=for-the-badge&logo=linkedin&logoColor=%23ffffff"></a>
</p>
# Introduction
**Quickemu** is a wrapper for the excellent [QEMU](https://www.qemu.org/) 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](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines)
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](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines),
[Windows](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)**, 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** Sequoia, Sonoma, Ventura, Monterey, Big Sur, Catalina & Mojave
- **Windows** 10 and 11 including TPM 2.0
- **Windows Server** 2022 2019 2016
- **ARM64 guest support** for running aarch64 VMs (native on ARM hosts, emulated on x86_64)
- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
flavours](https://ubuntu.com/download/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](https://wiki.qemu.org/Features/GuestAgent); 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](https://linuxmatters.sh) podcast!
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](https://linuxmatters.sh/30). <!-- and in [Episode 32 - Quick, quicker, quickest](https://linuxmatters.sh/32) [Martin](https://github.com/flexiondotorg) unveils macOS host support for [**Quickemu**](https://github.com/quickemu-project/quickemu), [Mark](https://github.com/marxjohnson) explains the origins of the [**Quickgui**](https://github.com/quickemu-project/quickgui) desktop app and upcoming improvements, and [Alan](https://github.com/popey) debuts [**Quicktest**](https://github.com/quickemu-project/quicktest); a framework for automatically testing operating systems via Quickemu -->
<div align="center">
<a href="https://linuxmatters.sh" target="_blank"><img src="https://github.com/wimpysworld/nix-config/raw/main/.github/screenshots/linuxmatters.png" alt="Linux Matters Podcast"/></a>
<br />
<em>Linux Matters Podcast</em>
</div>
# Quick start
[Once Quickemu is installed](https://github.com/quickemu-project/quickemu/wiki/01-Installation), 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.
``` shell
quickget nixos unstable minimal
```
- `quickemu` starts the virtual machine using the configuration file created by `quickget`.
``` shell
quickemu --vm nixos-unstable-minimal.conf
```
Execute `quickget` (with no arguments) to see a list of all the supported operating systems.
## Demo
<div align="center">
<a href="https://asciinema.org/a/658148?autoplay=1" target="_blank"><img src="https://asciinema.org/a/658148.svg" /></a>
</div>
# Documentation
The wiki describes how to get up and running with Quickemu and also covers more advanced configuration and usage.
- [**Installation**](https://github.com/quickemu-project/quickemu/wiki/01-Installation) 💾
- [**Create Linux virtual machines**](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines) 🐧
- [**Create macOS virtual machines**](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines) 🍏
- [**Create Windows virtual machines**](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟
- [**Advanced quickemu configuration**](https://github.com/quickemu-project/quickemu/wiki/05-Advanced-quickemu-configuration) 🔧
- [**Advanced quickget features**](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features) 🤓
- [**Alternative frontends**](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends) 🧑💻
- [**References**](https://github.com/quickemu-project/quickemu/wiki/08-References) 📚️
================================================
FILE: SECURITY.md
================================================
# Security Policy
## Supported Versions
Here are the versions of Quickemu currently being supported with security updates.
| Version | Supported |
| ------- | ------------------ |
| 4.9.x | :white_check_mark: |
| < 4.8 | :x: |
## Reporting a Vulnerability
If you discover a vulnerability in Quickemu then [file an issue](https://github.com/quickemu-project/quickemu/issues/new) and click *Report a vulnerability*.
- Quickemu is a spare-time hobby project.
- We do not have SLAs for responding to security issues.
- It is a best-efforts basis.
================================================
FILE: chunkcheck
================================================
#!/usr/bin/env python3
from pathlib import Path
import struct
import hashlib
import argparse
v1_prod_pubkey = 0xC3E748CAD9CD384329E10E25A91E43E1A762FF529ADE578C935BDDF9B13F2179D4855E6FC89E9E29CA12517D17DFA1EDCE0BEBF0EA7B461FFE61D94E2BDF72C196F89ACD3536B644064014DAE25A15DB6BB0852ECBD120916318D1CCDEA3C84C92ED743FC176D0BACA920D3FCF3158AFF731F88CE0623182A8ED67E650515F75745909F07D415F55FC15A35654D118C55A462D37A3ACDA08612F3F3F6571761EFCCBCC299AEE99B3A4FD6212CCFFF5EF37A2C334E871191F7E1C31960E010A54E86FA3F62E6D6905E1CD57732410A3EB0C6B4DEFDABE9F59BF1618758C751CD56CEF851D1C0EAA1C558E37AC108DA9089863D20E2E7E4BF475EC66FE6B3EFDCF
# v2_prod_pubkey = 0xCB45C5E53217D4499FB80B2D96AA4F964EB551F1DA4EBFA4F5E23F87BFE82FC113590E536757F329D6EAD1F267771EE342F5A5E61514DD3D3383187E663929D577D94648F262EBA1157E152DB5273D10AE3A6A058CB9CD64D01267DAC82ED3B7BC1631D078C911414129CDAAA0FFB0A8E2A7ADD6F32FB09A7E98D259BFF6ED10808D1BDA58CAF7355DFF1A085A18B11657D2617447BF657140D599364E5AC8E626276AC03BC2417831D9E61B25154AFE9F2D8271E9CE22D2783803083A5A7A575774688721097DC5E4B32D118CF6317A7083BA15BA608430A8C8C6B7DA2D932D81F571603A9363AC0197AB670242D9C9180D97A10900F11FE3D9246CF14F0883
# v2_dev_pubkey = 0xB372CEC9E05E71FB3FAA08C34E3256FB312EA821638A243EF8A5DEA46FCDA33F00F88FC2933FB276D37B914F89BAD5B5D75771E342265B771995AE8F43B4DFF3F21A877FE777A8B419587C8718D36204FA1922A575AD5207D5D6B8C10F84DDCA661B731E7E7601D64D4A894F487FE1AA1DDC2A1697A3553B1DD85D5750DF2AA9D988E83C4C70BBBE4747219F9B92B199FECB16091896EBB441606DEC20F446249D5568BB51FC87BA7F85E6295FBE811B0A314408CD31921C360608A0FF7F87BD733560FE1C96E472834CAB6BE016C35727754273125089BE043FD3B26F0B2DE141E05990CE922F1702DA0A2F4E9F8760D0FA712DDB9928E0CDAC14501ED5E2C3
ChunkListHeader = struct.Struct('<4sIBBBxQQQ')
assert ChunkListHeader.size == 0x24
Chunk = struct.Struct('<I32s')
assert Chunk.size == 0x24
def parse_chunklist(path):
with open(path, 'rb') as f:
hash_ctx = hashlib.sha256()
data = f.read(ChunkListHeader.size)
hash_ctx.update(data)
magic, header_size, file_version, chunk_method, signature_method, chunk_count, chunk_offset, signature_offset = ChunkListHeader.unpack(data)
assert magic == b'CNKL'
assert header_size == ChunkListHeader.size
assert file_version == 1
assert chunk_method == 1
assert signature_method in [1, 2]
assert chunk_count > 0
assert chunk_offset == 0x24
assert signature_offset == chunk_offset + Chunk.size * chunk_count
for i in range(chunk_count):
data = f.read(Chunk.size)
hash_ctx.update(data)
chunk_size, chunk_sha256 = Chunk.unpack(data)
yield chunk_size, chunk_sha256
digest = hash_ctx.digest()
if signature_method == 1:
data = f.read(256)
assert len(data) == 256
signature = int.from_bytes(data, 'little')
plaintext = 0x1ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff003031300d0609608648016503040201050004200000000000000000000000000000000000000000000000000000000000000000 | int.from_bytes(digest, 'big')
assert pow(signature, 0x10001, v1_prod_pubkey) == plaintext
elif signature_method == 2:
data = f.read(32)
assert data == digest
else:
raise NotImplementedError
assert f.read(1) == b''
def check_chunklist(path, chunklist_path):
with open(path, 'rb') as f:
for chunk_size, chunk_sha256 in parse_chunklist(chunklist_path):
chunk = f.read(chunk_size)
assert len(chunk) == chunk_size
assert hashlib.sha256(chunk).digest() == chunk_sha256
assert f.read(1) == b''
def main():
parser = argparse.ArgumentParser()
parser.add_argument('vmdir', type=Path)
args = parser.parse_args()
vmdir = args.vmdir
check_chunklist(vmdir / 'RecoveryImage.dmg', vmdir / 'RecoveryImage.chunklist')
if __name__ == "__main__":
main()
================================================
FILE: debian/changelog
================================================
quickemu (4.9.6-1) unstable; urgency=medium
* New upstream release.
-- Martin Wimpress <code@wimpress.io> Fri, 10 Nov 2023 14:49:08 +0000
================================================
FILE: debian/control
================================================
Source: quickemu
Section: utils
Priority: optional
Maintainer: Martin Wimpress <code@wimpress.io>
Build-Depends:
debhelper-compat (= 12),
Standards-Version: 4.5.1
Homepage: https://github.com/quickemu-project/quickemu
Vcs-Browser: https://github.com/quickemu-project/quickemu
Vcs-Git: https://github.com/quickemu-project/quickemu.git
Rules-Requires-Root: no
Package: quickemu
Architecture: all
Depends:
coreutils,
curl,
genisoimage,
jq,
mesa-utils,
pciutils,
procps,
python3-minimal,
qemu-system (>= 6.0),
base-files (<< 13~) | qemu-system-modules-spice,
socat,
spice-client-gtk,
swtpm,
usbutils,
util-linux,
uuid-runtime,
x11-xserver-utils,
xdg-user-dirs,
zsync,
${misc:Depends},
${shlibs:Depends},
Suggests:
virt-viewer,
Description: Quickemu creates and runs optimised virtual machines.
Simple script to "manage" Qemu virtual machines. Each virtual machine
configuration is a few lines long requiring minimal setup. The main objective
of the project is to enable quick testing of desktop Linux distributions where
the virtual machines configuration and disk images can be stored anywhere,
such as external USB storage or your home directory. Windows and macOS guests
are also supported.
.
================================================
FILE: debian/copyright
================================================
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: quickemu
Upstream-Contact: Martin Wimpress <code@wimpress.io>
Source: https://github.com/quickemu-project/quickemu
Files: *
Copyright: 2020-2024 Martin Wimpress <code@wimpress.io>
License: MIT
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# If you want to use GPL v2 or later for the /debian/* files use
# the following clauses, or change it to suit. Delete these two lines
Files: debian/*
Copyright: 2021 - 2024 Martin Wimpress <code@wimpress.io>
License: GPL-2+
This package is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.
This package is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>
.
On Debian systems, the complete text of the GNU General
Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".
================================================
FILE: debian/install
================================================
chunkcheck usr/bin
quickemu usr/bin
quickget usr/bin
quickreport usr/bin
================================================
FILE: debian/rules
================================================
#!/usr/bin/make -f
%:
dh $@
override_dh_builddeb:
dh_builddeb -- -Zgzip
================================================
FILE: debian/source/format
================================================
3.0 (native)
================================================
FILE: devshell.nix
================================================
{
lib,
mkShell,
pkgs,
stdenv,
OVMF ? null,
OVMFFull ? null,
}:
mkShell {
packages =
with pkgs;
(
[
cdrtools
curl
gawk
gnugrep
gnused
jq
pciutils
procps
python3
qemu_full
samba
socat
spice-gtk
swtpm
unzip
util-linux
xorg.xrandr
zsync
]
++ lib.optionals stdenv.hostPlatform.isLinux [
mesa-demos
usbutils
xdg-user-dirs
]
++ lib.optionals (OVMF != null && OVMFFull != null) [
OVMF
OVMFFull
]
);
inputsFrom = with pkgs; [
git
];
shellHook = ''
echo "**********************************************************************"
echo "* 'direnv reload' to update '.direnv/bin/quickemu' for testing *"
echo "**********************************************************************"
sed \
${
lib.optionalString (OVMF != null && OVMFFull != null) ''
-e '/OVMF_CODE_4M.secboot.fd/s|ovmfs=(|ovmfs=("${OVMFFull.firmware}","${OVMFFull.variablesMs}" |' \
-e '/OVMF_CODE_4M.fd/s|ovmfs=(|ovmfs=("${OVMF.firmware}","${OVMF.variables}" |' \
''
}${lib.optionalString stdenv.hostPlatform.isDarwin ''
-e 's|ovmfs=("[$][{]SHARE_PATH}/OVMF/OVMF_CODE_4M.secboot.fd"|ovmfs=("${pkgs.qemu_full}/share/qemu/edk2-x86_64-secure-code.fd","${pkgs.qemu_full}/share/qemu/edk2-i386-vars.fd" "''${SHARE_PATH}/OVMF/OVMF_CODE_4M.secboot.fd"|' \
-e 's|ovmfs=("[$][{]SHARE_PATH}/OVMF/OVMF_CODE_4M.fd"|ovmfs=("${pkgs.qemu_full}/share/qemu/edk2-x86_64-code.fd","${pkgs.qemu_full}/share/qemu/edk2-i386-vars.fd" "''${SHARE_PATH}/OVMF/OVMF_CODE_4M.fd"|' \
-e 's|ovmfs=("/usr/share/AAVMF/AAVMF_CODE.fd"|ovmfs=("${pkgs.qemu_full}/share/qemu/edk2-aarch64-code.fd","${pkgs.qemu_full}/share/qemu/edk2-arm-vars.fd" "/usr/share/AAVMF/AAVMF_CODE.fd"|' \
''} \
-e '/cp "''${VARS_IN}" "''${VARS_OUT}"/a chmod +w "''${VARS_OUT}"' \
-e 's,\$(command -v smbd),${pkgs.samba}/bin/smbd,' \
quickemu > $PWD/.direnv/bin/quickemu
chmod +x $PWD/.direnv/bin/quickemu
'';
}
================================================
FILE: docs/Makefile
================================================
include pandoc-man.mk
ifeq ($(PREFIX),)
PREFIX := /usr/local
endif
datarootdir := $(PREFIX)/share
datadir := $(datarootdir)
mandir := $(datarootdir)/man
bindir := $(PREFIX)/bin
all: quickget.1 quickemu.1 quickemu_conf.5
clean:
rm *.1 *.5
install_docs: all
install -d $(DESTDIR)$(mandir)/man1
install -d $(DESTDIR)$(mandir)/man5
install -m 644 quickget.1 $(DESTDIR)$(mandir)/man1
install -m 644 quickemu.1 $(DESTDIR)$(mandir)/man1
install -m 644 quickemu_conf.5 $(DESTDIR)$(mandir)/man5
rm -f $(DESTDIR)$(mandir)/man1/quickemu_conf.1
# install -m 644 quickgui.1 $(DESTDIR)$(mandir)/man1
install_bins:
install -d $(DESTDIR)$(bindir)
install -m 755 ../quickget $(DESTDIR)$(bindir)
install -m 755 ../quickemu $(DESTDIR)$(bindir)
install -m 755 ../quickreport $(DESTDIR)$(bindir)
install -m 755 ../chunkcheck $(DESTDIR)$(bindir)
install: install_bins install_docs
uninstall::
rm -f $(DESTDIR)$(mandir)/man1/quickget.1
rm -f $(DESTDIR)$(mandir)/man1/quickemu.1
rm -f $(DESTDIR)$(mandir)/man5/quickemu_conf.5
rm -f $(DESTDIR)$(bindir)/quickget
rm -f $(DESTDIR)$(bindir)/quickemu
rm -f $(DESTDIR)$(bindir)/quickreport
rm -f $(DESTDIR)$(bindir)/macrecovery
rm -f $(DESTDIR)$(bindir)/chunkcheck
.PHONY: all
================================================
FILE: docs/pandoc-man.mk
================================================
PANDOC ?= pandoc
PANDOC_OPTIONS = -f gfm+definition_lists
.SUFFIXES: .1.md .1 .5.md .5
.1.md.1 .5.md.5:
$(PANDOC) --standalone $(PANDOC_OPTIONS) --to man -o $@ $<
================================================
FILE: docs/quickemu.1
================================================
.\" Automatically generated by Pandoc 3.8.3
.\"
.TH "QUICKEMU" "1" "February 2, 2026" "quickemu" "Quickemu User Manual"
.SH NAME
quickemu \- A quick VM builder and manager
.SH SYNOPSIS
\f[B]quickemu\f[R] [\f[I]OPTION\f[R]]...
.SH DESCRIPTION
\f[B]quickemu\f[R] will create and run highly optimised desktop virtual
machines for Linux, macOS and Windows
.SH OPTIONS
.TP
\f[B]\-\-vm\f[R]
vm configuration file
.PP
You can also pass optional parameters
.TP
\f[B]\-\-access\f[R]
Enable remote spice access support.
\(aqlocal\(aq (default), \(aqremote\(aq, \(aqclientipaddress\(aq
.TP
\f[B]\-\-braille\f[R]
Enable braille support.
Requires SDL.
.TP
\f[B]\-\-delete\-disk\f[R]
Delete the disk image and EFI variables
.TP
\f[B]\-\-delete\-vm\f[R]
Delete the entire VM and its configuration
.TP
\f[B]\-\-display\f[R]
Select display backend.
\(aqgtk\(aq (default), \(aqsdl\(aq, \(aqcocoa\(aq, \(aqnone\(aq,
\(aqspice\(aq or \(aqspice\-app\(aq
.TP
\f[B]\-\-fullscreen\f[R]
Starts VM in full screen mode (Ctl+Alt+f to exit)
.TP
\f[B]\-\-ignore\-msrs\-always\f[R]
Configure KVM to always ignore unhandled machine\-specific registers
.TP
\f[B]\-\-kill\f[R]
Kill the VM process if it is running
.TP
\f[B]\-\-offline\f[R]
Override all network settings and start the VM offline
.TP
\f[B]\-\-shortcut\f[R]
Create a desktop shortcut
.TP
\f[B]\-\-snapshot apply <tag>\f[R]
Apply/restore a snapshot.
.TP
\f[B]\-\-snapshot create <tag>\f[R]
Create a snapshot.
.TP
\f[B]\-\-snapshot delete <tag>\f[R]
Delete a snapshot.
.TP
\f[B]\-\-snapshot info\f[R]
Show disk/snapshot info.
.TP
\f[B]\-\-status\-quo\f[R]
Do not commit any changes to disk/snapshot.
.TP
\f[B]\-\-viewer <viewer>\f[R]
Choose an alternative viewer.
\(atOptions: \(aqspicy\(aq (default), \(aqremote\-viewer\(aq,
\(aqnone\(aq
.TP
\f[B]\-\-width <width>\f[R]
Set VM screen width; requires \(aq\-\-height\(aq
.TP
\f[B]\-\-height <height>\f[R]
Set VM screen height; requires \(aq\-\-width\(aq
.TP
\f[B]\-\-ssh\-port <port>\f[R]
Set SSH port manually
.TP
\f[B]\-\-spice\-port <port>\f[R]
Set SPICE port manually
.TP
\f[B]\-\-public\-dir <path>\f[R]
Expose share directory.
\(atOptions: \(aq\(aq (default: xdg\-user\-dir PUBLICSHARE), \(aq\(aq,
\(aqnone\(aq
.TP
\f[B]\-\-monitor <type>\f[R]
Set monitor connection type.
\(atOptions: \(aqsocket\(aq (default), \(aqtelnet\(aq, \(aqnone\(aq
.TP
\f[B]\-\-monitor\-telnet\-host <ip/host>\f[R]
Set telnet host for monitor.
(default: \(aqlocalhost\(aq)
.TP
\f[B]\-\-monitor\-telnet\-port <port>\f[R]
Set telnet port for monitor.
(default: \(aq4440\(aq)
.TP
\f[B]\-\-monitor\-cmd <cmd>\f[R]
Send command to monitor if available.
(Example: system_powerdown)
.TP
\f[B]\-\-serial <type>\f[R]
Set serial connection type.
\(atOptions: \(aqsocket\(aq (default), \(aqtelnet\(aq, \(aqnone\(aq
.TP
\f[B]\-\-serial\-telnet\-host <ip/host>\f[R]
Set telnet host for serial.
(default: \(aqlocalhost\(aq)
.TP
\f[B]\-\-serial\-telnet\-port <port>\f[R]
Set telnet port for serial.
(default: \(aq6660\(aq)
.TP
\f[B]\-\-keyboard <type>\f[R]
Set keyboard.
\(atOptions: \(aqusb\(aq (default), \(aqps2\(aq, \(aqvirtio\(aq
.TP
\f[B]\-\-keyboard_layout <layout>\f[R]
Set keyboard layout: \(aqen\-us\(aq (default)
.TP
\f[B]\-\-mouse <type>\f[R]
Set mouse.
\(atOptions: \(aqtablet\(aq (default), \(aqps2\(aq, \(aqusb\(aq,
\(aqvirtio\(aq
.TP
\f[B]\-\-usb\-controller <type>\f[R]
Set usb\-controller.
\(atOptions: \(aqehci\(aq (default), \(aqxhci\(aq, \(aqnone\(aq
.TP
\f[B]\-\-sound\-card <type>\f[R]
Set sound card.
\(atOptions: \(aqintel\-hda\(aq (default), \(aqac97\(aq, \(aqes1370\(aq,
\(aqsb16\(aq, \(aqnone\(aq
.TP
\f[B]\-\-extra_args <arguments>\f[R]
Pass additional arguments to qemu
.TP
\f[B]\-\-version\f[R]
Print version
.SH EXAMPLES
.TP
\f[B]quickemu \-\-vm ubuntu\-mate\-22.04.conf\f[R]
Launches the VM specified in the file \f[I]ubuntu\-mate\-22.04.conf\f[R]
.SH Introduction
\f[B]Quickemu\f[R] is a wrapper for the excellent \c
.UR https://www.qemu.org/
QEMU
.UE \c
\ that automatically \f[I]\(dqdoes the right thing\(dq\f[R] 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 🤖
.IP \(bu 2
\f[CR]quickget\f[R] \f[B]automatically downloads the upstream OS\f[R]
and creates the configuration 📀
.IP \(bu 2
\f[CR]quickemu\f[R] enumerates your hardware and launches the virtual
machine with the \f[B]optimum configuration best suited to your
computer\f[R] ⚡️
.PP
The original objective of the project was to \c
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines
enable quick testing of Linux distributions
.UE \c
\ 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.
.PP
\f[B]Today, Quickemu includes comprehensive support for \c
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines
macOS
.UE \c
, \c
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
Windows
.UE \c
\f[R], most of the BSDs, novel non\-Linux operating systems such as
FreeDOS, Haiku, KolibriOS, OpenIndiana, ReactOS, and more.
.SH Features
.IP \(bu 2
Host support for \f[B]Linux and macOS\f[R]
.IP \(bu 2
\f[B]macOS\f[R] Sequoia, Sonoma, Ventura, Monterey, Big Sur, Catalina &
Mojave
.IP \(bu 2
\f[B]Windows\f[R] 10 and 11 including TPM 2.0
.IP \(bu 2
\f[B]Windows Server\f[R] 2022 2019 2016
.IP \(bu 2
\f[B]ARM64 guest support\f[R] for running aarch64 VMs (native on ARM
hosts, emulated on x86_64)
.IP \(bu 2
\c
.UR https://ubuntu.com/desktop
Ubuntu
.UE \c
\ and all the \f[B]\c
.UR https://ubuntu.com/download/flavours
official Ubuntu flavours
.UE \c
\f[R]
.IP \(bu 2
\f[B]Nearly 1000 operating system editions are supported!\f[R]
.IP \(bu 2
Full SPICE support including host/guest clipboard sharing
.IP \(bu 2
VirtIO\-webdavd file sharing for Linux and Windows guests
.IP \(bu 2
VirtIO\-9p file sharing for Linux and macOS guests
.IP \(bu 2
\c
.UR https://wiki.qemu.org/Features/GuestAgent
QEMU Guest Agent support
.UE \c
; provides access to a system\-level agent via standard QMP commands
.IP \(bu 2
Samba file sharing for Linux, macOS and Windows guests (\f[I]if
\f[CI]smbd\f[I] is installed on the host\f[R])
.IP \(bu 2
VirGL acceleration
.IP \(bu 2
USB device pass\-through
.IP \(bu 2
Smartcard pass\-through
.IP \(bu 2
Automatic SSH port forwarding to guests
.IP \(bu 2
Network port forwarding
.IP \(bu 2
Full duplex audio
.IP \(bu 2
Braille support
.IP \(bu 2
EFI (with or without SecureBoot) and Legacy BIOS boot
.SS As featured on \c
.UR https://linuxmatters.sh
Linux Matters
.UE \c
\ podcast!
The presenters of Linux Matters 🐧🎙️ are the creators of each of the
principal Quickemu projects.
We discussed Quickemu\(aqs 2024 reboot in \c
.UR https://linuxmatters.sh/30
Episode 30 \- Quickemu Rising From the Bashes
.UE \c
\&.
.PP
\ Linux Matters Podcast
.PP
When installing from source, you will need to install the following
requirements manually:
.IP \(bu 2
\c
.UR https://www.qemu.org/
QEMU
.UE \c
\ (\f[I]6.0.0 or newer\f[R]) \f[B]with GTK, SDL, SPICE & VirtFS
support\f[R]
.IP \(bu 2
\c
.UR https://www.gnu.org/software/bash/
bash
.UE \c
\ (\f[I]4.0 or newer\f[R])
.IP \(bu 2
\c
.UR https://www.gnu.org/software/coreutils/
Coreutils
.UE \c
.IP \(bu 2
\c
.UR https://curl.se/
curl
.UE \c
.IP \(bu 2
\c
.UR https://github.com/tianocore/edk2
EDK II
.UE \c
.IP \(bu 2
\c
.UR https://www.gnu.org/software/gawk/
gawk
.UE \c
.IP \(bu 2
\c
.UR https://www.gnu.org/software/grep/
grep
.UE \c
.IP \(bu 2
\c
.UR https://gitlab.freedesktop.org/mesa/demos
glxinfo
.UE \c
.IP \(bu 2
\c
.UR https://stedolan.github.io/jq/
jq
.UE \c
.IP \(bu 2
\c
.UR https://wiki.linuxfoundation.org/lsb/start
LSB
.UE \c
.IP \(bu 2
\c
.UR https://github.com/pciutils/pciutils
pciutils
.UE \c
.IP \(bu 2
\c
.UR https://gitlab.com/procps-ng/procps
procps
.UE \c
.IP \(bu 2
\c
.UR https://www.python.org/
python3
.UE \c
.IP \(bu 2
\c
.UR http://cdrtools.sourceforge.net/private/cdrecord.html
mkisofs
.UE \c
.IP \(bu 2
\c
.UR https://github.com/gregkh/usbutils
usbutils
.UE \c
.IP \(bu 2
\c
.UR https://github.com/karelzak/util-linux
util\-linux
.UE \c
; including \f[CR]uuidgen\f[R]
.IP \(bu 2
\c
.UR https://www.gnu.org/software/sed/
sed
.UE \c
.IP \(bu 2
\c
.UR http://www.dest-unreach.org/socat/
socat
.UE \c
.IP \(bu 2
\c
.UR https://gitlab.freedesktop.org/spice/spice-gtk
spicy
.UE \c
.IP \(bu 2
\c
.UR https://github.com/stefanberger/swtpm
swtpm
.UE \c
.IP \(bu 2
\c
.UR https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
xdg\-user\-dirs
.UE \c
.IP \(bu 2
\c
.UR https://gitlab.freedesktop.org/xorg/app/xrandr
xrandr
.UE \c
.IP \(bu 2
\c
.UR http://zsync.moria.org.uk/
zsync
.UE \c
.IP \(bu 2
\c
.UR http://www.info-zip.org/UnZip.html
unzip
.UE \c
.PP
For Ubuntu, Debian, Fedora, Arch and NixOS hosts the native packaging or
\c
.UR https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu
ppa
.UE \c
, \c
.UR https://aur.archlinux.org/packages/quickemu
AUR
.UE \c
\ or \c
.UR https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu
nix
.UE \c
\ 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.
.PP
These examples may save a little typing:
.SS Install requirements on Debian hosts
These should be handled by dependencies in Trixie and later.
For earlier versions (and their derivatives):
.IP
.EX
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
.EE
.SS Install requirements on Fedora hosts
These are handled natively for Fedora 41 on.
For earlier versions:
.IP
.EX
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
.EE
.SS Install requirements on Gentoo
Please note that you may have to use \f[CR]sys\-firmware/edk2\-ovmf\f[R]
instead of \f[CR]sys\-firmware/edk2\-ovmf\-bin\f[R] \- depending on how
your system is configured.
.IP
.EX
sudo emerge \-\-ask \-\-noreplace app\-emulation/qemu \(rs
app\-shells/bash \(rs
sys\-apps/coreutils \(rs
net\-misc/curl \(rs
sys\-firmware/edk2\-ovmf\-bin \(rs
sys\-apps/gawk \(rs
sys\-apps/grep \(rs
x11\-apps/mesa\-progs \(rs
app\-misc/jq \(rs
sys\-apps/pciutils \(rs
sys\-process/procps \(rs
app\-cdr/cdrtools \(rs
sys\-apps/usbutils \(rs
sys\-apps/util\-linux \(rs
sys\-apps/sed \(rs
net\-misc/socat \(rs
app\-emulation/spice \(rs
app\-crypt/swtpm \(rs
x11\-misc/xdg\-user\-dirs \(rs
x11\-apps/xrandr \(rs
net\-misc/zsync \(rs
app\-arch/unzip
.EE
.SS Install requirements on macOS hosts
Install the Quickemu requirements using brew:
.IP
.EX
brew install bash cdrtools coreutils jq python3 qemu usbutils samba socat swtpm zsync
.EE
.PP
Now clone the project:
.IP
.EX
git clone https://github.com/quickemu\-project/quickemu
cd quickemu
.EE
.SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends
Alternative Frontends
.UE \c
.SS Quickgui
While \f[CR]quickemu\f[R] and \f[CR]quickget\f[R] are designed for the
terminal, a graphical user interface is also available:
.IP \(bu 2
\f[B]\c
.UR https://github.com/quickemu-project/quickgui
Quickgui
.UE \c
\f[R] by \c
.UR https://github.com/marxjohnson
Mark Johnson
.UE \c
\ and \c
.UR https://github.com/ymauray
Yannick Mauray
.UE \c
\&.
.PP
To install Quickgui on Ubuntu:
.IP
.EX
sudo add\-apt\-repository ppa:yannick\-mauray/quickgui
sudo apt update
sudo apt install quickgui
.EE
.PP
Many thanks to \c
.UR https://github.com/Lukewh
Luke Wesley\-Holley
.UE \c
\ and \c
.UR https://github.com/daPhipz
Philipp Kiemle
.UE \c
\ for creating the \f[B]\c
.UR https://github.com/Lukewh/quickemu-icons
Quickemu icons
.UE \c
\f[R] 🎨
.SS Creating Linux guests 🐧
.SS Ubuntu
\f[CR]quickget\f[R] will automatically download an Ubuntu release and
create the virtual machine configuration.
.IP
.EX
quickget ubuntu 22.04
quickemu \-\-vm ubuntu\-22.04.conf
.EE
.IP \(bu 2
Complete the installation as normal.
.IP \(bu 2
Post\-install:
.RS 2
.IP \(bu 2
Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
enable copy/paste and USB redirection
.RS 2
.IP \(bu 2
\f[CR]sudo apt install spice\-vdagent\f[R]
.RE
.IP \(bu 2
Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
to enable file sharing.
.RS 2
.IP \(bu 2
\f[CR]sudo apt install spice\-webdavd\f[R]
.RE
.RE
.SS Ubuntu daily\-live images
\f[CR]quickget\f[R] can also download/refresh daily\-live images via
\f[CR]zsync\f[R] for Ubuntu developers and testers.
.IP
.EX
quickget ubuntu daily\-live
quickemu \-\-vm ubuntu\-daily\-live.conf
.EE
.PP
You can run \f[CR]quickget ubuntu daily\-live\f[R] to refresh your daily
development image as often as you like, it will even automatically
switch to a new series.
.SS Ubuntu Flavours
All the official Ubuntu flavours are supported, just replace
\f[CR]ubuntu\f[R] with your preferred flavour.
.PP
The project \c
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines
wiki
.UE \c
\ may have further information.
.IP \(bu 2
\f[CR]edubuntu\f[R] (Edubuntu)
.IP \(bu 2
\f[CR]kubuntu\f[R] (Kubuntu)
.IP \(bu 2
\f[CR]lubuntu\f[R] (Lubuntu)
.IP \(bu 2
\f[CR]ubuntu\-budgie\f[R] (Ubuntu Budgie)
.IP \(bu 2
\f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
.IP \(bu 2
\f[CR]ubuntukylin\f[R] (Ubuntu Kylin)
.IP \(bu 2
\f[CR]ubuntu\-mate\f[R] (Ubuntu MATE)
.IP \(bu 2
\f[CR]ubuntu\-server\f[R] (Ubuntu Server)
.IP \(bu 2
\f[CR]ubuntustudio\f[R] (Ubuntu Studio)
.IP \(bu 2
\f[CR]ubuntu\f[R] (Ubuntu)
.IP \(bu 2
\f[CR]ubuntu\-unity\f[R] (Ubuntu Unity)
.IP \(bu 2
\f[CR]xubuntu\f[R] (Xubuntu)
.PP
You can also use \f[CR]quickget\f[R] with advanced options :
.IP
.EX
\-\-arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
\-\-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
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Flags \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-create\-config:
\-\-disable\-unattended : Force quickget not to set up an unattended installation
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- For testing & development \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-url [os] [release] [edition] : Show image URL(s)
\-\-check [os] [release] [edition] : Check image URL(s)
\-\-check\-all\-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
\-\-list : List all supported systems
\-\-list\-csv : List everything in csv format
\-\-list\-json : List everything in json format
.EE
.PP
Here are some typical uses
.IP
.EX
# 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
.EE
.PP
The \f[CR]\-\-url\f[R], \f[CR]\-\-check\f[R], and
\f[CR]\-\-download\f[R] options are fully functional for all operating
systems, including Windows and macOS.
.PP
Further information is available from the project \c
.UR https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features
wiki
.UE \c
.SS Other Operating Systems
\f[CR]quickget\f[R] also supports:
.IP \(bu 2
\f[CR]alma\f[R] (AlmaLinux)
.IP \(bu 2
\f[CR]alpine\f[R] (Alpine Linux)
.IP \(bu 2
\f[CR]android\f[R] (Android x86)
.IP \(bu 2
\f[CR]antix\f[R] (Antix)
.IP \(bu 2
\f[CR]archcraft\f[R] (Archcraft)
.IP \(bu 2
\f[CR]archlinux\f[R] (Arch Linux)
.IP \(bu 2
\f[CR]artixlinux\f[R] (Artix Linux)
.IP \(bu 2
\f[CR]azurelinux\f[R] (Azure Linux)
.IP \(bu 2
\f[CR]batocera\f[R] (Batocera)
.IP \(bu 2
\f[CR]bazzite\f[R] (Bazzite)
.IP \(bu 2
\f[CR]biglinux\f[R] (BigLinux)
.IP \(bu 2
\f[CR]blendos\f[R] (BlendOS)
.IP \(bu 2
\f[CR]bodhi\f[R] (Bodhi)
.IP \(bu 2
\f[CR]bunsenlabs\f[R] (BunsenLabs)
.IP \(bu 2
\f[CR]cachyos\f[R] (CachyOS)
.IP \(bu 2
\f[CR]centos\-stream\f[R] (CentOS Stream)
.IP \(bu 2
\f[CR]chimeralinux\f[R] (Chimera Linux)
.IP \(bu 2
\f[CR]crunchbang++\f[R] (Crunchbangplusplus)
.IP \(bu 2
\f[CR]debian\f[R] (Debian)
.IP \(bu 2
\f[CR]deepin\f[R] (Deepin)
.IP \(bu 2
\f[CR]devuan\f[R] (Devuan)
.IP \(bu 2
\f[CR]dragonflybsd\f[R] (DragonFlyBSD)
.IP \(bu 2
\f[CR]easyos\f[R] (EasyOS)
.IP \(bu 2
\f[CR]elementary\f[R] (elementary OS)
.IP \(bu 2
\f[CR]endeavouros\f[R] (EndeavourOS)
.IP \(bu 2
\f[CR]endless\f[R] (Endless OS)
.IP \(bu 2
\f[CR]fedora\f[R] (Fedora)
.IP \(bu 2
\f[CR]freebsd\f[R] (FreeBSD)
.IP \(bu 2
\f[CR]freedos\f[R] (FreeDOS)
.IP \(bu 2
\f[CR]garuda\f[R] (Garuda Linux)
.IP \(bu 2
\f[CR]gentoo\f[R] (Gentoo)
.IP \(bu 2
\f[CR]ghostbsd\f[R] (GhostBSD)
.IP \(bu 2
\f[CR]gnomeos\f[R] (GNOME OS)
.IP \(bu 2
\f[CR]guix\f[R] (Guix)
.IP \(bu 2
\f[CR]haiku\f[R] (Haiku)
.IP \(bu 2
\f[CR]kali\f[R] (Kali)
.IP \(bu 2
\f[CR]kdeneon\f[R] (KDE Neon)
.IP \(bu 2
\f[CR]kolibrios\f[R] (KolibriOS)
.IP \(bu 2
\f[CR]linuxlite\f[R] (Linux Lite)
.IP \(bu 2
\f[CR]linuxmint\f[R] (Linux Mint)
.IP \(bu 2
\f[CR]lmde\f[R] (Linux Mint Debian Edition)
.IP \(bu 2
\f[CR]maboxlinux\f[R] (Mabox Linux)
.IP \(bu 2
\f[CR]mageia\f[R] (Mageia)
.IP \(bu 2
\f[CR]manjaro\f[R] (Manjaro)
.IP \(bu 2
\f[CR]mxlinux\f[R] (MX Linux)
.IP \(bu 2
\f[CR]netboot\f[R] (netboot.xyz)
.IP \(bu 2
\f[CR]netbsd\f[R] (NetBSD)
.IP \(bu 2
\f[CR]nitrux\f[R] (Nitrux)
.IP \(bu 2
\f[CR]nixos\f[R] (NixOS)
.IP \(bu 2
\f[CR]nwg\-shell\f[R] (nwg\-shell)
.IP \(bu 2
\f[CR]openbsd\f[R] (OpenBSD)
.IP \(bu 2
\f[CR]openindiana\f[R] (OpenIndiana)
.IP \(bu 2
\f[CR]opensuse\f[R] (openSUSE)
.IP \(bu 2
\f[CR]oraclelinux\f[R] (Oracle Linux)
.IP \(bu 2
\f[CR]parrotsec\f[R] (Parrot Security)
.IP \(bu 2
\f[CR]pclinuxos\f[R] (PCLinuxOS)
.IP \(bu 2
\f[CR]peppermint\f[R] (PeppermintOS)
.IP \(bu 2
\f[CR]popos\f[R] (Pop!_OS)
.IP \(bu 2
\f[CR]porteus\f[R] (Porteus)
.IP \(bu 2
\f[CR]primtux\f[R] (PrimTux)
.IP \(bu 2
\f[CR]proxmox\-ve\f[R] (Proxmox VE)
.IP \(bu 2
\f[CR]pureos\f[R] (PureOS)
.IP \(bu 2
\f[CR]reactos\f[R] (ReactOS)
.IP \(bu 2
\f[CR]rebornos\f[R] (RebornOS)
.IP \(bu 2
\f[CR]rockylinux\f[R] (Rocky Linux)
.IP \(bu 2
\f[CR]siduction\f[R] (Siduction)
.IP \(bu 2
\f[CR]slackware\f[R] (Slackware)
.IP \(bu 2
\f[CR]slax\f[R] (Slax)
.IP \(bu 2
\f[CR]slint\f[R] (Slint)
.IP \(bu 2
\f[CR]slitaz\f[R] (SliTaz)
.IP \(bu 2
\f[CR]solus\f[R] (Solus)
.IP \(bu 2
\f[CR]sparkylinux\f[R] (SparkyLinux)
.IP \(bu 2
\f[CR]spirallinux\f[R] (SpiralLinux)
.IP \(bu 2
\f[CR]tails\f[R] (Tails)
.IP \(bu 2
\f[CR]tinycore\f[R] (Tiny Core Linux)
.IP \(bu 2
\f[CR]trisquel\f[R] (Trisquel)
.IP \(bu 2
\f[CR]tuxedo\-os\f[R] (Tuxedo OS)
.IP \(bu 2
\f[CR]vanillaos\f[R] (Vanilla OS)
.IP \(bu 2
\f[CR]void\f[R] (Void Linux)
.IP \(bu 2
\f[CR]zorin\f[R] (Zorin OS)
.SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests
Custom Linux guests
.UE \c
Or you can download a Linux image and manually create a VM
configuration.
.IP \(bu 2
Download a .iso image of a Linux distribution
.IP \(bu 2
Create a VM configuration file; for example
\f[CR]debian\-bullseye.conf\f[R]
.IP
.EX
guest_os=\(dqlinux\(dq
disk_img=\(dqdebian\-bullseye/disk.qcow2\(dq
iso=\(dqdebian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso\(dq
.EE
.IP \(bu 2
Use \f[CR]quickemu\f[R] to start the virtual machine:
.IP
.EX
quickemu \-\-vm debian\-bullseye.conf
.EE
.IP \(bu 2
Complete the installation as normal.
.IP \(bu 2
Post\-install:
.RS 2
.IP \(bu 2
Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
enable copy/paste and USB redirection.
.IP \(bu 2
Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
to enable file sharing.
.RE
.SS Supporting old Linux distros
If you want to run an old Linux , from 2016 or earlier, change the
\f[CR]guest_os\f[R] to \f[CR]linux_old\f[R].
This will enable the \f[CR]vmware\-svga\f[R] graphics driver which is
better supported on older distros.
.SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
Creating macOS Guests
.UE \c
\ 🍏
\f[B]Installing macOS in a VM can be a bit finicky, if you encounter
problems, \c
.UR https://github.com/quickemu-project/quickemu/discussions
check the Discussions
.UE \c
\ for solutions or ask for help there\f[R] 🛟
.PP
\f[CR]quickget\f[R] automatically downloads a macOS recovery image and
creates a virtual machine configuration.
.PP
Note: Some VPN users may need to \c
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235
turn off their VPN
.UE \c
\ in order to download a recovery image.
Some other users may find \c
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013
using a VPN
.UE \c
\ necessary in order to download a recovery image.
.IP
.EX
quickget macos big\-sur
quickemu \-\-vm macos\-big\-sur.conf
.EE
.PP
macOS \f[CR]mojave\f[R], \f[CR]catalina\f[R], \f[CR]big\-sur\f[R],
\f[CR]monterey\f[R], \f[CR]ventura\f[R] and \f[CR]sonoma\f[R] are
supported.
.IP \(bu 2
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
.IP \(bu 2
From \f[B]macOS Utilities\f[R]
.RS 2
.IP \(bu 2
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2
.IP \(bu 2
Select \f[CR]QEMU HARDDISK Media\f[R] (\(ti103.08GB) from the list (on
Big Sur and above use \f[CR]Apple Inc. VirtIO Block Device\f[R]) and
click \f[B]Erase\f[R].
.IP \(bu 2
Enter a \f[CR]Name:\f[R] for the disk
.IP \(bu 2
If you are installing macOS Mojave or later (Catalina, Big Sur,
Monterey, Ventura and Sonoma), choose any of the APFS options as the
filesystem.
MacOS Extended may not work.
.RE
.IP \(bu 2
Click \f[B]Erase\f[R].
.IP \(bu 2
Click \f[B]Done\f[R].
.IP \(bu 2
Close Disk Utility
.RE
.IP \(bu 2
From \f[B]macOS Utilities\f[R]
.RS 2
.IP \(bu 2
Click \f[B]Reinstall macOS\f[R] and \f[B]Continue\f[R]
.RE
.IP \(bu 2
Complete the installation as you normally would.
.RS 2
.IP \(bu 2
On the first reboot use cursor keys and enter key to select \f[B]macOS
Installer\f[R]
.IP \(bu 2
On the subsequent reboots use cursor keys and enter key to select the
disk you named
.RE
.IP \(bu 2
Once you have finished installing macOS you will be presented with an
the out\-of\-the\-box first\-start wizard to configure various options
and set up your username and password
.IP \(bu 2
OPTIONAL: After you have concluded the out\-of\-the\-box wizard, you may
want to enable the TRIM feature that the computer industry created for
SSD disks.
This feature in our macOS installation will allow QuickEmu to compact
(shrink) your macOS disk image whenever you delete files inside the
Virtual Machine.
Without this step your macOS disk image will only ever get larger and
will not shrink even when you delete lots of data inside macOS.
.RS 2
.IP \(bu 2
To enable TRIM, open the Terminal application and type the following
command followed by pressing enter to tell macos to use the TRIM command
on the hard disk when files are deleted:
.RE
.IP
.EX
sudo trimforce enable
.EE
.PP
You will be prompted to enter your account\(aqs password to gain the
privilege needed.
Once you\(aqve 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 \(dqyes\(dq response) followed by enter to confirm.
.PP
If you press enter without first typing y the system will consider that
a negative response as though you said \(dqno\(dq:
.IP
.EX
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 \(dqas is\(dq 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)?
.EE
.PP
And a second confirmation once you\(aqve confirmed the previous one:
.IP
.EX
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
.EE
.PP
As the last message states, your system will automatically reboot as
soon as the command completes.
.PP
The default macOS configuration looks like this:
.IP
.EX
guest_os=\(dqmacos\(dq
img=\(dqmacos\-big\-sur/RecoveryImage.img\(dq
disk_img=\(dqmacos\-big\-sur/disk.qcow2\(dq
macos_release=\(dqbig\-sur\(dq
.EE
.IP \(bu 2
\f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for
macOS.
.IP \(bu 2
\f[CR]macos_release=\(dqbig\-sur\(dq\f[R] instructs Quickemu to optimise
for a particular macOS release.
.RS 2
.IP \(bu 2
For example VirtIO Network and Memory Ballooning are available in Big
Sur and newer, but not previous releases.
.IP \(bu 2
And VirtIO Block Media (disks) are supported/stable in Catalina and
newer.
.RE
.SH macOS compatibility
There are some considerations when running macOS via Quickemu.
.IP \(bu 2
Supported macOS releases:
.RS 2
.IP \(bu 2
Mojave
.IP \(bu 2
Catalina
.IP \(bu 2
Big Sur
.IP \(bu 2
Monterey
.IP \(bu 2
Ventura
.IP \(bu 2
Sonoma
.RE
.IP \(bu 2
\f[CR]quickemu\f[R] will automatically download the required \c
.UR https://github.com/acidanthera/OpenCorePkg
OpenCore
.UE \c
\ bootloader and OVMF firmware from \c
.UR https://github.com/kholia/OSX-KVM
OSX\-KVM
.UE \c
\&.
.IP \(bu 2
Optimised by default, but no GPU acceleration is available.
.RS 2
.IP \(bu 2
Host CPU vendor is detected and guest CPU is optimised accordingly.
.IP \(bu 2
\c
.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
VirtIO Block Media
.UE \c
\ is used for the system disk where supported.
.IP \(bu 2
\c
.UR http://philjordan.eu/osx-virt/
VirtIO \f[CR]usb\-tablet\f[R]
.UE \c
\ is used for the mouse.
.IP \(bu 2
VirtIO Network (\f[CR]virtio\-net\f[R]) is supported and enabled on
macOS Big Sur and newer, but earlier releases use \f[CR]vmxnet3\f[R].
.IP \(bu 2
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
newer but disabled for other support macOS releases.
.RE
.IP \(bu 2
USB host and SPICE pass\-through is:
.RS 2
.IP \(bu 2
UHCI (USB 2.0) on macOS Catalina and earlier.
.IP \(bu 2
XHCI (USB 3.0) on macOS Big Sur and newer.
.RE
.IP \(bu 2
Display resolution can be changed via \f[CR]quickemu\f[R] using
\f[CR]\-\-width\f[R] and \f[CR]\-\-height\f[R] command line arguments.
.IP \(bu 2
\f[B]Full Duplex audio requires \c
.UR https://github.com/chris1111/VoodooHDA-OC
VoodooHDA OC
.UE \c
\ or pass\-through a USB audio\-device to the macOS guest VM\f[R].
.RS 2
.IP \(bu 2
NOTE!
\c
.UR https://disable-gatekeeper.github.io/
Gatekeeper
.UE \c
\ and \c
.UR https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection
System Integrity Protection (SIP)
.UE \c
\ need to be disabled to install VoodooHDA OC
.RE
.IP \(bu 2
File sharing between guest and host is available via \c
.UR https://wiki.qemu.org/Documentation/9psetup
virtio\-9p
.UE \c
\ and \c
.UR https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24
SPICE webdavd
.UE \c
\&.
.IP \(bu 2
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
.SH macOS App Store
If you see \f[I]\(dqYour device or computer could not be
verified\(dq\f[R] when you try to login to the App Store, make sure that
your wired ethernet device is \f[CR]en0\f[R].
Use \f[CR]ifconfig\f[R] in a terminal to verify this.
.PP
If the wired ethernet device is not \f[CR]en0\f[R], then then go to
\f[I]System Preferences\f[R] \-> \f[I]Network\f[R], delete all the
network devices and apply the changes.
Next, open a terminal and run the following:
.IP
.EX
sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
.EE
.PP
Now reboot, and the App Store should work.
.PP
There may be further advice and information about macOS guests in the
project \c
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
wiki
.UE \c
\&.
.SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
Creating Windows guests
.UE \c
\ 🪟
\f[CR]quickget\f[R] can download \c
.UR https://www.microsoft.com/software-download/windows10
\f[B]Windows 10\f[R]
.UE \c
\ and \c
.UR https://www.microsoft.com/software-download/windows11
\f[B]Windows 11\f[R]
.UE \c
\ automatically and create an optimised virtual machine configuration.
This configuration also includes the \c
.UR https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/
VirtIO drivers for Windows
.UE \c
\&.
.PP
\f[B]Windows 8.1\f[R] is also supported but doesn\(aqt feature any
automated installation or driver optimisation.
.PP
\f[CR]quickget\f[R] can also download \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise
Windows 10 LTSC
.UE \c
\ and Windows Server \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2
2012\-r2
.UE \c
, \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016
2016
.UE \c
, \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019
2019
.UE \c
, and \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022
2022
.UE \c
\&.
No automated installation is supported for these releases.
.IP
.EX
quickget windows 11
quickemu \-\-vm windows\-11.conf
.EE
.IP \(bu 2
Complete the installation as you normally would.
.IP \(bu 2
All relevant drivers and services should be installed automatically.
.IP \(bu 2
A local administrator user account is automatically created, with these
credentials:
.RS 2
.IP \(bu 2
Username: \f[CR]Quickemu\f[R]
.IP \(bu 2
Password: \f[CR]quickemu\f[R]
.RE
.PP
Further information is available from the project \c
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
wiki
.UE \c
.SS Configuration
Here are the usage instructions:
.IP
.EX
Usage
quickemu \-\-vm ubuntu.conf <arguments>
Arguments
\-\-access : Enable remote spice access support. \(aqlocal\(aq (default), \(aqremote\(aq, \(aqclientipaddress\(aq
\-\-braille : Enable braille support. Requires SDL.
\-\-cpu\-pinning : Choose which host cores correspond to which guest cores.
\-\-delete\-disk : Delete the disk image and EFI variables
\-\-delete\-vm : Delete the entire VM and its configuration
\-\-display : Select display backend. \(aqgtk\(aq (default), \(aqsdl\(aq, \(aqcocoa\(aq, \(aqnone\(aq, \(aqspice\(aq or \(aqspice\-app\(aq
\-\-fullscreen : Starts VM in full screen mode (Ctl+Alt+f to exit)
\-\-ignore\-msrs\-always : Configure KVM to always ignore unhandled machine\-specific registers
\-\-ignore\-tsc\-warning : Skip TSC stability warning for macOS VMs on AMD
\-\-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. \(atOptions: \(aqspicy\(aq (default), \(aqremote\-viewer\(aq, \(aqnone\(aq
\-\-width <width> : Set VM screen width; requires \(aq\-\-height\(aq
\-\-height <height> : Set VM screen height; requires \(aq\-\-width\(aq
\-\-ssh\-port <port> : Set SSH port manually
\-\-spice\-port <port> : Set SPICE port manually
\-\-public\-dir <path> : Expose share directory. \(atOptions: \(aq\(aq (default: xdg\-user\-dir PUBLICSHARE), \(aq<directory>\(aq, \(aqnone\(aq
\-\-monitor <type> : Set monitor connection type. \(atOptions: \(aqsocket\(aq (default), \(aqtelnet\(aq, \(aqnone\(aq
\-\-monitor\-telnet\-host <ip/host> : Set telnet host for monitor. (default: \(aqlocalhost\(aq)
\-\-monitor\-telnet\-port <port> : Set telnet port for monitor. (default: \(aq4440\(aq)
\-\-monitor\-cmd <cmd> : Send command to monitor if available. (Example: system_powerdown)
\-\-serial <type> : Set serial connection type. \(atOptions: \(aqsocket\(aq (default), \(aqtelnet\(aq, \(aqnone\(aq
\-\-serial\-telnet\-host <ip/host> : Set telnet host for serial. (default: \(aqlocalhost\(aq)
\-\-serial\-telnet\-port <port> : Set telnet port for serial. (default: \(aq6660\(aq)
\-\-keyboard <type> : Set keyboard. \(atOptions: \(aqusb\(aq (default), \(aqps2\(aq, \(aqvirtio\(aq
\-\-keyboard_layout <layout> : Set keyboard layout: \(aqen\-us\(aq (default)
\-\-mouse <type> : Set mouse. \(atOptions: \(aqtablet\(aq (default), \(aqps2\(aq, \(aqusb\(aq, \(aqvirtio\(aq
\-\-usb\-controller <type> : Set usb\-controller. \(atOptions: \(aqehci\(aq (default), \(aqxhci\(aq, \(aqnone\(aq
\-\-sound\-card <type> : Set sound card. \(atOptions: \(aqintel\-hda\(aq (default), \(aqac97\(aq, \(aqes1370\(aq, \(aqsb16\(aq, \(aqusb\-audio\(aq, \(aqvirtio\-sound\-pci\(aq, \(aqnone\(aq
\-\-sound\-duplex <type> : Set sound card duplex. \(atOptions: \(aqhda\-micro\(aq (default: speaker/mic), \(aqhda\-duplex\(aq (line\-in/line\-out), \(aqhda\-output\(aq (output\-only)
\-\-extra_args <arguments> : Pass additional arguments to qemu
\-\-version : Print version
.EE
.SS Desktop shortcuts
Desktop shortcuts can be created for a VM, the shortcuts are saved in
\f[CR]\(ti/.local/share/applications\f[R].
Here is an example of how to create a shortcut.
.IP
.EX
quickemu \-\-vm ubuntu\-22.04\-desktop.conf \-\-shortcut
.EE
.SS References
Useful reference that assisted the development of Quickemu.
.IP \(bu 2
General
.RS 2
.IP \(bu 2
\c
.UR https://qemu.readthedocs.io/en/latest/
QEMU\(aqs documentation!
.UE \c
.IP \(bu 2
\c
.UR https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines
.UE \c
.IP \(bu 2
\c
.UR https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/
.UE \c
.RE
.IP \(bu 2
macOS
.RS 2
.IP \(bu 2
\c
.UR https://www.nicksherlock.com/2020/06/installing-macos-big-sur-on-proxmox/
.UE \c
.IP \(bu 2
\c
.UR https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/
.UE \c
.IP \(bu 2
\c
.UR https://github.com/kholia/OSX-KVM
.UE \c
.IP \(bu 2
\c
.UR https://github.com/thenickdude/KVM-Opencore
.UE \c
.IP \(bu 2
\c
.UR https://gist.github.com/MCJack123/943eaca762730ca4b7ae460b731b68e7
.UE \c
.IP \(bu 2
\c
.UR https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery
.UE \c
.IP \(bu 2
\c
.UR https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/
.UE \c
.IP \(bu 2
\c
.UR https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/
.UE \c
.IP \(bu 2
\c
.UR http://philjordan.eu/osx-virt/
.UE \c
.IP \(bu 2
\c
.UR https://github.com/Dids/clover-builder
.UE \c
.IP \(bu 2
\c
.UR https://mackie100projects.altervista.org
OpenCore Configurator
.UE \c
.RE
.IP \(bu 2
Windows
.RS 2
.IP \(bu 2
\c
.UR https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/
.UE \c
.IP \(bu 2
\c
.UR https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5
.UE \c
.IP \(bu 2
\c
.UR https://frontpagelinux.com/tutorials/how-to-use-linux-kvm-to-optimize-your-windows-10-virtual-machine/
.UE \c
.IP \(bu 2
\c
.UR https://turlucode.com/qemu-command-line-args/
.UE \c
.IP \(bu 2
\c
.UR https://github.com/pbatard/Fido
.UE \c
.IP \(bu 2
\c
.UR https://www.catapultsystems.com/blogs/create-zero-touch-windows-10-iso/
.UE \c
.RE
.IP \(bu 2
TPM
.RS 2
.IP \(bu 2
\c
.UR https://qemu-project.gitlab.io/qemu/specs/tpm.html
.UE \c
.IP \(bu 2
\c
.UR https://www.tecklyfe.com/how-to-create-a-windows-11-virtual-machine-in-qemu/
.UE \c
.RE
.IP \(bu 2
9p & virtiofs
.RS 2
.IP \(bu 2
\c
.UR https://wiki.qemu.org/Documentation/9p
.UE \c
.IP \(bu 2
\c
.UR https://wiki.qemu.org/Documentation/9psetup
.UE \c
.IP \(bu 2
\c
.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
.UE \c
.IP \(bu 2
\c
.UR https://superuser.com/questions/628169/how-to-share-a-directory-with-the-host-without-networking-in-qemu
.UE \c
.IP \(bu 2
\c
.UR https://virtio-fs.gitlab.io/
.UE \c
.RE
.SH AUTHORS
Written by Martin Wimpress.
.SH BUGS
Submit bug reports online at: \c
.UR https://github.com/quickemu-project/quickemu/issues
.UE \c
.SH SEE ALSO
Full sources at: \c
.UR https://github.com/quickemu-project/quickemu
.UE \c
.PP
quickemu_conf(5), quickget(1), quickgui(1)
.SH AUTHORS
Martin Wimpress.
================================================
FILE: docs/quickemu.1.md
================================================
---
author: Martin Wimpress
date: February 2, 2026
footer: quickemu
header: Quickemu User Manual
section: 1
title: QUICKEMU
---
# NAME
quickemu - A quick VM builder and manager
# SYNOPSIS
**quickemu** \[*OPTION*\]...
# DESCRIPTION
**quickemu** will create and run highly optimised desktop virtual
machines for Linux, macOS and Windows
# OPTIONS
**--vm**
: vm configuration file
You can also pass optional parameters
**--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. 'gtk' (default), 'sdl', 'cocoa', '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', 'none'
**--extra_args \<arguments\>**
: Pass additional arguments to qemu
**--version**
: Print version
# EXAMPLES
**quickemu --vm ubuntu-mate-22.04.conf**
: Launches the VM specified in the file *ubuntu-mate-22.04.conf*
# Introduction
**Quickemu** is a wrapper for the excellent
[QEMU](https://www.qemu.org/) 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](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines)
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](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines),
[Windows](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)**,
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** Sequoia, Sonoma, Ventura, Monterey, Big Sur, Catalina &
Mojave
- **Windows** 10 and 11 including TPM 2.0
- **Windows Server** 2022 2019 2016
- **ARM64 guest support** for running aarch64 VMs (native on ARM hosts,
emulated on x86_64)
- [Ubuntu](https://ubuntu.com/desktop) and all the **[official Ubuntu
flavours](https://ubuntu.com/download/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](https://wiki.qemu.org/Features/GuestAgent);
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](https://linuxmatters.sh) podcast!
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](https://linuxmatters.sh/30).
<!-- and in [Episode 32 - Quick, quicker, quickest](https://linuxmatters.sh/32) [Martin](https://github.com/flexiondotorg) unveils macOS host support for [**Quickemu**](https://github.com/quickemu-project/quickemu), [Mark](https://github.com/marxjohnson) explains the origins of the [**Quickgui**](https://github.com/quickemu-project/quickgui) desktop app and upcoming improvements, and [Alan](https://github.com/popey) debuts [**Quicktest**](https://github.com/quickemu-project/quicktest); a framework for automatically testing operating systems via Quickemu -->
<div align="center">
<a href="https://linuxmatters.sh" target="_blank"><img src="https://github.com/wimpysworld/nix-config/raw/main/.github/screenshots/linuxmatters.png" alt="Linux Matters Podcast"/></a>
<br /> <em>Linux Matters Podcast</em>
</div>
When installing from source, you will need to install the following
requirements manually:
- [QEMU](https://www.qemu.org/) (*6.0.0 or newer*) **with GTK, SDL,
SPICE & VirtFS support**
- [bash](https://www.gnu.org/software/bash/) (*4.0 or newer*)
- [Coreutils](https://www.gnu.org/software/coreutils/)
- [curl](https://curl.se/)
- [EDK II](https://github.com/tianocore/edk2)
- [gawk](https://www.gnu.org/software/gawk/)
- [grep](https://www.gnu.org/software/grep/)
- [glxinfo](https://gitlab.freedesktop.org/mesa/demos)
- [jq](https://stedolan.github.io/jq/)
- [LSB](https://wiki.linuxfoundation.org/lsb/start)
- [pciutils](https://github.com/pciutils/pciutils)
- [procps](https://gitlab.com/procps-ng/procps)
- [python3](https://www.python.org/)
- [mkisofs](http://cdrtools.sourceforge.net/private/cdrecord.html)
- [usbutils](https://github.com/gregkh/usbutils)
- [util-linux](https://github.com/karelzak/util-linux); including
`uuidgen`
- [sed](https://www.gnu.org/software/sed/)
- [socat](http://www.dest-unreach.org/socat/)
- [spicy](https://gitlab.freedesktop.org/spice/spice-gtk)
- [swtpm](https://github.com/stefanberger/swtpm)
- [xdg-user-dirs](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/)
- [xrandr](https://gitlab.freedesktop.org/xorg/app/xrandr)
- [zsync](http://zsync.moria.org.uk/)
- [unzip](http://www.info-zip.org/UnZip.html)
For Ubuntu, Debian, Fedora, Arch and NixOS hosts the native packaging or
[ppa](https://launchpad.net/~flexiondotorg/+archive/ubuntu/quickemu),
[AUR](https://aur.archlinux.org/packages/quickemu) or
[nix](https://github.com/NixOS/nixpkgs/tree/master/pkgs/development/quickemu)
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:
#### Install requirements on Debian hosts
These should be handled by dependencies in Trixie and later. For earlier
versions (and their derivatives):
``` shell
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
```
#### Install requirements on Fedora hosts
These are handled natively for Fedora 41 on. For earlier versions:
``` shell
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
```
### Install requirements on Gentoo
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.
``` shell
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 requirements on macOS hosts
Install the Quickemu requirements using brew:
``` shell
brew install bash cdrtools coreutils jq python3 qemu usbutils samba socat swtpm zsync
```
Now clone the project:
``` shell
git clone https://github.com/quickemu-project/quickemu
cd quickemu
```
## [Alternative Frontends](https://github.com/quickemu-project/quickemu/wiki/07-Alternative-frontends)
### Quickgui
While `quickemu` and `quickget` are designed for the terminal, a
graphical user interface is also available:
- **[Quickgui](https://github.com/quickemu-project/quickgui)** by [Mark
Johnson](https://github.com/marxjohnson) and [Yannick
Mauray](https://github.com/ymauray).
To install Quickgui on Ubuntu:
``` shell
sudo add-apt-repository ppa:yannick-mauray/quickgui
sudo apt update
sudo apt install quickgui
```
Many thanks to [Luke Wesley-Holley](https://github.com/Lukewh) and
[Philipp Kiemle](https://github.com/daPhipz) for creating the
**[Quickemu icons](https://github.com/Lukewh/quickemu-icons)** 🎨
## Creating Linux guests 🐧
### Ubuntu
`quickget` will automatically download an Ubuntu release and create the
virtual machine configuration.
``` shell
quickget ubuntu 22.04
quickemu --vm ubuntu-22.04.conf
```
- Complete the installation as normal.
- Post-install:
- Install the SPICE agent (`spice-vdagent`) in the guest to enable
copy/paste and USB redirection
- `sudo apt install spice-vdagent`
- Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
enable file sharing.
- `sudo apt install spice-webdavd`
### Ubuntu daily-live images
`quickget` can also download/refresh daily-live images via `zsync` for
Ubuntu developers and testers.
``` shell
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.
### Ubuntu Flavours
All the official Ubuntu flavours are supported, just replace `ubuntu`
with your preferred flavour.
The project
[wiki](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines)
may have further information.
- `edubuntu` (Edubuntu)
- `kubuntu` (Kubuntu)
- `lubuntu` (Lubuntu)
- `ubuntu-budgie` (Ubuntu Budgie)
- `ubuntucinnamon` (Ubuntu Cinnamon)
- `ubuntukylin` (Ubuntu Kylin)
- `ubuntu-mate` (Ubuntu MATE)
- `ubuntu-server` (Ubuntu Server)
- `ubuntustudio` (Ubuntu Studio)
- `ubuntu` (Ubuntu)
- `ubuntu-unity` (Ubuntu Unity)
- `xubuntu` (Xubuntu)
You can also use `quickget` with advanced options :
``` text
--arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
--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
------------------------------------ Flags -------------------------------------
--create-config:
--disable-unattended : Force quickget not to set up an unattended installation
-------------------------- For testing & development ---------------------------
--url [os] [release] [edition] : Show image URL(s)
--check [os] [release] [edition] : Check image URL(s)
--check-all-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
--list : List all supported systems
--list-csv : List everything in csv format
--list-json : List everything in json format
```
Here are some typical uses
``` shell
# 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
[wiki](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features)
### Other Operating Systems
`quickget` also supports:
- `alma` (AlmaLinux)
- `alpine` (Alpine Linux)
- `android` (Android x86)
- `antix` (Antix)
- `archcraft` (Archcraft)
- `archlinux` (Arch Linux)
- `artixlinux` (Artix Linux)
- `azurelinux` (Azure Linux)
- `batocera` (Batocera)
- `bazzite` (Bazzite)
- `biglinux` (BigLinux)
- `blendos` (BlendOS)
- `bodhi` (Bodhi)
- `bunsenlabs` (BunsenLabs)
- `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream)
- `chimeralinux` (Chimera Linux)
- `crunchbang++` (Crunchbangplusplus)
- `debian` (Debian)
- `deepin` (Deepin)
- `devuan` (Devuan)
- `dragonflybsd` (DragonFlyBSD)
- `easyos` (EasyOS)
- `elementary` (elementary OS)
- `endeavouros` (EndeavourOS)
- `endless` (Endless OS)
- `fedora` (Fedora)
- `freebsd` (FreeBSD)
- `freedos` (FreeDOS)
- `garuda` (Garuda Linux)
- `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD)
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku)
- `kali` (Kali)
- `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS)
- `linuxlite` (Linux Lite)
- `linuxmint` (Linux Mint)
- `lmde` (Linux Mint Debian Edition)
- `maboxlinux` (Mabox Linux)
- `mageia` (Mageia)
- `manjaro` (Manjaro)
- `mxlinux` (MX Linux)
- `netboot` (netboot.xyz)
- `netbsd` (NetBSD)
- `nitrux` (Nitrux)
- `nixos` (NixOS)
- `nwg-shell` (nwg-shell)
- `openbsd` (OpenBSD)
- `openindiana` (OpenIndiana)
- `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux)
- `parrotsec` (Parrot Security)
- `pclinuxos` (PCLinuxOS)
- `peppermint` (PeppermintOS)
- `popos` (Pop!\_OS)
- `porteus` (Porteus)
- `primtux` (PrimTux)
- `proxmox-ve` (Proxmox VE)
- `pureos` (PureOS)
- `reactos` (ReactOS)
- `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux)
- `siduction` (Siduction)
- `slackware` (Slackware)
- `slax` (Slax)
- `slint` (Slint)
- `slitaz` (SliTaz)
- `solus` (Solus)
- `sparkylinux` (SparkyLinux)
- `spirallinux` (SpiralLinux)
- `tails` (Tails)
- `tinycore` (Tiny Core Linux)
- `trisquel` (Trisquel)
- `tuxedo-os` (Tuxedo OS)
- `vanillaos` (Vanilla OS)
- `void` (Void Linux)
- `zorin` (Zorin OS)
### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests)
Or you can download a Linux image and manually create a VM
configuration.
- Download a .iso image of a Linux distribution
- Create a VM configuration file; for example `debian-bullseye.conf`
``` shell
guest_os="linux"
disk_img="debian-bullseye/disk.qcow2"
iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso"
```
- Use `quickemu` to start the virtual machine:
``` shell
quickemu --vm debian-bullseye.conf
```
- Complete the installation as normal.
- Post-install:
- Install the SPICE agent (`spice-vdagent`) in the guest to enable
copy/paste and USB redirection.
- Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
enable file sharing.
## Supporting old Linux distros
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](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests) 🍏
**Installing macOS in a VM can be a bit finicky, if you encounter
problems, [check the
Discussions](https://github.com/quickemu-project/quickemu/discussions)
for solutions or ask for help there** 🛟
`quickget` automatically downloads a macOS recovery image and creates a
virtual machine configuration.
Note: Some VPN users may need to [turn off their
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235)
in order to download a recovery image. Some other users may find [using
a
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013)
necessary in order to download a recovery image.
``` shell
quickget macos big-sur
quickemu --vm macos-big-sur.conf
```
macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
`sonoma` are supported.
- Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities**
- Click **Disk Utility** and **Continue**
- Select `QEMU HARDDISK Media` (~103.08GB) from the list (on Big Sur
and above use `Apple Inc. VirtIO Block Device`) and click
**Erase**.
- Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big Sur,
Monterey, Ventura and Sonoma), choose any of the APFS options as
the filesystem. MacOS Extended may not work.
- Click **Erase**.
- Click **Done**.
- Close Disk Utility
- From **macOS Utilities**
- Click **Reinstall macOS** and **Continue**
- Complete the installation as you normally would.
- On the first reboot use cursor keys and enter key to select **macOS
Installer**
- On the subsequent reboots use cursor keys and enter key to select
the disk you named
- Once you have finished installing macOS you will be presented with an
the out-of-the-box first-start wizard to configure various options and
set up your username and password
- OPTIONAL: After you have concluded the out-of-the-box wizard, you may
want to enable the TRIM feature that the computer industry created for
SSD disks. This feature in our macOS installation will allow QuickEmu
to compact (shrink) your macOS disk image whenever you delete files
inside the Virtual Machine. Without this step your macOS disk image
will only ever get larger and will not shrink even when you delete
lots of data inside macOS.
- To enable TRIM, open the Terminal application and type the following
command followed by pressing <kbd>enter</kbd> to tell macos to use
the TRIM command on the hard disk when files are deleted:
``` shell
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
<kbd>enter</kbd> the command will request confirmation in the form of
two questions that require you to type <kbd>y</kbd> (for a "yes"
response) followed by <kbd>enter</kbd> to confirm.
If you press <kbd>enter</kbd> without first typing <kbd>y</kbd> the
system will consider that a negative response as though you said "no":
``` plain
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:
``` plain
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:
``` shell
guest_os="macos"
img="macos-big-sur/RecoveryImage.img"
disk_img="macos-big-sur/disk.qcow2"
macos_release="big-sur"
```
- `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release="big-sur"` instructs Quickemu to optimise for a
particular macOS release.
- For example VirtIO Network and Memory Ballooning are available in
Big Sur and newer, but not previous releases.
- And VirtIO Block Media (disks) are supported/stable in Catalina and
newer.
# macOS compatibility
There are some considerations when running macOS via Quickemu.
- Supported macOS releases:
- Mojave
- Catalina
- Big Sur
- Monterey
- Ventura
- Sonoma
- `quickemu` will automatically download the required
[OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader and
OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
- Optimised by default, but no GPU acceleration is available.
- Host CPU vendor is detected and guest CPU is optimised accordingly.
- [VirtIO Block
Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
used for the system disk where supported.
- [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used for
the mouse.
- VirtIO Network (`virtio-net`) is supported and enabled on macOS Big
Sur and newer, but earlier releases use `vmxnet3`.
- VirtIO Memory Ballooning is supported and enabled on macOS Big Sur
and newer but disabled for other support macOS releases.
- USB host and SPICE pass-through is:
- UHCI (USB 2.0) on macOS Catalina and earlier.
- XHCI (USB 3.0) on macOS Big Sur and newer.
- Display resolution can be changed via `quickemu` using `--width` and
`--height` command line arguments.
- **Full Duplex audio requires [VoodooHDA
OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
audio-device to the macOS guest VM**.
- NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and
[System Integrity Protection
(SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)
need to be disabled to install VoodooHDA OC
- File sharing between guest and host is available via
[virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE
webdavd](https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
- Copy/paste via SPICE agent is **not available on macOS**.
# macOS App Store
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:
``` shell
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
[wiki](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests).
## [Creating Windows guests](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟
`quickget` can download [**Windows
10**](https://www.microsoft.com/software-download/windows10) and
[**Windows 11**](https://www.microsoft.com/software-download/windows11)
automatically and create an optimised virtual machine configuration.
This configuration also includes the [VirtIO drivers for
Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
**Windows 8.1** is also supported but doesn't feature any automated
installation or driver optimisation.
`quickget` can also download [Windows 10
LTSC](https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise)
and Windows Server
[2012-r2](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2),
[2016](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016),
[2019](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019),
and
[2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022).
No automated installation is supported for these releases.
``` shell
quickget windows 11
quickemu --vm windows-11.conf
```
- Complete the installation as you normally would.
- All relevant drivers and services should be installed automatically.
- A local administrator user account is automatically created, with
these credentials:
- Username: `Quickemu`
- Password: `quickemu`
Further information is available from the project
[wiki](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)
## Configuration
Here are the usage instructions:
``` text
Usage
quickemu --vm ubuntu.conf <arguments>
Arguments
--access : Enable remote spice access support. 'local' (default), 'remote', 'clientipaddress'
--braille : Enable braille support. Requires SDL.
--cpu-pinning : Choose which host cores correspond to which guest cores.
--delete-disk : Delete the disk image and EFI variables
--delete-vm : Delete the entire VM and its configuration
--display : Select display backend. 'gtk' (default), 'sdl', 'cocoa', '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
--ignore-tsc-warning : Skip TSC stability warning for macOS VMs on AMD
--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', 'virtio-sound-pci', '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
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.
``` shell
quickemu --vm ubuntu-22.04-desktop.conf --shortcut
```
## References
Useful reference that assisted the development of Quickemu.
- General
- [QEMU's documentation!](https://qemu.readthedocs.io/en/latest/)
- <https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
- <https://www.kraxel.org/blog/2020/01/qemu-sound-audiodev/>
- macOS
- <https://www.nicksherlock.com/2020/06/installing-macos-big-sur-on-proxmox/>
- <https://passthroughpo.st/mac-os-adds-early-support-for-virtio-qemu/>
- <https://github.com/kholia/OSX-KVM>
- <https://github.com/thenickdude/KVM-Opencore>
- <https://gist.github.com/MCJack123/943eaca762730ca4b7ae460b731b68e7>
- <https://github.com/acidanthera/OpenCorePkg/tree/master/Utilities/macrecovery>
- <https://www.kraxel.org/blog/2017/09/running-macos-as-guest-in-kvm/>
- <https://www.nicksherlock.com/2017/10/passthrough-of-advanced-cpu-features-for-macos-high-sierra-guests/>
- <http://philjordan.eu/osx-virt/>
- <https://github.com/Dids/clover-builder>
- [OpenCore Configurator](https://mackie100projects.altervista.org)
- Windows
- <https://www.heiko-sieger.info/running-windows-10-on-linux-using-kvm-with-vga-passthrough/>
- <https://leduccc.medium.com/improving-the-performance-of-a-windows-10-guest-on-qemu-a5b3f54d9cf5>
- <https://frontpagelinux.com/tutorials/how-to-use-linux-kvm-to-optimize-your-windows-10-virtual-machine/>
- <https://turlucode.com/qemu-command-line-args/>
- <https://github.com/pbatard/Fido>
- <https://www.catapultsystems.com/blogs/create-zero-touch-windows-10-iso/>
- TPM
- <https://qemu-project.gitlab.io/qemu/specs/tpm.html>
- <https://www.tecklyfe.com/how-to-create-a-windows-11-virtual-machine-in-qemu/>
- 9p & virtiofs
- <https://wiki.qemu.org/Documentation/9p>
- <https://wiki.qemu.org/Documentation/9psetup>
- <https://www.kraxel.org/blog/2019/06/macos-qemu-guest/>
- <https://superuser.com/questions/628169/how-to-share-a-directory-with-the-host-without-networking-in-qemu>
- <https://virtio-fs.gitlab.io/>
# AUTHORS
Written by Martin Wimpress.
# BUGS
Submit bug reports online at:
<https://github.com/quickemu-project/quickemu/issues>
# SEE ALSO
Full sources at: <https://github.com/quickemu-project/quickemu>
quickemu_conf(5), quickget(1), quickgui(1)
================================================
FILE: docs/quickemu_conf.5
================================================
.\" Automatically generated by Pandoc 3.8.3
.\"
.TH "QUICKEMU_CONF" "5" "February 2, 2026" "quickemu_conf" "Quickemu Configuration Manual"
.SH NAME
quickemu_conf \- Options and parameters in the quickemu <vm>.conf
.SH DESCRIPTION
\f[B]quickemu\f[R] will create and run highly optimised desktop virtual
machines for Linux, macOS and Windows.
It uses sensible defaults, but many configuration options can be
overridden in the required configuration file, which will as a minimum
specify the path to the installation ISO and QEMU disk for the installed
VM
.SH OPTIONS
These are the options and defaults for the <vm>.conf file
.IP
.EX
# Lowercase variables are used in the VM config file only
boot=\(dqefi\(dq
cpu_cores=\(dq\(dq
disk_img=\(dq\(dq
disk_size=\(dq\(dq
display=\(dq\(dq
extra_args=\(dq\(dq
fixed_iso=\(dq\(dq
floppy=\(dq\(dq
guest_os=\(dqlinux\(dq
img=\(dq\(dq
iso=\(dq\(dq
macaddr=\(dq\(dq
macos_release=\(dq\(dq
network=\(dq\(dq
port_forwards=()
preallocation=\(dqoff\(dq
ram=\(dq\(dq
secureboot=\(dqoff\(dq
tpm=\(dqoff\(dq
usb_devices=()
viewer=\(dqspicy\(dq
ssh_port=\(dq\(dq
spice_port=\(dq\(dq
public_dir=\(dq\(dq
monitor=\(dqsocket\(dq
monitor_telnet_port=\(dq4440\(dq
monitor_telnet_host=\(dqlocalhost\(dq
monitor_cmd=\(dq\(dq
serial=\(dqsocket\(dq
serial_telnet_port=\(dq6660\(dq
serial_telnet_host=\(dqlocalhost\(dq
# options: ehci(USB2.0), xhci(USB3.0)
usb_controller=\(dqehci\(dq
# options: ps2, usb, virtio
keyboard=\(dqusb\(dq
keyboard_layout=\(dqen\-us\(dq
# options: ps2, usb, tablet, virtio
mouse=\(dqtablet\(dq
.EE
.SH EXAMPLES
.IP
.EX
guest_os=\(dqlinux\(dq
disk_img=\(dqdebian\-bullseye/disk.qcow2\(dq
iso=\(dqdebian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso\(dq
.EE
.PP
The default macOS configuration looks like this:
.IP
.EX
guest_os=\(dqmacos\(dq
img=\(dqmacos\-catalina/RecoveryImage.img\(dq
disk_img=\(dqmacos\-catalina/disk.qcow2\(dq
macos_release=\(dqcatalina\(dq
.EE
.IP \(bu 2
\f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for
macOS.
.IP \(bu 2
\f[CR]macos_release=\(dqcatalina\(dq\f[R] instructs Quickemu to optimise
for a particular macOS release.
.RS 2
.IP \(bu 2
For example VirtIO Network and Memory Ballooning are available in Big
Sur and newer, but not previous releases.
.IP \(bu 2
And VirtIO Block Media (disks) are supported/stable in Catalina and
newer.
.RE
.PP
The default Windows 11 configuration looks like this:
.IP
.EX
guest_os=\(dqwindows\(dq
disk_img=\(dqwindows\-11/disk.qcow2\(dq
iso=\(dqwindows\-11/Win11_EnglishInternational_x64.iso\(dq
fixed_iso=\(dqwindows\-11/virtio\-win.iso\(dq
tpm=\(dqon\(dq
secureboot=\(dqon\(dq
.EE
.IP \(bu 2
\f[CR]guest_os=\(dqwindows\(dq\f[R] instructs \f[CR]quickemu\f[R] to
optimise for Windows.
.IP \(bu 2
\f[CR]fixed_iso=\f[R] specifies the ISO image that provides VirtIO
drivers.
.IP \(bu 2
\f[CR]tpm=\(dqon\(dq\f[R] instructs \f[CR]quickemu\f[R] to create a
software emulated TPM device using \f[CR]swtpm\f[R].
.SS BIOS and EFI
Since Quickemu 2.1.0 \f[CR]efi\f[R] is the default boot option.
If you want to override this behaviour then add the following line to
you VM configuration to enable legacy BIOS.
.IP \(bu 2
\f[CR]boot=\(dqlegacy\(dq\f[R] \- Enable Legacy BIOS boot
.SS Tuning CPU cores, RAM & disks
By default, Quickemu will calculate the number of CPUs cores and RAM to
allocate to a VM based on the specifications of your host computer.
You can override this default behaviour and tune the VM configuration to
your liking.
.PP
Add additional lines to your virtual machine configuration:
.IP \(bu 2
\f[CR]cpu_cores=\(dq4\(dq\f[R] \- Specify the number of CPU cores
allocated to the VM
.IP \(bu 2
\f[CR]ram=\(dq4G\(dq\f[R] \- Specify the amount of RAM to allocate to
the VM
.IP \(bu 2
\f[CR]disk_size=\(dq16G\(dq\f[R] \- Specify the size of the virtual disk
allocated to the VM
.SS Disk preallocation
Preallocation mode (allowed values: \f[CR]off\f[R] (default),
\f[CR]metadata\f[R], \f[CR]falloc\f[R], \f[CR]full\f[R]).
An image with preallocated metadata is initially larger but can improve
performance when the image needs to grow.
.PP
Specify what disk preallocation should be used, if any, when creating
the system disk image by adding a line like this to your VM
configuration.
.IP \(bu 2
\f[CR]preallocation=\(dqmetadata\(dq\f[R]
.SS CD\-ROM disks
If you want to expose an ISO image from the host to guest add the
following line to the VM configuration:
.IP \(bu 2
\f[CR]fixed_iso=\(dq/path/to/image.iso\(dq\f[R]
.SS Floppy disks
If you\(aqre like \c
.UR https://popey.com
Alan Pope
.UE \c
\ you\(aqll probably want to mount a floppy disk image in the guest.
To do so add the following line to the VM configuration:
.IP \(bu 2
\f[CR]floppy=\(dq/path/to/floppy.img\(dq\f[R]
.SS File Sharing
All File Sharing options will only expose \f[CR]\(ti/Public\f[R] (or
localised variations) for the current user to the guest VMs.
.SS Samba 🐧 🍏 🪟
If \f[CR]smbd\f[R] is available on the host, Quickemu will automatically
enable the built\-in QEMU support for exposing a Samba share from the
host to the guest.
.PP
You can install the minimal Samba components on Ubuntu using:
.IP
.EX
sudo apt install \-\-no\-install\-recommends samba
.EE
.PP
If everything is set up correctly, the \f[CR]smbd\f[R] address will be
printed when the virtual machine is started.
For example:
.IP
.EX
\- smbd: On guest: smb://10.0.2.4/qemu
.EE
.PP
If using a Windows guest, right\-click on \(dqThis PC\(dq, click \(dqAdd
a network location\(dq, and paste this address, removing \f[CR]smb:\f[R]
and replacing forward slashes with backslashes (in this example
\f[CR]\(rs\(rs10.0.2.4\(rsqemu\f[R]).
.SS SPICE WebDAV 🐧 🪟
.IP \(bu 2
TBD
.SS VirtIO\-9P 🐧 🍏
.IP \(bu 2
TBD
.SS Networking
.SS Port forwarding
Add an additional line to your virtual machine configuration.
For example:
.IP \(bu 2
\f[CR]port_forwards=(\(dq8123:8123\(dq \(dq8888:80\(dq)\f[R]
.PP
In the example above:
.IP \(bu 2
Port 8123 on the host is forwarded to port 8123 on the guest.
.IP \(bu 2
Port 8888 on the host is forwarded to port 80 on the guest.
.SS Disable networking
To completely disable all network interfaces in a guest VM add this
additional line to your virtual machine configuration:
.IP \(bu 2
\f[CR]network=\(dqnone\(dq\f[R]
.SS Restricted networking
You can isolate the guest from the host (and broader network) using the
restrict option, which will restrict networking to just the guest and
any virtual devices.
.PP
This can be used to prevent software running inside the guest from
phoning home while still providing a network inside the guest.
Add this additional line to your virtual machine configuration:
.IP \(bu 2
\f[CR]network=\(dqrestrict\(dq\f[R]
.SS Bridged networking
Connect your virtual machine to a preconfigured network bridge.
Add an additional line to your virtual machine configuration:
.IP \(bu 2
\f[CR]network=\(dqbr0\(dq\f[R]
.PP
If you want to have a persistent MAC address for your bridged network
interface in the guest VM you can add \f[CR]macaddr\f[R] to the virtual
machine configuration.
QEMU requires that the MAC address is in the range:
\f[B]52:54:00:AB:00:00 \- 52:54:00:AB:FF:FF\f[R]
.PP
So you can generate your own MAC addresses with:
.IP \(bu 2
\f[CR]macaddr=\(dq52:54:00:AB:51:AE\(dq\f[R]
.SS USB redirection
Quickemu supports USB redirection via SPICE pass\-through and host
pass\-through.
Quickemu supports USB redirection via SPICE pass\-through and host
pass\-through.
.PP
\f[B]NOTE!\f[R] When a USB device is redirected from the host, it will
not be usable by host operating system until the guest redirection is
stopped.
Therefore, do not redirect the input devices, such as the keyboard and
mouse, as it will be difficult (or impossible) to revert the situation.
.SS SPICE redirection (recommended)
Using SPICE for USB pass\-through is easiest as it doesn\(aqt require
any elevated permission:
.PP
Both \f[CR]spicy\f[R] from \c
.UR https://www.spice-space.org/spice-gtk.html
spice\-gtk
.UE \c
\ (\f[I]Input \-> Select USB Devices for redirection\f[R]) and
\f[CR]remote\-viewer\f[R] from \c
.UR https://gitlab.com/virt-viewer/virt-viewer
virt\-viewer
.UE \c
\ (\f[I]File \-> USB device selection\f[R]) support this feature.
.IP \(bu 2
Start Quickemu with \f[CR]\-\-display spice\f[R] and then
.IP \(bu 2
Select \f[CR]Input\f[R] \-> \f[CR]Select USB Device for redirection\f[R]
from the menu to choose which device(s) you want to attach to the guest.
.IP \(bu 2
**\f[CR]spicy\f[R] (default)
.RS 2
.IP \(bu 2
**Select \f[CR]Input\f[R] \->
\f[CR]Select USB Device for redirection\f[R] from the menu to choose
which device(s) you want to attach to the guest.
.RE
.IP \(bu 2
**\f[CR]remote\-viewer\f[R]
.RS 2
.IP \(bu 2
**Select \f[CR]File\f[R] \-> \f[CR]USB device selection\f[R] from the
menu to choose which device(s) you want to attach to the guest.
.RE
.PP
To ensure that this functionality works as expected, make sure that you
have installed the necessary SPICE Guest Tools on the virtual machine.
.SS Enabling SPICE redirection on NixOS
On NixOS, if you encounter this error:
.IP
.EX
Error setting facl: Operation not permitted
.EE
.PP
Try setting \c
.UR https://search.nixos.org/options?channel=23.11&show=virtualisation.spiceUSBRedirection.enable&from=0&size=50&sort=relevance&type=packages&query=spiceusbredirec
the following option
.UE \c
:
.IP
.EX
virtualisation.spiceUSBRedirection.enable = true;
.EE
.SS Host redirection (\f[B]NOT Recommended\f[R])
\f[B]USB host redirection is not recommended\f[R], it is provided purely
for backwards compatibility to older versions of Quickemu.
Using SPICE is preferred, see above.
.PP
Add an additional line to your virtual machine configuration.
For example:
.IP \(bu 2
\f[CR]usb_devices=(\(dq046d:082d\(dq \(dq046d:085e\(dq)\f[R]
.PP
In the example above:
.IP \(bu 2
The USB device with vendor_id 046d and product_id 082d will be exposed
to the guest.
.IP \(bu 2
The USB device with vendor_id 046d and product_id 085e will be exposed
to the guest.
.PP
If the USB devices are not writable, \f[CR]quickemu\f[R] will display
the appropriate commands to modify the USB device(s) access permissions,
like this:
.IP
.EX
\- USB: Host pass\-through requested:
\- Sennheiser Communications EPOS GTW 270 on bus 001 device 005 needs permission changes:
sudo chown \-v root:user /dev/bus/usb/001/005
ERROR! USB permission changes are required 👆
.EE
.SS TPM
Since Quickemu 2.2.0 a software emulated TPM device can be added to
guest virtual machines.
Just add \f[CR]tpm=\(dqon\(dq\f[R] to your VM configuration.
\f[CR]quickget\f[R] will automatically add this line to Windows 11
virtual machines.
.SH AUTHORS
Written by Martin Wimpress.
.SH BUGS
Submit bug reports online at: \c
.UR https://github.com/quickemu-project/quickemu/issues
.UE \c
.SH SEE ALSO
Full sources at: \c
.UR https://github.com/quickemu-project/quickemu
.UE \c
.PP
quickget(1), quickemu(1), quickgui(1)
.SH AUTHORS
Martin Wimpress.
================================================
FILE: docs/quickemu_conf.5.md
================================================
---
author: Martin Wimpress
date: February 2, 2026
footer: quickemu_conf
header: Quickemu Configuration Manual
section: 5
title: QUICKEMU_CONF
---
# NAME
quickemu_conf - Options and parameters in the quickemu \<vm\>.conf
# DESCRIPTION
**quickemu** will create and run highly optimised desktop virtual
machines for Linux, macOS and Windows. It uses sensible defaults, but
many configuration options can be overridden in the required
configuration file, which will as a minimum specify the path to the
installation ISO and QEMU disk for the installed VM
# OPTIONS
These are the options and defaults for the \<vm\>.conf file
``` shell
# Lowercase variables are used in the VM config file only
boot="efi"
cpu_cores=""
disk_img=""
disk_size=""
display=""
extra_args=""
fixed_iso=""
floppy=""
guest_os="linux"
img=""
iso=""
macaddr=""
macos_release=""
network=""
port_forwards=()
preallocation="off"
ram=""
secureboot="off"
tpm="off"
usb_devices=()
viewer="spicy"
ssh_port=""
spice_port=""
public_dir=""
monitor="socket"
monitor_telnet_port="4440"
monitor_telnet_host="localhost"
monitor_cmd=""
serial="socket"
serial_telnet_port="6660"
serial_telnet_host="localhost"
# options: ehci(USB2.0), xhci(USB3.0)
usb_controller="ehci"
# options: ps2, usb, virtio
keyboard="usb"
keyboard_layout="en-us"
# options: ps2, usb, tablet, virtio
mouse="tablet"
```
# EXAMPLES
``` shell
guest_os="linux"
disk_img="debian-bullseye/disk.qcow2"
iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso"
```
The default macOS configuration looks like this:
``` shell
guest_os="macos"
img="macos-catalina/RecoveryImage.img"
disk_img="macos-catalina/disk.qcow2"
macos_release="catalina"
```
- `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release="catalina"` instructs Quickemu to optimise for a
particular macOS release.
- For example VirtIO Network and Memory Ballooning are available in
Big Sur and newer, but not previous releases.
- And VirtIO Block Media (disks) are supported/stable in Catalina and
newer.
The default Windows 11 configuration looks like this:
``` shell
guest_os="windows"
disk_img="windows-11/disk.qcow2"
iso="windows-11/Win11_EnglishInternational_x64.iso"
fixed_iso="windows-11/virtio-win.iso"
tpm="on"
secureboot="on"
```
- `guest_os="windows"` instructs `quickemu` to optimise for Windows.
- `fixed_iso=` specifies the ISO image that provides VirtIO drivers.
- `tpm="on"` instructs `quickemu` to create a software emulated TPM
device using `swtpm`.
### BIOS and EFI
Since Quickemu 2.1.0 `efi` is the default boot option. If you want to
override this behaviour then add the following line to you VM
configuration to enable legacy BIOS.
- `boot="legacy"` - Enable Legacy BIOS boot
### Tuning CPU cores, RAM & disks
By default, Quickemu will calculate the number of CPUs cores and RAM to
allocate to a VM based on the specifications of your host computer. You
can override this default behaviour and tune the VM configuration to
your liking.
Add additional lines to your virtual machine configuration:
- `cpu_cores="4"` - Specify the number of CPU cores allocated to the VM
- `ram="4G"` - Specify the amount of RAM to allocate to the VM
- `disk_size="16G"` - Specify the size of the virtual disk allocated to
the VM
### Disk preallocation
Preallocation mode (allowed values: `off` (default), `metadata`,
`falloc`, `full`). An image with preallocated metadata is initially
larger but can improve performance when the image needs to grow.
Specify what disk preallocation should be used, if any, when creating
the system disk image by adding a line like this to your VM
configuration.
- `preallocation="metadata"`
### CD-ROM disks
If you want to expose an ISO image from the host to guest add the
following line to the VM configuration:
- `fixed_iso="/path/to/image.iso"`
### Floppy disks
If you're like [Alan Pope](https://popey.com) you'll probably want to
mount a floppy disk image in the guest. To do so add the following line
to the VM configuration:
- `floppy="/path/to/floppy.img"`
### File Sharing
All File Sharing options will only expose `~/Public` (or localised
variations) for the current user to the guest VMs.
#### Samba 🐧 🍏 🪟
If `smbd` is available on the host, Quickemu will automatically enable
the built-in QEMU support for exposing a Samba share from the host to
the guest.
You can install the minimal Samba components on Ubuntu using:
``` shell
sudo apt install --no-install-recommends samba
```
If everything is set up correctly, the `smbd` address will be printed
when the virtual machine is started. For example:
- smbd: On guest: smb://10.0.2.4/qemu
If using a Windows guest, right-click on "This PC", click "Add a network
location", and paste this address, removing `smb:` and replacing forward
slashes with backslashes (in this example `\\10.0.2.4\qemu`).
#### SPICE WebDAV 🐧 🪟
- TBD
#### VirtIO-9P 🐧 🍏
- TBD
### Networking
#### Port forwarding
Add an additional line to your virtual machine configuration. For
example:
- `port_forwards=("8123:8123" "8888:80")`
In the example above:
- Port 8123 on the host is forwarded to port 8123 on the guest.
- Port 8888 on the host is forwarded to port 80 on the guest.
#### Disable networking
To completely disable all network interfaces in a guest VM add this
additional line to your virtual machine configuration:
- `network="none"`
#### Restricted networking
You can isolate the guest from the host (and broader network) using the
restrict option, which will restrict networking to just the guest and
any virtual devices.
This can be used to prevent software running inside the guest from
phoning home while still providing a network inside the guest. Add this
additional line to your virtual machine configuration:
- `network="restrict"`
#### Bridged networking
Connect your virtual machine to a preconfigured network bridge. Add an
additional line to your virtual machine configuration:
- `network="br0"`
If you want to have a persistent MAC address for your bridged network
interface in the guest VM you can add `macaddr` to the virtual machine
configuration. QEMU requires that the MAC address is in the range:
**52:54:00:AB:00:00 - 52:54:00:AB:FF:FF**
So you can generate your own MAC addresses with:
- `macaddr="52:54:00:AB:51:AE"`
### USB redirection
Quickemu supports USB redirection via SPICE pass-through and host
pass-through. Quickemu supports USB redirection via SPICE pass-through
and host pass-through.
**NOTE!** When a USB device is redirected from the host, it will not be
usable by host operating system until the guest redirection is stopped.
Therefore, do not redirect the input devices, such as the keyboard and
mouse, as it will be difficult (or impossible) to revert the situation.
#### SPICE redirection (recommended)
Using SPICE for USB pass-through is easiest as it doesn't require any
elevated permission:
Both `spicy` from
[spice-gtk](https://www.spice-space.org/spice-gtk.html) (*Input -\>
Select USB Devices for redirection*) and `remote-viewer` from
[virt-viewer](https://gitlab.com/virt-viewer/virt-viewer) (*File -\> USB
device selection*) support this feature.
- Start Quickemu with `--display spice` and then
- Select `Input` -\> `Select USB Device for redirection` from the menu
to choose which device(s) you want to attach to the guest.
- \*\*`spicy` (default)
- \*\*Select `Input` -\> `Select USB Device for redirection` from the
menu to choose which device(s) you want to attach to the guest.
- \*\*`remote-viewer`
- \*\*Select `File` -\> `USB device selection` from the menu to choose
which device(s) you want to attach to the guest.
To ensure that this functionality works as expected, make sure that you
have installed the necessary SPICE Guest Tools on the virtual machine.
##### Enabling SPICE redirection on NixOS
On NixOS, if you encounter this error:
Error setting facl: Operation not permitted
Try setting [the following
option](https://search.nixos.org/options?channel=23.11&show=virtualisation.spiceUSBRedirection.enable&from=0&size=50&sort=relevance&type=packages&query=spiceusbredirec):
``` nix
virtualisation.spiceUSBRedirection.enable = true;
```
#### Host redirection (**NOT Recommended**)
**USB host redirection is not recommended**, it is provided purely for
backwards compatibility to older versions of Quickemu. Using SPICE is
preferred, see above.
Add an additional line to your virtual machine configuration. For
example:
- `usb_devices=("046d:082d" "046d:085e")`
In the example above:
- The USB device with vendor_id 046d and product_id 082d will be exposed
to the guest.
- The USB device with vendor_id 046d and product_id 085e will be exposed
to the guest.
If the USB devices are not writable, `quickemu` will display the
appropriate commands to modify the USB device(s) access permissions,
like this:
- USB: Host pass-through requested:
- Sennheiser Communications EPOS GTW 270 on bus 001 device 005 needs permission changes:
sudo chown -v root:user /dev/bus/usb/001/005
ERROR! USB permission changes are required 👆
### TPM
Since Quickemu 2.2.0 a software emulated TPM device can be added to
guest virtual machines. Just add `tpm="on"` to your VM configuration.
`quickget` will automatically add this line to Windows 11 virtual
machines.
# AUTHORS
Written by Martin Wimpress.
# BUGS
Submit bug reports online at:
<https://github.com/quickemu-project/quickemu/issues>
# SEE ALSO
Full sources at: <https://github.com/quickemu-project/quickemu>
quickget(1), quickemu(1), quickgui(1)
================================================
FILE: docs/quickget.1
================================================
.\" Automatically generated by Pandoc 3.8.3
.\"
.TH "QUICKGET" "1" "February 2, 2026" "quickget" "Quickget User Manual"
.SH NAME
quickget \- download and prepare materials for building a quickemu VM
.SH SYNOPSIS
\f[B]quickget\f[R] [\f[I]os\f[R]] [\f[I]release\f[R]]
[\f[I]edition\f[R]] | [\f[I]OPTION\f[R]]*
.SH DESCRIPTION
\f[B]quickget\f[R] will download the requisite materials and prepare a
configuration for \f[CR]quickemu\f[R] to use to build and run
.SH OPTIONS
.TP
\f[B][OS] [Release] [Edition]\f[R]
specify the OS and release (and optional edition) if insufficient input
is provided a list of missing options will be reported and the script
will exit.
Editions may not apply and will be defaulted if not provided.
.TP
\f[B]\-\-download\f[R] [edition]
Download image; no VM configuration
.TP
\f[B]\-\-create\-config\f[R] [path/url]
Create VM config for a OS image
.TP
\f[B]\-\-open\-homepage\f[R]
Open homepage for the OS
.TP
\f[B]\-\-show\f[R] [os]
Show OS information
.TP
\f[B]\-\-url\f[R] [os] [release] [edition]
Show image URL(s)
.TP
\f[B]\-\-check\f[R] [os] [release] [edition]
Check image URL(s)
.TP
\f[B]\-\-list\f[R]
List all supported systems
.TP
\f[B]\-\-list\-csv\f[R]
List everything in csv format
.TP
\f[B]\-\-list\-json\f[R]
List everything in json format
.TP
\f[B]\-\-version\f[R]
Show version
.TP
\f[B]\-\-help\f[R]
Show this help message
.SH NOTES
.SS Creating Linux guests 🐧
.SS Ubuntu
\f[CR]quickget\f[R] will automatically download an Ubuntu release and
create the virtual machine configuration.
.IP
.EX
quickget ubuntu 22.04
quickemu \-\-vm ubuntu\-22.04.conf
.EE
.IP \(bu 2
Complete the installation as normal.
.IP \(bu 2
Post\-install:
.RS 2
.IP \(bu 2
Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
enable copy/paste and USB redirection
.RS 2
.IP \(bu 2
\f[CR]sudo apt install spice\-vdagent\f[R]
.RE
.IP \(bu 2
Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
to enable file sharing.
.RS 2
.IP \(bu 2
\f[CR]sudo apt install spice\-webdavd\f[R]
.RE
.RE
.SS Ubuntu daily\-live images
\f[CR]quickget\f[R] can also download/refresh daily\-live images via
\f[CR]zsync\f[R] for Ubuntu developers and testers.
.IP
.EX
quickget ubuntu daily\-live
quickemu \-\-vm ubuntu\-daily\-live.conf
.EE
.PP
You can run \f[CR]quickget ubuntu daily\-live\f[R] to refresh your daily
development image as often as you like, it will even automatically
switch to a new series.
.SS Ubuntu Flavours
All the official Ubuntu flavours are supported, just replace
\f[CR]ubuntu\f[R] with your preferred flavour.
.PP
The project \c
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines
wiki
.UE \c
\ may have further information.
.IP \(bu 2
\f[CR]edubuntu\f[R] (Edubuntu)
.IP \(bu 2
\f[CR]kubuntu\f[R] (Kubuntu)
.IP \(bu 2
\f[CR]lubuntu\f[R] (Lubuntu)
.IP \(bu 2
\f[CR]ubuntu\-budgie\f[R] (Ubuntu Budgie)
.IP \(bu 2
\f[CR]ubuntucinnamon\f[R] (Ubuntu Cinnamon)
.IP \(bu 2
\f[CR]ubuntukylin\f[R] (Ubuntu Kylin)
.IP \(bu 2
\f[CR]ubuntu\-mate\f[R] (Ubuntu MATE)
.IP \(bu 2
\f[CR]ubuntu\-server\f[R] (Ubuntu Server)
.IP \(bu 2
\f[CR]ubuntustudio\f[R] (Ubuntu Studio)
.IP \(bu 2
\f[CR]ubuntu\f[R] (Ubuntu)
.IP \(bu 2
\f[CR]ubuntu\-unity\f[R] (Ubuntu Unity)
.IP \(bu 2
\f[CR]xubuntu\f[R] (Xubuntu)
.PP
You can also use \f[CR]quickget\f[R] with advanced options :
.IP
.EX
\-\-arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
\-\-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
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- Flags \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-create\-config:
\-\-disable\-unattended : Force quickget not to set up an unattended installation
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- For testing & development \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-\-url [os] [release] [edition] : Show image URL(s)
\-\-check [os] [release] [edition] : Check image URL(s)
\-\-check\-all\-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
\-\-list : List all supported systems
\-\-list\-csv : List everything in csv format
\-\-list\-json : List everything in json format
.EE
.PP
Here are some typical uses
.IP
.EX
# 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
.EE
.PP
The \f[CR]\-\-url\f[R], \f[CR]\-\-check\f[R], and
\f[CR]\-\-download\f[R] options are fully functional for all operating
systems, including Windows and macOS.
.PP
Further information is available from the project \c
.UR https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features
wiki
.UE \c
.SS Other Operating Systems
\f[CR]quickget\f[R] also supports:
.IP \(bu 2
\f[CR]alma\f[R] (AlmaLinux)
.IP \(bu 2
\f[CR]alpine\f[R] (Alpine Linux)
.IP \(bu 2
\f[CR]android\f[R] (Android x86)
.IP \(bu 2
\f[CR]antix\f[R] (Antix)
.IP \(bu 2
\f[CR]archcraft\f[R] (Archcraft)
.IP \(bu 2
\f[CR]archlinux\f[R] (Arch Linux)
.IP \(bu 2
\f[CR]artixlinux\f[R] (Artix Linux)
.IP \(bu 2
\f[CR]azurelinux\f[R] (Azure Linux)
.IP \(bu 2
\f[CR]batocera\f[R] (Batocera)
.IP \(bu 2
\f[CR]bazzite\f[R] (Bazzite)
.IP \(bu 2
\f[CR]biglinux\f[R] (BigLinux)
.IP \(bu 2
\f[CR]blendos\f[R] (BlendOS)
.IP \(bu 2
\f[CR]bodhi\f[R] (Bodhi)
.IP \(bu 2
\f[CR]bunsenlabs\f[R] (BunsenLabs)
.IP \(bu 2
\f[CR]cachyos\f[R] (CachyOS)
.IP \(bu 2
\f[CR]centos\-stream\f[R] (CentOS Stream)
.IP \(bu 2
\f[CR]chimeralinux\f[R] (Chimera Linux)
.IP \(bu 2
\f[CR]crunchbang++\f[R] (Crunchbangplusplus)
.IP \(bu 2
\f[CR]debian\f[R] (Debian)
.IP \(bu 2
\f[CR]deepin\f[R] (Deepin)
.IP \(bu 2
\f[CR]devuan\f[R] (Devuan)
.IP \(bu 2
\f[CR]dragonflybsd\f[R] (DragonFlyBSD)
.IP \(bu 2
\f[CR]easyos\f[R] (EasyOS)
.IP \(bu 2
\f[CR]elementary\f[R] (elementary OS)
.IP \(bu 2
\f[CR]endeavouros\f[R] (EndeavourOS)
.IP \(bu 2
\f[CR]endless\f[R] (Endless OS)
.IP \(bu 2
\f[CR]fedora\f[R] (Fedora)
.IP \(bu 2
\f[CR]freebsd\f[R] (FreeBSD)
.IP \(bu 2
\f[CR]freedos\f[R] (FreeDOS)
.IP \(bu 2
\f[CR]garuda\f[R] (Garuda Linux)
.IP \(bu 2
\f[CR]gentoo\f[R] (Gentoo)
.IP \(bu 2
\f[CR]ghostbsd\f[R] (GhostBSD)
.IP \(bu 2
\f[CR]gnomeos\f[R] (GNOME OS)
.IP \(bu 2
\f[CR]guix\f[R] (Guix)
.IP \(bu 2
\f[CR]haiku\f[R] (Haiku)
.IP \(bu 2
\f[CR]kali\f[R] (Kali)
.IP \(bu 2
\f[CR]kdeneon\f[R] (KDE Neon)
.IP \(bu 2
\f[CR]kolibrios\f[R] (KolibriOS)
.IP \(bu 2
\f[CR]linuxlite\f[R] (Linux Lite)
.IP \(bu 2
\f[CR]linuxmint\f[R] (Linux Mint)
.IP \(bu 2
\f[CR]lmde\f[R] (Linux Mint Debian Edition)
.IP \(bu 2
\f[CR]maboxlinux\f[R] (Mabox Linux)
.IP \(bu 2
\f[CR]mageia\f[R] (Mageia)
.IP \(bu 2
\f[CR]manjaro\f[R] (Manjaro)
.IP \(bu 2
\f[CR]mxlinux\f[R] (MX Linux)
.IP \(bu 2
\f[CR]netboot\f[R] (netboot.xyz)
.IP \(bu 2
\f[CR]netbsd\f[R] (NetBSD)
.IP \(bu 2
\f[CR]nitrux\f[R] (Nitrux)
.IP \(bu 2
\f[CR]nixos\f[R] (NixOS)
.IP \(bu 2
\f[CR]nwg\-shell\f[R] (nwg\-shell)
.IP \(bu 2
\f[CR]openbsd\f[R] (OpenBSD)
.IP \(bu 2
\f[CR]openindiana\f[R] (OpenIndiana)
.IP \(bu 2
\f[CR]opensuse\f[R] (openSUSE)
.IP \(bu 2
\f[CR]oraclelinux\f[R] (Oracle Linux)
.IP \(bu 2
\f[CR]parrotsec\f[R] (Parrot Security)
.IP \(bu 2
\f[CR]pclinuxos\f[R] (PCLinuxOS)
.IP \(bu 2
\f[CR]peppermint\f[R] (PeppermintOS)
.IP \(bu 2
\f[CR]popos\f[R] (Pop!_OS)
.IP \(bu 2
\f[CR]porteus\f[R] (Porteus)
.IP \(bu 2
\f[CR]primtux\f[R] (PrimTux)
.IP \(bu 2
\f[CR]proxmox\-ve\f[R] (Proxmox VE)
.IP \(bu 2
\f[CR]pureos\f[R] (PureOS)
.IP \(bu 2
\f[CR]reactos\f[R] (ReactOS)
.IP \(bu 2
\f[CR]rebornos\f[R] (RebornOS)
.IP \(bu 2
\f[CR]rockylinux\f[R] (Rocky Linux)
.IP \(bu 2
\f[CR]siduction\f[R] (Siduction)
.IP \(bu 2
\f[CR]slackware\f[R] (Slackware)
.IP \(bu 2
\f[CR]slax\f[R] (Slax)
.IP \(bu 2
\f[CR]slint\f[R] (Slint)
.IP \(bu 2
\f[CR]slitaz\f[R] (SliTaz)
.IP \(bu 2
\f[CR]solus\f[R] (Solus)
.IP \(bu 2
\f[CR]sparkylinux\f[R] (SparkyLinux)
.IP \(bu 2
\f[CR]spirallinux\f[R] (SpiralLinux)
.IP \(bu 2
\f[CR]tails\f[R] (Tails)
.IP \(bu 2
\f[CR]tinycore\f[R] (Tiny Core Linux)
.IP \(bu 2
\f[CR]trisquel\f[R] (Trisquel)
.IP \(bu 2
\f[CR]tuxedo\-os\f[R] (Tuxedo OS)
.IP \(bu 2
\f[CR]vanillaos\f[R] (Vanilla OS)
.IP \(bu 2
\f[CR]void\f[R] (Void Linux)
.IP \(bu 2
\f[CR]zorin\f[R] (Zorin OS)
.SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests
Custom Linux guests
.UE \c
Or you can download a Linux image and manually create a VM
configuration.
.IP \(bu 2
Download a .iso image of a Linux distribution
.IP \(bu 2
Create a VM configuration file; for example
\f[CR]debian\-bullseye.conf\f[R]
.IP
.EX
guest_os=\(dqlinux\(dq
disk_img=\(dqdebian\-bullseye/disk.qcow2\(dq
iso=\(dqdebian\-bullseye/firmware\-11.0.0\-amd64\-DVD\-1.iso\(dq
.EE
.IP \(bu 2
Use \f[CR]quickemu\f[R] to start the virtual machine:
.IP
.EX
quickemu \-\-vm debian\-bullseye.conf
.EE
.IP \(bu 2
Complete the installation as normal.
.IP \(bu 2
Post\-install:
.RS 2
.IP \(bu 2
Install the SPICE agent (\f[CR]spice\-vdagent\f[R]) in the guest to
enable copy/paste and USB redirection.
.IP \(bu 2
Install the SPICE WebDAV agent (\f[CR]spice\-webdavd\f[R]) in the guest
to enable file sharing.
.RE
.SS Supporting old Linux distros
If you want to run an old Linux , from 2016 or earlier, change the
\f[CR]guest_os\f[R] to \f[CR]linux_old\f[R].
This will enable the \f[CR]vmware\-svga\f[R] graphics driver which is
better supported on older distros.
.SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
Creating macOS Guests
.UE \c
\ 🍏
\f[B]Installing macOS in a VM can be a bit finicky, if you encounter
problems, \c
.UR https://github.com/quickemu-project/quickemu/discussions
check the Discussions
.UE \c
\ for solutions or ask for help there\f[R] 🛟
.PP
\f[CR]quickget\f[R] automatically downloads a macOS recovery image and
creates a virtual machine configuration.
.PP
Note: Some VPN users may need to \c
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235
turn off their VPN
.UE \c
\ in order to download a recovery image.
Some other users may find \c
.UR https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013
using a VPN
.UE \c
\ necessary in order to download a recovery image.
.IP
.EX
quickget macos big\-sur
quickemu \-\-vm macos\-big\-sur.conf
.EE
.PP
macOS \f[CR]mojave\f[R], \f[CR]catalina\f[R], \f[CR]big\-sur\f[R],
\f[CR]monterey\f[R], \f[CR]ventura\f[R] and \f[CR]sonoma\f[R] are
supported.
.IP \(bu 2
Use cursor keys and enter key to select the \f[B]macOS Base System\f[R]
.IP \(bu 2
From \f[B]macOS Utilities\f[R]
.RS 2
.IP \(bu 2
Click \f[B]Disk Utility\f[R] and \f[B]Continue\f[R]
.RS 2
.IP \(bu 2
Select \f[CR]QEMU HARDDISK Media\f[R] (\(ti103.08GB) from the list (on
Big Sur and above use \f[CR]Apple Inc. VirtIO Block Device\f[R]) and
click \f[B]Erase\f[R].
.IP \(bu 2
Enter a \f[CR]Name:\f[R] for the disk
.IP \(bu 2
If you are installing macOS Mojave or later (Catalina, Big Sur,
Monterey, Ventura and Sonoma), choose any of the APFS options as the
filesystem.
MacOS Extended may not work.
.RE
.IP \(bu 2
Click \f[B]Erase\f[R].
.IP \(bu 2
Click \f[B]Done\f[R].
.IP \(bu 2
Close Disk Utility
.RE
.IP \(bu 2
From \f[B]macOS Utilities\f[R]
.RS 2
.IP \(bu 2
Click \f[B]Reinstall macOS\f[R] and \f[B]Continue\f[R]
.RE
.IP \(bu 2
Complete the installation as you normally would.
.RS 2
.IP \(bu 2
On the first reboot use cursor keys and enter key to select \f[B]macOS
Installer\f[R]
.IP \(bu 2
On the subsequent reboots use cursor keys and enter key to select the
disk you named
.RE
.IP \(bu 2
Once you have finished installing macOS you will be presented with an
the out\-of\-the\-box first\-start wizard to configure various options
and set up your username and password
.IP \(bu 2
OPTIONAL: After you have concluded the out\-of\-the\-box wizard, you may
want to enable the TRIM feature that the computer industry created for
SSD disks.
This feature in our macOS installation will allow QuickEmu to compact
(shrink) your macOS disk image whenever you delete files inside the
Virtual Machine.
Without this step your macOS disk image will only ever get larger and
will not shrink even when you delete lots of data inside macOS.
.RS 2
.IP \(bu 2
To enable TRIM, open the Terminal application and type the following
command followed by pressing enter to tell macos to use the TRIM command
on the hard disk when files are deleted:
.RE
.IP
.EX
sudo trimforce enable
.EE
.PP
You will be prompted to enter your account\(aqs password to gain the
privilege needed.
Once you\(aqve 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 \(dqyes\(dq response) followed by enter to confirm.
.PP
If you press enter without first typing y the system will consider that
a negative response as though you said \(dqno\(dq:
.IP
.EX
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 \(dqas is\(dq 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)?
.EE
.PP
And a second confirmation once you\(aqve confirmed the previous one:
.IP
.EX
Your system will immediately reboot when this is complete.
Is this OK (y/N)?
.EE
.PP
As the last message states, your system will automatically reboot as
soon as the command completes.
.PP
The default macOS configuration looks like this:
.IP
.EX
guest_os=\(dqmacos\(dq
img=\(dqmacos\-big\-sur/RecoveryImage.img\(dq
disk_img=\(dqmacos\-big\-sur/disk.qcow2\(dq
macos_release=\(dqbig\-sur\(dq
.EE
.IP \(bu 2
\f[CR]guest_os=\(dqmacos\(dq\f[R] instructs Quickemu to optimise for
macOS.
.IP \(bu 2
\f[CR]macos_release=\(dqbig\-sur\(dq\f[R] instructs Quickemu to optimise
for a particular macOS release.
.RS 2
.IP \(bu 2
For example VirtIO Network and Memory Ballooning are available in Big
Sur and newer, but not previous releases.
.IP \(bu 2
And VirtIO Block Media (disks) are supported/stable in Catalina and
newer.
.RE
.SH macOS compatibility
There are some considerations when running macOS via Quickemu.
.IP \(bu 2
Supported macOS releases:
.RS 2
.IP \(bu 2
Mojave
.IP \(bu 2
Catalina
.IP \(bu 2
Big Sur
.IP \(bu 2
Monterey
.IP \(bu 2
Ventura
.IP \(bu 2
Sonoma
.RE
.IP \(bu 2
\f[CR]quickemu\f[R] will automatically download the required \c
.UR https://github.com/acidanthera/OpenCorePkg
OpenCore
.UE \c
\ bootloader and OVMF firmware from \c
.UR https://github.com/kholia/OSX-KVM
OSX\-KVM
.UE \c
\&.
.IP \(bu 2
Optimised by default, but no GPU acceleration is available.
.RS 2
.IP \(bu 2
Host CPU vendor is detected and guest CPU is optimised accordingly.
.IP \(bu 2
\c
.UR https://www.kraxel.org/blog/2019/06/macos-qemu-guest/
VirtIO Block Media
.UE \c
\ is used for the system disk where supported.
.IP \(bu 2
\c
.UR http://philjordan.eu/osx-virt/
VirtIO \f[CR]usb\-tablet\f[R]
.UE \c
\ is used for the mouse.
.IP \(bu 2
VirtIO Network (\f[CR]virtio\-net\f[R]) is supported and enabled on
macOS Big Sur and newer, but earlier releases use \f[CR]vmxnet3\f[R].
.IP \(bu 2
VirtIO Memory Ballooning is supported and enabled on macOS Big Sur and
newer but disabled for other support macOS releases.
.RE
.IP \(bu 2
USB host and SPICE pass\-through is:
.RS 2
.IP \(bu 2
UHCI (USB 2.0) on macOS Catalina and earlier.
.IP \(bu 2
XHCI (USB 3.0) on macOS Big Sur and newer.
.RE
.IP \(bu 2
Display resolution can be changed via \f[CR]quickemu\f[R] using
\f[CR]\-\-width\f[R] and \f[CR]\-\-height\f[R] command line arguments.
.IP \(bu 2
\f[B]Full Duplex audio requires \c
.UR https://github.com/chris1111/VoodooHDA-OC
VoodooHDA OC
.UE \c
\ or pass\-through a USB audio\-device to the macOS guest VM\f[R].
.RS 2
.IP \(bu 2
NOTE!
\c
.UR https://disable-gatekeeper.github.io/
Gatekeeper
.UE \c
\ and \c
.UR https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection
System Integrity Protection (SIP)
.UE \c
\ need to be disabled to install VoodooHDA OC
.RE
.IP \(bu 2
File sharing between guest and host is available via \c
.UR https://wiki.qemu.org/Documentation/9psetup
virtio\-9p
.UE \c
\ and \c
.UR https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24
SPICE webdavd
.UE \c
\&.
.IP \(bu 2
Copy/paste via SPICE agent is \f[B]not available on macOS\f[R].
.SH macOS App Store
If you see \f[I]\(dqYour device or computer could not be
verified\(dq\f[R] when you try to login to the App Store, make sure that
your wired ethernet device is \f[CR]en0\f[R].
Use \f[CR]ifconfig\f[R] in a terminal to verify this.
.PP
If the wired ethernet device is not \f[CR]en0\f[R], then then go to
\f[I]System Preferences\f[R] \-> \f[I]Network\f[R], delete all the
network devices and apply the changes.
Next, open a terminal and run the following:
.IP
.EX
sudo rm /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
.EE
.PP
Now reboot, and the App Store should work.
.PP
There may be further advice and information about macOS guests in the
project \c
.UR https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests
wiki
.UE \c
\&.
.SS \c
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
Creating Windows guests
.UE \c
\ 🪟
\f[CR]quickget\f[R] can download \c
.UR https://www.microsoft.com/software-download/windows10
\f[B]Windows 10\f[R]
.UE \c
\ and \c
.UR https://www.microsoft.com/software-download/windows11
\f[B]Windows 11\f[R]
.UE \c
\ automatically and create an optimised virtual machine configuration.
This configuration also includes the \c
.UR https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/
VirtIO drivers for Windows
.UE \c
\&.
.PP
\f[B]Windows 8.1\f[R] is also supported but doesn\(aqt feature any
automated installation or driver optimisation.
.PP
\f[CR]quickget\f[R] can also download \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise
Windows 10 LTSC
.UE \c
\ and Windows Server \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2
2012\-r2
.UE \c
, \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016
2016
.UE \c
, \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019
2019
.UE \c
, and \c
.UR https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022
2022
.UE \c
\&.
No automated installation is supported for these releases.
.IP
.EX
quickget windows 11
quickemu \-\-vm windows\-11.conf
.EE
.IP \(bu 2
Complete the installation as you normally would.
.IP \(bu 2
All relevant drivers and services should be installed automatically.
.IP \(bu 2
A local administrator user account is automatically created, with these
credentials:
.RS 2
.IP \(bu 2
Username: \f[CR]Quickemu\f[R]
.IP \(bu 2
Password: \f[CR]quickemu\f[R]
.RE
.PP
Further information is available from the project \c
.UR https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines
wiki
.UE \c
.SH AUTHORS
Written by Martin Wimpress.
.SH BUGS
Submit bug reports online at: \c
.UR https://github.com/quickemu-project/quickemu/issues
.UE \c
.SH SEE ALSO
Full sources at: \c
.UR https://github.com/quickemu-project/quickemu
.UE \c
.PP
quickemu(1), quickemu_conf(5), quickgui(1)
.SH AUTHORS
Martin Wimpress.
================================================
FILE: docs/quickget.1.md
================================================
---
author: Martin Wimpress
date: February 2, 2026
footer: quickget
header: Quickget User Manual
section: 1
title: QUICKGET
---
# NAME
quickget - download and prepare materials for building a quickemu VM
# SYNOPSIS
**quickget** \[*os*\] \[*release*\] \[*edition*\] \| \[*OPTION*\]\*
# DESCRIPTION
**quickget** will download the requisite materials and prepare a
configuration for `quickemu` to use to build and run
# OPTIONS
**\[OS\] \[Release\] \[Edition\]**
: specify the OS and release (and optional edition) if insufficient
input is provided a list of missing options will be reported and the
script will exit. Editions may not apply and will be defaulted if
not provided.
**--download** <os> <release> \[edition\]
: Download image; no VM configuration
**--create-config** <os> \[path/url\]
: Create VM config for a OS image
**--open-homepage** <os>
: Open homepage for the OS
**--show** \[os\]
: Show OS information
**--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
**--version**
: Show version
**--help**
: Show this help message
# NOTES
## Creating Linux guests 🐧
### Ubuntu
`quickget` will automatically download an Ubuntu release and create the
virtual machine configuration.
``` shell
quickget ubuntu 22.04
quickemu --vm ubuntu-22.04.conf
```
- Complete the installation as normal.
- Post-install:
- Install the SPICE agent (`spice-vdagent`) in the guest to enable
copy/paste and USB redirection
- `sudo apt install spice-vdagent`
- Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
enable file sharing.
- `sudo apt install spice-webdavd`
### Ubuntu daily-live images
`quickget` can also download/refresh daily-live images via `zsync` for
Ubuntu developers and testers.
``` shell
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.
### Ubuntu Flavours
All the official Ubuntu flavours are supported, just replace `ubuntu`
with your preferred flavour.
The project
[wiki](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines)
may have further information.
- `edubuntu` (Edubuntu)
- `kubuntu` (Kubuntu)
- `lubuntu` (Lubuntu)
- `ubuntu-budgie` (Ubuntu Budgie)
- `ubuntucinnamon` (Ubuntu Cinnamon)
- `ubuntukylin` (Ubuntu Kylin)
- `ubuntu-mate` (Ubuntu MATE)
- `ubuntu-server` (Ubuntu Server)
- `ubuntustudio` (Ubuntu Studio)
- `ubuntu` (Ubuntu)
- `ubuntu-unity` (Ubuntu Unity)
- `xubuntu` (Xubuntu)
You can also use `quickget` with advanced options :
``` text
--arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64)
--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
------------------------------------ Flags -------------------------------------
--create-config:
--disable-unattended : Force quickget not to set up an unattended installation
-------------------------- For testing & development ---------------------------
--url [os] [release] [edition] : Show image URL(s)
--check [os] [release] [edition] : Check image URL(s)
--check-all-arch [os] [release] [edition] : Check downloads for all architectures (amd64 and arm64)
--list : List all supported systems
--list-csv : List everything in csv format
--list-json : List everything in json format
```
Here are some typical uses
``` shell
# 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
[wiki](https://github.com/quickemu-project/quickemu/wiki/06-Advanced-quickget-features)
### Other Operating Systems
`quickget` also supports:
- `alma` (AlmaLinux)
- `alpine` (Alpine Linux)
- `android` (Android x86)
- `antix` (Antix)
- `archcraft` (Archcraft)
- `archlinux` (Arch Linux)
- `artixlinux` (Artix Linux)
- `azurelinux` (Azure Linux)
- `batocera` (Batocera)
- `bazzite` (Bazzite)
- `biglinux` (BigLinux)
- `blendos` (BlendOS)
- `bodhi` (Bodhi)
- `bunsenlabs` (BunsenLabs)
- `cachyos` (CachyOS)
- `centos-stream` (CentOS Stream)
- `chimeralinux` (Chimera Linux)
- `crunchbang++` (Crunchbangplusplus)
- `debian` (Debian)
- `deepin` (Deepin)
- `devuan` (Devuan)
- `dragonflybsd` (DragonFlyBSD)
- `easyos` (EasyOS)
- `elementary` (elementary OS)
- `endeavouros` (EndeavourOS)
- `endless` (Endless OS)
- `fedora` (Fedora)
- `freebsd` (FreeBSD)
- `freedos` (FreeDOS)
- `garuda` (Garuda Linux)
- `gentoo` (Gentoo)
- `ghostbsd` (GhostBSD)
- `gnomeos` (GNOME OS)
- `guix` (Guix)
- `haiku` (Haiku)
- `kali` (Kali)
- `kdeneon` (KDE Neon)
- `kolibrios` (KolibriOS)
- `linuxlite` (Linux Lite)
- `linuxmint` (Linux Mint)
- `lmde` (Linux Mint Debian Edition)
- `maboxlinux` (Mabox Linux)
- `mageia` (Mageia)
- `manjaro` (Manjaro)
- `mxlinux` (MX Linux)
- `netboot` (netboot.xyz)
- `netbsd` (NetBSD)
- `nitrux` (Nitrux)
- `nixos` (NixOS)
- `nwg-shell` (nwg-shell)
- `openbsd` (OpenBSD)
- `openindiana` (OpenIndiana)
- `opensuse` (openSUSE)
- `oraclelinux` (Oracle Linux)
- `parrotsec` (Parrot Security)
- `pclinuxos` (PCLinuxOS)
- `peppermint` (PeppermintOS)
- `popos` (Pop!\_OS)
- `porteus` (Porteus)
- `primtux` (PrimTux)
- `proxmox-ve` (Proxmox VE)
- `pureos` (PureOS)
- `reactos` (ReactOS)
- `rebornos` (RebornOS)
- `rockylinux` (Rocky Linux)
- `siduction` (Siduction)
- `slackware` (Slackware)
- `slax` (Slax)
- `slint` (Slint)
- `slitaz` (SliTaz)
- `solus` (Solus)
- `sparkylinux` (SparkyLinux)
- `spirallinux` (SpiralLinux)
- `tails` (Tails)
- `tinycore` (Tiny Core Linux)
- `trisquel` (Trisquel)
- `tuxedo-os` (Tuxedo OS)
- `vanillaos` (Vanilla OS)
- `void` (Void Linux)
- `zorin` (Zorin OS)
### [Custom Linux guests](https://github.com/quickemu-project/quickemu/wiki/02-Create-Linux-virtual-machines#manually-create-linux-guests)
Or you can download a Linux image and manually create a VM
configuration.
- Download a .iso image of a Linux distribution
- Create a VM configuration file; for example `debian-bullseye.conf`
``` shell
guest_os="linux"
disk_img="debian-bullseye/disk.qcow2"
iso="debian-bullseye/firmware-11.0.0-amd64-DVD-1.iso"
```
- Use `quickemu` to start the virtual machine:
``` shell
quickemu --vm debian-bullseye.conf
```
- Complete the installation as normal.
- Post-install:
- Install the SPICE agent (`spice-vdagent`) in the guest to enable
copy/paste and USB redirection.
- Install the SPICE WebDAV agent (`spice-webdavd`) in the guest to
enable file sharing.
## Supporting old Linux distros
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](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests) 🍏
**Installing macOS in a VM can be a bit finicky, if you encounter
problems, [check the
Discussions](https://github.com/quickemu-project/quickemu/discussions)
for solutions or ask for help there** 🛟
`quickget` automatically downloads a macOS recovery image and creates a
virtual machine configuration.
Note: Some VPN users may need to [turn off their
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-3506845235)
in order to download a recovery image. Some other users may find [using
a
VPN](https://github.com/quickemu-project/quickemu/issues/1391#issuecomment-2429146013)
necessary in order to download a recovery image.
``` shell
quickget macos big-sur
quickemu --vm macos-big-sur.conf
```
macOS `mojave`, `catalina`, `big-sur`, `monterey`, `ventura` and
`sonoma` are supported.
- Use cursor keys and enter key to select the **macOS Base System**
- From **macOS Utilities**
- Click **Disk Utility** and **Continue**
- Select `QEMU HARDDISK Media` (~103.08GB) from the list (on Big Sur
and above use `Apple Inc. VirtIO Block Device`) and click
**Erase**.
- Enter a `Name:` for the disk
- If you are installing macOS Mojave or later (Catalina, Big Sur,
Monterey, Ventura and Sonoma), choose any of the APFS options as
the filesystem. MacOS Extended may not work.
- Click **Erase**.
- Click **Done**.
- Close Disk Utility
- From **macOS Utilities**
- Click **Reinstall macOS** and **Continue**
- Complete the installation as you normally would.
- On the first reboot use cursor keys and enter key to select **macOS
Installer**
- On the subsequent reboots use cursor keys and enter key to select
the disk you named
- Once you have finished installing macOS you will be presented with an
the out-of-the-box first-start wizard to configure various options and
set up your username and password
- OPTIONAL: After you have concluded the out-of-the-box wizard, you may
want to enable the TRIM feature that the computer industry created for
SSD disks. This feature in our macOS installation will allow QuickEmu
to compact (shrink) your macOS disk image whenever you delete files
inside the Virtual Machine. Without this step your macOS disk image
will only ever get larger and will not shrink even when you delete
lots of data inside macOS.
- To enable TRIM, open the Terminal application and type the following
command followed by pressing <kbd>enter</kbd> to tell macos to use
the TRIM command on the hard disk when files are deleted:
``` shell
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
<kbd>enter</kbd> the command will request confirmation in the form of
two questions that require you to type <kbd>y</kbd> (for a "yes"
response) followed by <kbd>enter</kbd> to confirm.
If you press <kbd>enter</kbd> without first typing <kbd>y</kbd> the
system will consider that a negative response as though you said "no":
``` plain
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:
``` plain
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:
``` shell
guest_os="macos"
img="macos-big-sur/RecoveryImage.img"
disk_img="macos-big-sur/disk.qcow2"
macos_release="big-sur"
```
- `guest_os="macos"` instructs Quickemu to optimise for macOS.
- `macos_release="big-sur"` instructs Quickemu to optimise for a
particular macOS release.
- For example VirtIO Network and Memory Ballooning are available in
Big Sur and newer, but not previous releases.
- And VirtIO Block Media (disks) are supported/stable in Catalina and
newer.
# macOS compatibility
There are some considerations when running macOS via Quickemu.
- Supported macOS releases:
- Mojave
- Catalina
- Big Sur
- Monterey
- Ventura
- Sonoma
- `quickemu` will automatically download the required
[OpenCore](https://github.com/acidanthera/OpenCorePkg) bootloader and
OVMF firmware from [OSX-KVM](https://github.com/kholia/OSX-KVM).
- Optimised by default, but no GPU acceleration is available.
- Host CPU vendor is detected and guest CPU is optimised accordingly.
- [VirtIO Block
Media](https://www.kraxel.org/blog/2019/06/macos-qemu-guest/) is
used for the system disk where supported.
- [VirtIO `usb-tablet`](http://philjordan.eu/osx-virt/) is used for
the mouse.
- VirtIO Network (`virtio-net`) is supported and enabled on macOS Big
Sur and newer, but earlier releases use `vmxnet3`.
- VirtIO Memory Ballooning is supported and enabled on macOS Big Sur
and newer but disabled for other support macOS releases.
- USB host and SPICE pass-through is:
- UHCI (USB 2.0) on macOS Catalina and earlier.
- XHCI (USB 3.0) on macOS Big Sur and newer.
- Display resolution can be changed via `quickemu` using `--width` and
`--height` command line arguments.
- **Full Duplex audio requires [VoodooHDA
OC](https://github.com/chris1111/VoodooHDA-OC) or pass-through a USB
audio-device to the macOS guest VM**.
- NOTE! [Gatekeeper](https://disable-gatekeeper.github.io/) and
[System Integrity Protection
(SIP)](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)
need to be disabled to install VoodooHDA OC
- File sharing between guest and host is available via
[virtio-9p](https://wiki.qemu.org/Documentation/9psetup) and [SPICE
webdavd](https://gitlab.gnome.org/GNOME/phodav/-/merge_requests/24).
- Copy/paste via SPICE agent is **not available on macOS**.
# macOS App Store
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:
``` shell
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
[wiki](https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#automatically-create-macos-guests).
## [Creating Windows guests](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines) 🪟
`quickget` can download [**Windows
10**](https://www.microsoft.com/software-download/windows10) and
[**Windows 11**](https://www.microsoft.com/software-download/windows11)
automatically and create an optimised virtual machine configuration.
This configuration also includes the [VirtIO drivers for
Windows](https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/).
**Windows 8.1** is also supported but doesn't feature any automated
installation or driver optimisation.
`quickget` can also download [Windows 10
LTSC](https://www.microsoft.com/en-us/evalcenter/download-windows-10-enterprise)
and Windows Server
[2012-r2](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2012-r2),
[2016](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2016),
[2019](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2019),
and
[2022](https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022).
No automated installation is supported for these releases.
``` shell
quickget windows 11
quickemu --vm windows-11.conf
```
- Complete the installation as you normally would.
- All relevant drivers and services should be installed automatically.
- A local administrator user account is automatically created, with
these credentials:
- Username: `Quickemu`
- Password: `quickemu`
Further information is available from the project
[wiki](https://github.com/quickemu-project/quickemu/wiki/04-Create-Windows-virtual-machines)
# AUTHORS
Written by Martin Wimpress.
# BUGS
Submit bug reports online at:
<https://github.com/quickemu-project/quickemu/issues>
# SEE ALSO
Full sources at: <https://github.com/quickemu-project/quickemu>
quickemu(1), quickemu_conf(5), quickgui(1)
================================================
FILE: flake.lock
================================================
{
"nodes": {
"flake-schemas": {
"locked": {
"lastModified": 1772200446,
"narHash": "sha256-hcUPpu25+VLvQsf961cu4zTeA//Ab35MaMjqSS/Ojqc=",
"rev": "d6a6b7cfa25bea552c197c9e227cd293ff801dbb",
"revCount": 115,
"type": "tarball",
"url": "https://api.flakehub.com/f/pinned/DeterminateSystems/flake-schemas/0.3.0/019c9f61-e746-760e-a1fe-53f05b10d026/source.tar.gz"
},
"original": {
"type": "tarball",
"url": "https://flakehub.com/f/DeterminateSystems/flake-schemas/%2A.tar.gz"
}
},
"nixpkgs": {
"locked": {
"lastModified": 1771848320,
"narHash": "sha256-0MAd+0mun3K/Ns8JATeHT1sX28faLII5hVLq0L3BdZU=",
"owner": "nixos",
"repo": "nixpkgs",
"rev": "2fc6539b481e1d2569f25f8799236694180c0993",
"type": "github"
},
"original": {
"owner": "nixos",
"ref": "nixos-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"root": {
"inputs": {
"flake-schemas": "flake-schemas",
"nixpkgs": "nixpkgs"
}
}
},
"root": "root",
"version": 7
}
================================================
FILE: flake.nix
================================================
{
description = "Quickemu flake";
inputs = {
flake-schemas.url = "https://flakehub.com/f/DeterminateSystems/flake-schemas/*.tar.gz";
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
};
outputs =
{
self,
flake-schemas,
nixpkgs,
}:
let
# Define supported systems and a helper function for generating system-specific outputs
supportedSystems = [
"x86_64-linux"
"x86_64-darwin"
"aarch64-darwin"
"aarch64-linux"
];
forEachSupportedSystem =
f:
nixpkgs.lib.genAttrs supportedSystems (
system:
f {
system = system;
pkgs = import nixpkgs { inherit system; };
}
);
in
{
# Define schemas for the flake's outputs
schemas = flake-schemas.schemas;
# Define overlays for each supported system
overlays = {
default =
final: prev:
let
# OVMF is only available/needed on Linux
ovmfArgs =
if final.stdenv.hostPlatform.isLinux then
{ }
else
{
OVMF = null;
OVMFFull = null;
};
in
{
quickemu = final.callPackage ./package.nix ovmfArgs;
};
};
# Define packages for each supported system
packages = forEachSupportedSystem (
{ pkgs, system, ... }:
let
# OVMF is only available/needed on Linux
ovmfArgs =
if pkgs.stdenv.hostPlatform.isLinux then
{ }
else
{
OVMF = null;
OVMFFull = null;
};
in
rec {
quickemu = pkgs.callPackage ./package.nix ovmfArgs;
default = quickemu;
}
);
# Define devShells for each supported system
devShells = forEachSupportedSystem (
{ pkgs, system, ... }:
let
# OVMF is only available/needed on Linux
ovmfArgs =
if pkgs.stdenv.hostPlatform.isLinux then
{ }
else
{
OVMF = null;
OVMFFull = null;
};
in
{
default = pkgs.callPackage ./devshell.nix ovmfArgs;
}
);
};
}
================================================
FILE: package.nix
================================================
{
lib,
fetchFromGitHub,
installShellFiles,
makeWrapper,
stdenv,
testers,
cdrtools,
curl,
gawk,
gnugrep,
gnused,
jq,
mesa-demos,
pciutils,
procps,
python3,
qemu_full,
samba,
socat,
spice-gtk,
swtpm,
unzip,
usbutils,
util-linux,
xdg-user-dirs,
xrandr,
zsync,
OVMF ? null,
OVMFFull ? null,
}:
let
runtimePaths = [
cdrtools
curl
gawk
gnugrep
gnused
jq
pciutils
procps
python3
qemu_full
samba
socat
swtpm
unzip
util-linux
xrandr
zsync
]
++ lib.optionals stdenv.hostPlatform.isLinux [
mesa-demos
OVMF
OVMFFull
usbutils
xdg-user-dirs
];
# Extract version using builtins.split to avoid regex backtracking on large files.
# builtins.match with .* patterns on multi-kilobyte files can cause stack overflow.
versionParts = builtins.split "readonly VERSION=\"([0-9]+\\.[0-9]+\\.[0-9]+)\"" (
builtins.readFile ./quickemu
);
version = builtins.elemAt (builtins.elemAt versionParts 1) 0;
in
stdenv.mkDerivation (finalAttrs: {
pname = "quickemu";
version = version;
src = lib.cleanSource ./.;
postPatch = ''
sed -i \
${
lib.optionalString (OVMF != null && OVMFFull != null) ''
-e '/OVMF_CODE_4M.secboot.fd/s|ovmfs=(|ovmfs=("${OVMFFull.firmware}","${OVMFFull.variablesMs}" |' \
-e '/OVMF_CODE_4M.fd/s|ovmfs=(|ovmfs=("${OVMF.firmware}","${OVMF.variables}" |' \
''
} \
-e '/cp "''${VARS_IN}" "''${VARS_OUT}"/a chmod +w "''${VARS_OUT}"' \
-e 's/Icon=.*qemu.svg/Icon=qemu/' \
-e 's,\$(command -v smbd),${samba}/bin/smbd,' \
quickemu
'';
nativeBuildInputs = [
makeWrapper
installShellFiles
];
installPhase = ''
runHook preInstall
installManPage docs/quickget.1 docs/quickemu.1 docs/quickemu_conf.5
install -Dm755 -t "$out/bin" chunkcheck quickemu quickget quickreport
# spice-gtk needs to be put in suffix so that when virtualisation.spiceUSBRedirection
# is enabled, the wrapped spice-client-glib-usb-acl-helper is used
for f in chunkcheck quickget quickemu quickreport; do
wrapProgram $out/bin/$f \
--prefix PATH : "${lib.makeBinPath runtimePaths}" \
--suffix PATH : "${lib.makeBinPath [ spice-gtk ]}"
done
runHook postInstall
'';
passthru.tests = testers.testVersion { package = finalAttrs.finalPackage; };
meta = {
description = "Quickly create and run optimised Windows, macOS and Linux virtual machines";
homepage = "https://github.com/quickemu-project/quickemu";
changelog = "https://github.com/quickemu-project/quickemu/releases/tag/${finalAttrs.version}";
mainProgram = "quickemu";
license = lib.licenses.mit;
maintainers = with lib.maintainers; [
fedx-sudo
flexiondotorg
];
};
})
================================================
FILE: quickemu
================================================
#!/usr/bin/env bash
export LC_ALL=C
if ((BASH_VERSINFO[0] < 4)); then
echo "Sorry, you need bash 4.0 or newer to run this script."
exit 1
fi
function ignore_msrs_always() {
# Make sure the host has /etc/modprobe.d
if [ -d /etc/modprobe.d ]; then
# Skip if ignore_msrs is already enabled, assumes initramfs has been rebuilt
if ! grep -lq 'ignore_msrs=Y' /etc/modprobe.d/kvm-quickemu.conf >/dev/null 2>&1; then
echo "options kvm ignore_msrs=Y" | sudo tee /etc/modprobe.d/kvm-quickemu.conf
sudo update-initramfs -k all -u
fi
else
echo "ERROR! /etc/modprobe.d was not found, I don't know how to configure this system."
exit 1
fi
}
function ignore_msrs_alert() {
local ignore_msrs=""
if [ "${OS_KERNEL}" == "Darwin" ]; then
return
elif [ -e /sys/module/kvm/parameters/ignore_msrs ]; then
ignore_msrs=$(cat /sys/module/kvm/parameters/ignore_msrs)
if [ "${ignore_msrs}" == "N" ]; then
echo " - MSR: WARNING! Ignoring unhandled Model-Specific Registers is disabled."
echo
echo " echo 1 | sudo tee /sys/module/kvm/parameters/ignore_msrs"
echo
echo " If you are unable to run macOS or Windows VMs then run the above 👆"
echo " This will enable ignoring of unhandled MSRs until you reboot the host."
echo " You can make this change permanent by running: 'quickemu --ignore-msrs-always'"
fi
fi
}
# Check for TSC instability that can cause macOS Ventura+ to freeze on AMD Ryzen mobile CPUs.
# Returns 0 if check passes or user acknowledges warning, exits with 1 if user aborts.
# Reference: https://github.com/quickemu-project/quickemu/issues/1273
function check_macos_tsc_stability() {
# Gate 1: Only on Linux hosts
if [ "${OS_KERNEL}" != "Linux" ]; then
return 0
fi
# Gate 2: Only for AMD CPUs
if [ "${HOST_CPU_VENDOR}" != "AuthenticAMD" ]; then
return 0
fi
# Gate 3: Only for macOS guests
if [ "${guest_os}" != "macos" ]; then
return 0
fi
# Gate 4: Only for macOS Ventura (13) and newer
case ${macos_release} in
ventura|sonoma|sequoia|tahoe) ;;
*) return 0 ;;
esac
# Gate 5: Skip if user has already set tsc=reliable in kernel cmdline
local cmdline=""
if [ -r /proc/cmdline ]; then
cmdline=$(cat /proc/cmdline)
if [[ "${cmdline}" == *"tsc=reliable"* ]]; then
return 0
fi
fi
# Gate 6: Check if TSC is the current clocksource (indicates stable TSC)
local clocksource_path="/sys/devices/system/clocksource/clocksource0/current_clocksource"
local current_clocksource=""
if [ -r "${clocksource_path}" ]; then
current_clocksource=$(cat "${clocksource_path}")
if [ "${current_clocksource}" == "tsc" ]; then
return 0
fi
else
# Cannot determine clocksource - assume OK and let user discover issues
return 0
fi
# All gates failed - this system is at risk
# Check if warning should be skipped
if [ "${IGNORE_TSC_WARNING}" == "1" ]; then
echo " - TSC: WARNING! Unstable TSC detected (clocksource: ${current_clocksource})"
echo " Proceeding anyway due to --ignore-tsc-warning flag."
return 0
fi
# Display warning and prompt user
echo " - TSC: WARNING! Unstable TSC detected (clocksource: ${current_clocksource})"
echo " macOS ${macos_release^} may freeze on AMD Ryzen mobile CPUs."
echo
echo " Fix: Add 'tsc=reliable' to kernel boot parameters and reboot."
echo " Or: Use macOS Big Sur (11) or Monterey (12) instead."
echo " See: https://github.com/quickemu-project/quickemu/wiki/03-Create-macOS-virtual-machines#tsc-instability-on-amd-ryzen-mobile-cpus"
echo
# Log the warning
echo "TSC_WARNING: clocksource=${current_clocksource} macos_release=${macos_release} cpu_vendor=${HOST_CPU_VENDOR}" >> "${VMDIR}/${VMNAME}.log"
# Interactive prompt - check if stdin is a terminal
if [ -t 0 ]; then
echo -n "Do you want to continue anyway? [y/N] "
read -r response
case "${response}" in
[yY]|[yY][eE][sS])
echo " - TSC: Proceeding despite unstable TSC warning."
return 0
;;
*)
echo " - TSC: Aborting. Please apply one of the solutions above."
exit 1
;;
esac
else
# Non-interactive mode - abort by default for safety
echo "ERROR! Non-interactive mode detected. Use --ignore-tsc-warning to bypass this check."
exit 1
fi
}
function delete_shortcut() {
local SHORTCUT_DIR="${HOME}/.local/share/applications"
if [ -e "${SHORTCUT_DIR}/${VMNAME}.desktop" ]; then
rm "${SHORTCUT_DIR}/${VMNAME}.desktop"
echo " - Deleted ${SHORTCUT_DIR}/${VMNAME}.desktop"
fi
}
function delete_disk() {
echo "Deleting ${VMNAME} virtual hard disk"
if [ -e "${disk_img}" ]; then
rm "${disk_img}" >/dev/null 2>&1
# Remove any EFI vars, but not for macOS
rm "${VMDIR}"/OVMF_VARS*.fd >/dev/null 2>&1
rm "${VMDIR}/${VMNAME}-vars.fd" >/dev/null 2>&1
echo " - Deleted ${disk_img}"
delete_shortcut
else
echo " - ${disk_img} not found. Doing nothing."
fi
}
function delete_vm() {
echo "Deleting ${VMNAME} completely"
if [ -d "${VMDIR}" ]; then
rm -rf "${VMDIR}"
rm "${VM}"
echo " - Deleted ${VM} and ${VMDIR}/"
delete_shortcut
else
echo " - ${VMDIR} not found. Doing nothing."
fi
}
function kill_vm() {
echo "Killing ${VMNAME}"
if [ -z "${VM_PID}" ]; then
echo " - ${VMNAME} is not running."
rm -f "${VMDIR}/${VMNAME}.pid"
rm -f "${VMDIR}/${VMNAME}.spice"
rm -f "${VMDIR}/${VMNAME}.sock"
elif [ -n "${VM_PID}" ]; then
if kill -9 "${VM_PID}" > /dev/null 2>&1; then
echo " - ${VMNAME} (${VM_PID}) killed."
rm -f "${VMDIR}/${VMNAME}.pid"
rm -f "${VMDIR}/${VMNAME}.spice"
rm -f "${VMDIR}/${VMNAME}.sock"
else
echo " - ${VMNAME} (${VM_PID}) was not killed."
fi
elif [ ! -r "${VMDIR}/${VMNAME}.pid" ]; then
echo " - ${VMNAME} has no ${VMDIR}/${VMNAME}.pid"
fi
}
function snapshot_apply() {
echo "Snapshot apply to ${disk_img}"
local TAG="${1}"
if [ -z "${TAG}" ]; then
echo " - ERROR! No snapshot tag provided."
exit
fi
if [ -e "${disk_img}" ]; then
if ${QEMU_IMG} snapshot -q -a "${TAG}" "${disk_img}"; then
echo " - Applied snapshot '${TAG}' to ${disk_img}"
else
echo " - ERROR! Failed to apply snapshot '${TAG}' to ${disk_img}"
fi
else
echo " - NOTE! ${disk_img} not found. Doing nothing."
fi
}
function snapshot_create() {
echo "Snapshotting ${disk_img}"
local TAG="${1}"
if [ -z "${TAG}" ]; then
echo "- ERROR! No snapshot tag provided."
exit
fi
if [ -e "${disk_img}" ]; then
if ${QEMU_IMG} snapshot -q -c "${TAG}" "${disk_img}"; then
echo " - Created snapshot '${TAG}' for ${disk_img}"
else
echo " - ERROR! Failed to create snapshot '${TAG}' for ${disk_img}"
fi
else
echo " - NOTE! ${disk_img} not found. Doing nothing."
fi
}
function snapshot_delete() {
echo "Snapshot removal ${disk_img}"
local TAG="${1}"
if [ -z "${TAG}" ]; then
echo " - ERROR! No snapshot tag provided."
exit
fi
if [ -e "${disk_img}" ]; then
if ${QEMU_IMG} snapshot -q -d "${TAG}" "${disk_img}"; then
echo " - Deleted snapshot '${TAG}' from ${disk_img}"
else
echo " - ERROR! Failed to delete snapshot '${TAG}' from ${disk_img}"
fi
else
echo " - NOTE! ${disk_img} not found. Doing nothing."
fi
}
function snapshot_info() {
echo
if [ -e "${disk_img}" ]; then
${QEMU_IMG} info "${disk_img}"
fi
}
function get_port() {
local PORT_START=$1
local PORT_RANGE=$((PORT_START+$2))
local PORT
for ((PORT = PORT_START; PORT <= PORT_RANGE; PORT++)); do
# Make sure port scans do not block too long.
timeout 0.1s bash -c "echo >/dev/tcp/127.0.0.1/${PORT}" >/dev/null 2>&1
gitextract_4b3igp5s/ ├── .editorconfig ├── .envrc ├── .github/ │ ├── FUNDING.yml │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.md │ │ └── feature_request.md │ ├── dependabot.yml │ ├── pull_request_template.md │ └── workflows/ │ ├── flake-checker.yml │ ├── flake-updater.yml │ ├── lint-pr.yml │ ├── lint-shellcheck.yml │ ├── publish-release.yml │ ├── test-build-quickemu.yml │ └── test-quickget.yml ├── .gitignore ├── .gitmodules ├── AGENTS.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── SECURITY.md ├── chunkcheck ├── debian/ │ ├── changelog │ ├── control │ ├── copyright │ ├── install │ ├── rules │ └── source/ │ └── format ├── devshell.nix ├── docs/ │ ├── Makefile │ ├── pandoc-man.mk │ ├── quickemu.1 │ ├── quickemu.1.md │ ├── quickemu_conf.5 │ ├── quickemu_conf.5.md │ ├── quickget.1 │ └── quickget.1.md ├── flake.lock ├── flake.nix ├── package.nix ├── quickemu ├── quickget └── quickreport
Condensed preview — 44 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (491K chars).
[
{
"path": ".editorconfig",
"chars": 337,
"preview": "root = true\n\n[quickemu]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\nindent_style = space\nindent_size = "
},
{
"path": ".envrc",
"chars": 9,
"preview": "use flake"
},
{
"path": ".github/FUNDING.yml",
"chars": 93,
"preview": "# These are supported funding model platforms\n\ngithub: [flexiondotorg, philclifford, lj3954]\n"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"chars": 1148,
"preview": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: 'bug: description of the bug you encountered'\nlabe"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"chars": 786,
"preview": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: 'feat: describe the feature you are requesting'"
},
{
"path": ".github/dependabot.yml",
"chars": 172,
"preview": "version: 2\nupdates:\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n # Check for updates t"
},
{
"path": ".github/pull_request_template.md",
"chars": 921,
"preview": "# Description\n\nPlease include a summary of the changes along with any relevant motivation and context.\n\n<!-- Close any r"
},
{
"path": ".github/workflows/flake-checker.yml",
"chars": 458,
"preview": "name: Flake ❄️ Checker ✅\n\non:\n push:\n branches:\n - master\n schedule:\n - cron: '42 0 * * 6'\n workflow_dispa"
},
{
"path": ".github/workflows/flake-updater.yml",
"chars": 496,
"preview": "name: Flake ❄️ Lock 🔒️ Updater ✨\n\non:\n schedule:\n - cron: '37 13 14,28 * *'\n workflow_dispatch:\n\njobs:\n lock-updat"
},
{
"path": ".github/workflows/lint-pr.yml",
"chars": 740,
"preview": "name: \"Lint Pull Request 🐙\"\n\non:\n pull_request_target:\n types:\n - opened\n - edited\n - synchronize\n\npe"
},
{
"path": ".github/workflows/lint-shellcheck.yml",
"chars": 340,
"preview": "name: \"Lint Shellcheck 🐚\"\n\non:\n pull_request:\n branches: '**'\n workflow_dispatch:\n\njobs:\n shellcheck:\n name: Sh"
},
{
"path": ".github/workflows/publish-release.yml",
"chars": 4246,
"preview": "name: Publish Release 🏷️\n\non:\n push:\n tags:\n - \"v?[0-9]+.[0-9]+.[0-9]+*\"\n workflow_dispatch:\n inputs:\n "
},
{
"path": ".github/workflows/test-build-quickemu.yml",
"chars": 2519,
"preview": "name: Test build quickemu 🚧\n\non:\n pull_request:\n branches:\n - master\n paths:\n - quickemu\n - quickg"
},
{
"path": ".github/workflows/test-quickget.yml",
"chars": 6691,
"preview": "name: \"Test quickget 🧪\"\n\non:\n workflow_dispatch:\n push:\n branches:\n - master\n paths:\n - quickget\n pul"
},
{
"path": ".gitignore",
"chars": 203,
"preview": "*.chunklist\n*.conf\n*.dmg\n*.fd\n*.fixed\n*.img\n*.iso\n*.ISO\n*.lock\n!flake.lock\n*.log\n*.markdownlint.jsonc\n*.markdownlint.yam"
},
{
"path": ".gitmodules",
"chars": 101,
"preview": "[submodule \"build-docs\"]\n\tpath = build-docs\n\turl = https://github.com/philclifford/quickemu-docs.git\n"
},
{
"path": "AGENTS.md",
"chars": 4121,
"preview": "# AGENTS.md\n\nQuickemu is a Bash wrapper around QEMU that automates VM creation for ~1000 operating systems (Linux, macOS"
},
{
"path": "CODE_OF_CONDUCT.md",
"chars": 5240,
"preview": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participa"
},
{
"path": "CONTRIBUTING.md",
"chars": 976,
"preview": "# Contributing\n\nWe welcome contributions to Quickemu.\n\n- Help other Quickemu users by answering questions in the [Quicke"
},
{
"path": "LICENSE",
"chars": 1070,
"preview": "MIT License\n\nCopyright (c) 2020 Wimpy's World\n\nPermission is hereby granted, free of charge, to any person obtaining a c"
},
{
"path": "README.md",
"chars": 6545,
"preview": "<div align=\"center\">\n<img src=\".github/logo.png\" alt=\"Quickemu\" width=\"256\" />\n\n# Quickemu\n\n**Quickly create and run opt"
},
{
"path": "SECURITY.md",
"chars": 577,
"preview": "# Security Policy\n\n## Supported Versions\n\nHere are the versions of Quickemu currently being supported with security upda"
},
{
"path": "chunkcheck",
"chars": 4316,
"preview": "#!/usr/bin/env python3\n\nfrom pathlib import Path\nimport struct\nimport hashlib\nimport argparse\nv1_prod_pubkey = 0xC3E748C"
},
{
"path": "debian/changelog",
"chars": 144,
"preview": "quickemu (4.9.6-1) unstable; urgency=medium\n\n * New upstream release.\n\n -- Martin Wimpress <code@wimpress.io> Fri, 10 "
},
{
"path": "debian/control",
"chars": 1223,
"preview": "Source: quickemu\nSection: utils\nPriority: optional\nMaintainer: Martin Wimpress <code@wimpress.io>\nBuild-Depends:\n debhel"
},
{
"path": "debian/copyright",
"chars": 2314,
"preview": "Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/\nUpstream-Name: quickemu\nUpstream-Contact: Mar"
},
{
"path": "debian/install",
"chars": 73,
"preview": "chunkcheck usr/bin\nquickemu usr/bin\nquickget usr/bin\nquickreport usr/bin\n"
},
{
"path": "debian/rules",
"chars": 76,
"preview": "#!/usr/bin/make -f\n\n%:\n\tdh $@\n\noverride_dh_builddeb:\n\tdh_builddeb -- -Zgzip\n"
},
{
"path": "debian/source/format",
"chars": 13,
"preview": "3.0 (native)\n"
},
{
"path": "devshell.nix",
"chars": 2176,
"preview": "{\n lib,\n mkShell,\n pkgs,\n stdenv,\n OVMF ? null,\n OVMFFull ? null,\n}:\nmkShell {\n packages =\n with pkgs;\n (\n "
},
{
"path": "docs/Makefile",
"chars": 1236,
"preview": "include pandoc-man.mk\n\nifeq ($(PREFIX),)\n PREFIX := /usr/local\nendif\n\ndatarootdir := $(PREFIX)/share\ndatadir := $(dat"
},
{
"path": "docs/pandoc-man.mk",
"chars": 166,
"preview": "PANDOC ?= pandoc\nPANDOC_OPTIONS = -f gfm+definition_lists\n\n.SUFFIXES: .1.md .1 .5.md .5\n\n.1.md.1 .5.md.5:\n\t$(PANDOC) --s"
},
{
"path": "docs/quickemu.1",
"chars": 38414,
"preview": ".\\\" Automatically generated by Pandoc 3.8.3\n.\\\"\n.TH \"QUICKEMU\" \"1\" \"February 2, 2026\" \"quickemu\" \"Quickemu User Manual\"\n"
},
{
"path": "docs/quickemu.1.md",
"chars": 33024,
"preview": "---\nauthor: Martin Wimpress\ndate: February 2, 2026\nfooter: quickemu\nheader: Quickemu User Manual\nsection: 1\ntitle: QUICK"
},
{
"path": "docs/quickemu_conf.5",
"chars": 10924,
"preview": ".\\\" Automatically generated by Pandoc 3.8.3\n.\\\"\n.TH \"QUICKEMU_CONF\" \"5\" \"February 2, 2026\" \"quickemu_conf\" \"Quickemu Con"
},
{
"path": "docs/quickemu_conf.5.md",
"chars": 9639,
"preview": "---\nauthor: Martin Wimpress\ndate: February 2, 2026\nfooter: quickemu_conf\nheader: Quickemu Configuration Manual\nsection: "
},
{
"path": "docs/quickget.1",
"chars": 20942,
"preview": ".\\\" Automatically generated by Pandoc 3.8.3\n.\\\"\n.TH \"QUICKGET\" \"1\" \"February 2, 2026\" \"quickget\" \"Quickget User Manual\"\n"
},
{
"path": "docs/quickget.1.md",
"chars": 17498,
"preview": "---\nauthor: Martin Wimpress\ndate: February 2, 2026\nfooter: quickget\nheader: Quickget User Manual\nsection: 1\ntitle: QUICK"
},
{
"path": "flake.lock",
"chars": 1167,
"preview": "{\n \"nodes\": {\n \"flake-schemas\": {\n \"locked\": {\n \"lastModified\": 1772200446,\n \"narHash\": \"sha256-h"
},
{
"path": "flake.nix",
"chars": 2382,
"preview": "{\n description = \"Quickemu flake\";\n inputs = {\n flake-schemas.url = \"https://flakehub.com/f/DeterminateSystems/flak"
},
{
"path": "package.nix",
"chars": 2846,
"preview": "{\n lib,\n fetchFromGitHub,\n installShellFiles,\n makeWrapper,\n stdenv,\n testers,\n cdrtools,\n curl,\n gawk,\n gnugr"
},
{
"path": "quickemu",
"chars": 115760,
"preview": "#!/usr/bin/env bash\nexport LC_ALL=C\n\nif ((BASH_VERSINFO[0] < 4)); then\n echo \"Sorry, you need bash 4.0 or newer to ru"
},
{
"path": "quickget",
"chars": 156894,
"preview": "#!/usr/bin/env bash\n# SC2317: Command appears to be unreachable. Check usage (or ignore if invoked indirectly).\n# - htt"
},
{
"path": "quickreport",
"chars": 3629,
"preview": "#!/usr/bin/env bash\n\nquick_report() {\n local GPUS\n local OS_KERNEL\n local PRETTY_NAME\n local QUICKEMU\n lo"
}
]
About this extraction
This page contains the full source code of the quickemu-project/quickemu GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 44 files (451.8 KB), approximately 132.0k tokens. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.