# quickemu-project/quickemu architecture

> Architecture diagram of the GitHub repository quickemu-project/quickemu, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/quickemu-project/quickemu
- Repository: https://github.com/quickemu-project/quickemu

## Overview

Quickemu is a shell-based QEMU wrapper for creating and running optimized virtual machines. The documented user workflow is to use `quickget` to download an operating-system image and write a VM configuration, then pass that configuration to `quickemu`, which detects host hardware and launches QEMU. The README also documents guest-platform and runtime capabilities. No source excerpts were provided, so relationships below rely on README statements; internal implementation details are not inferred.

Main entry points: [`quickemu`](https://github.com/quickemu-project/quickemu/blob/master/quickemu) (VM launcher), [`quickget`](https://github.com/quickemu-project/quickemu/blob/master/quickget) (OS downloader)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_creation["VM Creation"]
  node_quickget["OS downloader"]
  node_upstream["OS image source"]
  node_image["OS image"]
  node_config["VM configuration"]
end

subgraph group_runtime["VM Runtime"]
  node_quickemu["VM launcher"]
  node_host["Host hardware"]
  node_qemu["QEMU"]
  node_guest["Running VM"]
end

subgraph group_capabilities["Runtime Capabilities"]
  node_guest_support["Guest platforms"]
  node_display["SPICE display"]
  node_file_sharing["File sharing"]
  node_guest_agent["Guest agent"]
  node_networking["Networking"]
  node_device_passthrough["Device passthrough"]
  node_audio["Audio and braille"]
  node_firmware["Boot firmware"]
end

node_user(("VM creator"))

node_user -->|"requests OS"| node_quickget
node_quickget -->|"downloads image"| node_upstream
node_quickget -->|"produces"| node_image
node_quickget -->|"creates config"| node_config
node_user -->|"starts VM"| node_quickemu
node_quickemu -->|"reads config"| node_config
node_quickemu -->|"enumerates hardware"| node_host
node_quickemu -->|"launches VM"| node_qemu
node_qemu -->|"runs guest"| node_guest
node_quickemu -->|"supports guests"| node_guest_support
node_quickemu -->|"supports display"| node_display
node_quickemu -->|"supports sharing"| node_file_sharing
node_quickemu -->|"supports agent"| node_guest_agent
node_quickemu -->|"supports networking"| node_networking
node_quickemu -->|"supports passthrough"| node_device_passthrough
node_quickemu -->|"supports audio"| node_audio
node_quickemu -->|"supports boot modes"| node_firmware

click node_quickget "https://github.com/quickemu-project/quickemu/blob/master/quickget"
click node_quickemu "https://github.com/quickemu-project/quickemu/blob/master/quickemu"
click node_guest_support "https://github.com/quickemu-project/quickemu/blob/master/quickemu"
click node_display "https://github.com/quickemu-project/quickemu/blob/master/quickemu"
click node_file_sharing "https://github.com/quickemu-project/quickemu/blob/master/quickemu"
click node_guest_agent "https://github.com/quickemu-project/quickemu/blob/master/quickemu"
click node_networking "https://github.com/quickemu-project/quickemu/blob/master/quickemu"
click node_device_passthrough "https://github.com/quickemu-project/quickemu/blob/master/quickemu"
click node_audio "https://github.com/quickemu-project/quickemu/blob/master/quickemu"
click node_firmware "https://github.com/quickemu-project/quickemu/blob/master/quickemu"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_quickget,node_upstream,node_image,node_config toneBlue
class node_quickemu,node_host,node_qemu,node_guest toneAmber
class node_guest_support,node_display,node_file_sharing,node_guest_agent,node_networking,node_device_passthrough,node_audio,node_firmware toneMint
class node_user toneIndigo
```

## Components

### VM Creation

- [OS downloader](https://github.com/quickemu-project/quickemu/blob/master/quickget): `quickget`
- **OS image source**
- **OS image**
- **VM configuration**

### VM Runtime

- [VM launcher](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`
- **Host hardware**
- **QEMU**
- **Running VM**

### Runtime Capabilities

- [Guest platforms](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`
- [SPICE display](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`
- [File sharing](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`
- [Guest agent](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`
- [Networking](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`
- [Device passthrough](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`
- [Audio and braille](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`
- [Boot firmware](https://github.com/quickemu-project/quickemu/blob/master/quickemu): `quickemu`

### Other components

- **VM creator**

## Connections

- VM creator → OS downloader: requests OS (evidence: `README.md`)
- OS downloader → OS image source: downloads image (evidence: `README.md`)
- OS downloader → OS image: produces (evidence: `README.md`)
- OS downloader → VM configuration: creates config (evidence: `README.md`)
- VM creator → VM launcher: starts VM (evidence: `README.md`)
- VM launcher → VM configuration: reads config (evidence: `README.md`)
- VM launcher → Host hardware: enumerates hardware (evidence: `README.md`)
- VM launcher → QEMU: launches VM (evidence: `README.md`)
- QEMU → Running VM: runs guest (evidence: `README.md`)
- VM launcher → Guest platforms: supports guests (evidence: `README.md`)
- VM launcher → SPICE display: supports display (evidence: `README.md`)
- VM launcher → File sharing: supports sharing (evidence: `README.md`)
- VM launcher → Guest agent: supports agent (evidence: `README.md`)
- VM launcher → Networking: supports networking (evidence: `README.md`)
- VM launcher → Device passthrough: supports passthrough (evidence: `README.md`)
- VM launcher → Audio and braille: supports audio (evidence: `README.md`)
- VM launcher → Boot firmware: supports boot modes (evidence: `README.md`)
