Skip to content
Back to search

QuickDesk

QuickDesk is the first AI-native remote desktop — an open-source, free application with a built-in MCP (Model Context Protocol) Server that lets any AI agent see and control remote computers.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/barry-ran/QuickDesk with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/barry-ran/QuickDesk'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/barry-ran--quickdesk/badge.svg)](/listings/barry-ran--quickdesk)

HTML

<a href="/listings/barry-ran--quickdesk"><img src="/api/listings/barry-ran--quickdesk/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Download

Go to [Releases](https://github.com/barry-ran/QuickDesk/releases) to download the latest version:

| Platform | Download | |----------|----------| | Windows x64 | [QuickDesk-win-x64-setup.exe](https://github.com/barry-ran/QuickDesk/releases/latest) | | macOS ARM64 | [QuickDesk-mac-arm64.dmg](https://github.com/barry-ran/QuickDesk/releases/latest) |

Usage

1. Install and run QuickDesk on both the **host** (remote) and **client** (local) machines 2. The host will automatically generate a **Device ID** and **Access Code** 3. On the client, enter the host's Device ID and Access Code, then click **Connect** 4. You're now remotely controlling the host machine

Silent install (Windows installer)

The Windows package is built with **Inno Setup** (`scripts/installer/quickdesk.iss`). Standard Inno command-line switches apply:

| Switch | Meaning | |--------|---------| | `/SILENT` | No wizard pages; progress window may appear | | `/VERYSILENT` | Fully unattended (no progress window) | | `/DIR="path"` | Install directory (optional) | | `/TASKS="..."` | Comma-separated tasks from `[Tasks]` |

Available tasks:

| Task | Description | |------|-------------| | `desktopicon` | Create desktop shortcut | | `startmenuicon` | Create Start Menu shortcut | | `vdd` | Install virtual display driver (IDD) and related files, required for virtual display feature |

All three tasks are selected by default (`Flags: checkedonce` — checked on first install, preserves user choice on upgrades). To skip the virtual display driver, explicitly exclude `vdd` via `/TASKS`.

Examples:

REM Default tasks (includes virtual display driver when selected in script defaults)
QuickDesk-win-x64-setup.exe /VERYSILENT

REM Explicit tasks
QuickDesk-win-x64-setup.exe /VERYSILENT /TASKS="desktopicon,startmenuicon,vdd"

REM Install without virtual display driver
QuickDesk-win-x64-setup.exe /VERYSILENT /TASKS="desktopicon,startmenuicon"

REM Custom install path
QuickDesk-win-x64-setup.exe /VERYSILENT /DIR="D:\QuickDesk"

After a silent install, **QuickDesk.exe is not auto-launched** (`skipifsilent` in the installer script), but the **QuickDeskHost** Windows service is still installed and started when configured in `[Run]`.

Administrator rights are required (`PrivilegesRequired=admin` in the script).

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 510 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <p align="center">
  2. <img src="docs/image/logo.png" alt="QuickDesk Logo" width="120">
  3. </p>
  4. <h1 align="center">QuickDesk</h1>
  5. <p align="center">
  6. <strong>The First AI-Native Remote Desktop</strong><br>
  7. Built-in MCP Server · AI Agents Control Any Remote Computer · Open-Source & Free
  8. </p>
  9. <p align="center">
  10. <a href="https://github.com/barry-ran/QuickDesk/actions/workflows/quickdesk-windows.yml">
  11. <img src="https://github.com/barry-ran/QuickDesk/actions/workflows/quickdesk-windows.yml/badge.svg" alt="Windows Build">
  12. </a>
  13. <a href="https://github.com/barry-ran/QuickDesk/actions/workflows/quickdesk-macos.yml">
  14. <img src="https://github.com/barry-ran/QuickDesk/actions/workflows/quickdesk-macos.yml/badge.svg" alt="macOS Build">
  15. </a>
  16. <a href="https://github.com/barry-ran/QuickDesk/releases">
  17. <img src="https://img.shields.io/github/v/release/barry-ran/QuickDesk" alt="Release">
  18. </a>
  19. <a href="https://github.com/barry-ran/QuickDesk/stargazers">
  20. <img src="https://img.shields.io/github/stars/barry-ran/QuickDesk" alt="Stars">
  21. </a>
  22. <a href="LICENSE">
  23. <img src="https://img.shields.io/github/license/barry-ran/QuickDesk" alt="License">
  24. </a>
  25. </p>
  26. <p align="center">
  27. English | <a href="README_zh.md">中文</a>
  28. </p>
  29. <p align="center">
  30. <a href="https://t.me/+utsmSUhNLc1iNTY1">Telegram</a> | <a href="https://github.com/barry-ran/QuickDesk/issues">Issues</a> | <a href="https://github.com/barry-ran/QuickDesk/releases">Download</a>
  31. </p>
  32. ---
  33. QuickDesk is the **first AI-native remote desktop** — an open-source, free application with a **built-in MCP (Model Context Protocol) Server** that lets any AI agent see and control remote computers.
  34. While other remote desktop tools only serve human users, QuickDesk extends **AI Computer Use** from "local machine only" to **"any remote machine in the world"**. Connect Claude, GPT, Cursor, or any MCP-compatible AI to QuickDesk, and it can screenshot, click, type, drag, and automate across remote desktops — just like a human operator, but faster and 24/7.
  35. Built on Google Chromium Remoting technology (the engine behind Chrome Remote Desktop), QuickDesk delivers industrial-grade performance, stability, and security refined over 10+ years by Google.
  36. Main Interface
  37. ![Main Interface](docs/image/screenshot_main.png)
  38. Remote Desktop
  39. ![Remote Desktop](docs/image/screenshot_remote.png)
  40. AI Config
  41. ![AI Config](docs/image/screenshot_mcp.jpg)
  42. ## Why QuickDesk?
  43. ### AI-First: The Only Remote Desktop with MCP Support [ → MCP Integration Guide](docs/mcp-integration.md)
  44. - **Built-in MCP Server**: AI agents connect via standard MCP protocol — no plugins, no hacks, zero configuration
  45. - **Dual Transport**: stdio mode (AI client spawns process) or HTTP/SSE mode (QuickDesk hosts MCP server for multi-client access)
  46. - **Full Computer Use Toolkit**: 20+ MCP tools — screenshot, click, type, drag, scroll, hotkeys, clipboard, and more
  47. - **Real-Time Visibility**: AI operations are displayed in the QuickDesk GUI in real time — the user sees every mouse move and keystroke, and can intervene at any time
  48. - **Multi-Device AI Orchestration**: AI can connect to and control multiple remote machines simultaneously — batch automation, cross-device workflows, fleet management
  49. - **Guided Prompts**: 9 built-in MCP prompt templates covering remote operation, server health check, batch automation, system diagnosis, screen analysis, multi-device orchestration, and SOP documentation
  50. ### High-Performance Foundation
  51. - **Open-Source & Free**: MIT License, no feature restrictions, no connection limits, commercial use welcome
  52. - **Self-Hosted**: Deploy your own signaling and TURN relay servers, keep full control of your data
  53. - **Commercial-Grade Foundation**: Built on Chromium Remoting — the same technology powering Chrome Remote Desktop, refined by Google for 10+ years and proven by billions of users
  54. - **Pure C++ Ultimate Performance**: Full C++ stack from protocol core to GUI — no GC pauses, no runtime overhead, minimal memory and CPU footprint
  55. - **Modern Codecs**: H.264, VP8, VP9, AV1 — flexibly switch based on network and hardware conditions
  56. - **WebRTC P2P Direct Connection**: Prioritizes peer-to-peer connections for lowest latency; automatically falls back to TURN relay when traversal fails
  57. - **Cross-Platform**: Windows and macOS supported (Linux planned)
  58. - **Modern UI**: Fluent Design interface built with Qt 6 + QML, with light and dark themes
  59. ## Comparison
  60. | Feature | QuickDesk | RustDesk | BildDesk | ToDesk | TeamViewer |
  61. |---------|:---------:|:--------:|:--------:|:------:|:----------:|
  62. | **AI Agent Support (MCP)** | ✅ Built-in | ❌ | ❌ | ❌ | ❌ |
  63. | **Open Source** | ✅ MIT | ✅ AGPL-3.0 | ❌ | ❌ | ❌ |
  64. | **Free for Commercial Use** | ✅ | ❌ License required | ❌ | ❌ | ❌ |
  65. | **Core Language** | C++ | Rust + Dart | — | — | — |
  66. | **Remote Protocol** | Chromium Remoting (WebRTC) | Custom | Custom | Custom | Custom |
  67. | **Protocol Maturity** | ⭐⭐⭐⭐⭐ Google 10yr+ | ⭐⭐⭐ | ⭐⭐ | ⭐⭐⭐ | ⭐⭐⭐⭐⭐ |
  68. | **P2P Direct** | ✅ WebRTC ICE | ✅ TCP Hole Punching | ✅ | ✅ | ✅ |
  69. | **Video Codecs** | H.264/VP8/VP9/AV1 | VP8/VP9/AV1/H.264/H.265 | — | — | — |
  70. | **Self-Hosted** | ✅ Full solution | ✅ | ❌ | ❌ | ❌ |
  71. | **GUI Framework** | Qt 6 (C++) | Flutter (Dart) | — | — | — |
  72. | **Memory Usage** | ⭐⭐⭐⭐⭐ Very Low | ⭐⭐⭐ Medium | — | ⭐⭐⭐ | ⭐⭐⭐ |
  73. | **CPU Usage** | ⭐⭐⭐⭐⭐ Very Low | ⭐⭐⭐ Medium | — | ⭐⭐⭐ | ⭐⭐⭐ |
  74. | **Windows** | ✅ | ✅ | ✅ | ✅ | ✅ |
  75. | **macOS** | ✅ | ✅ | ✅ | ✅ | ✅ |
  76. | **Linux** | 🔜 | ✅ | ❌ | ✅ | ✅ |
  77. | **iOS/Android** | 🔜 | ✅ | ✅ | ✅ | ✅ |
  78. ### Why Best-in-Class Performance?
  79. 1. **Pure C++ Full Stack**: The entire stack — from low-level protocol to GUI — is implemented in C++. No garbage collection pauses, no VM/runtime overhead. Compared to RustDesk's Dart/Flutter GUI layer or ToDesk's Electron-based approach, CPU and memory usage are significantly lower.
  80. 2. **Chromium-Level Optimization**: Core paths for video encoding/decoding, network transmission, and screen capture directly reuse Chromium's highly optimized C++ code, including SIMD instruction optimization and zero-copy rendering pipelines.
  81. 3. **Shared Memory Video Transfer**: QuickDesk uses shared memory to pass video frames (YUV I420) between processes, eliminating the serialization/deserialization and data copying overhead of traditional IPC.
  82. 4. **GPU-Accelerated Rendering**: YUV data is fed directly into the GPU rendering pipeline via Qt 6's `QVideoSink`, achieving zero-CPU-copy video rendering.
  83. ## Features
  84. ### AI Integration (MCP Server)
  85. - Built-in MCP Server — AI agents connect via standard protocol, works with Cursor, Claude Desktop, VS Code, and any MCP client
  86. - Dual transport: stdio (AI client launches process) or HTTP/SSE (QuickDesk manages MCP server, multiple AI clients connect)
  87. - Persistent MCP transport mode — remembers your stdio/HTTP choice across restarts
  88. - 40+ MCP tools: screenshot, mouse click/drag/scroll, keyboard type/hotkey, clipboard, OCR text recognition, UI element detection, screen verification, and more
  89. - Host-side skill host with built-in skills (system info, file operations, shell execution) — run structured tools on the remote machine
  90. - Pluggable skills architecture — add custom skill directories, skills auto-load and sync to connected clients
  91. - Skill host toggle in Settings — enable/disable the skill host process with persistent configuration
  92. - MCP Resources: real-time device status, connection info, host details
  93. - 9 MCP Prompts: operation guide, server health check, batch automation, system diagnosis, screen analysis, multi-device orchestration, SOP documentation
  94. - Real-time event streaming: connection state changes, clipboard updates, screen changes, performance stats
  95. - Event-driven tools: wait_for_event, wait_for_connection_state, wait_for_clipboard_change, wait_for_screen_change for reactive automation
  96. - Background automation mode: `show_window=false` for headless batch operations
  97. - Screenshot scaling: adjustable resolution for faster AI processing
  98. ### Remote Control
  99. - High-definition, low-latency remote desktop display
  100. - Full keyboard and mouse mapping
  101. - Real-time remote cursor synchronization
  102. - Bidirectional clipboard sync
  103. - Adaptive frame rate and bitrate
  104. - Frame rate boost mode (Office / Gaming)
  105. - Privacy screen mode — blacks out the host's physical display and blocks local keyboard/mouse input during remote control, protecting session privacy (Windows 10 2004+)
  106. - Virtual display — creates virtual monitors via IDD driver for multi-screen extension, headless server remote access, privacy isolation, and resolution adaptation (Windows 10 2004+, requires virtual display driver installation)
  107. ### Connection Management
  108. - 9-digit Device ID + temporary access code mechanism
  109. - Auto-refresh access code (configurable: 30 min to 24 hours, or never)
  110. - Multi-tab simultaneous connections to multiple remote devices
  111. - Connection history with quick reconnect
  112. - Real-time connection status monitoring
  113. ### Performance Monitoring
  114. - Detailed latency breakdown panel (Capture → Encode → Network → Decode → Render)
  115. - Real-time frame rate, bitrate, and bandwidth statistics
  116. - Input round-trip time (RTT) monitoring
  117. - Encoding resolution and quality information
  118. ### Personalization
  119. - Fluent Design style interface
  120. - Light and dark theme switching
  121. - i18n support (Chinese / English)
  122. - Video codec preference (H.264 / VP8 / VP9 / AV1)
  123. ### Self-Hosted Deployment
  124. - Custom signaling server address
  125. - Custom STUN/TURN servers
  126. - Complete server deployment solution (Go signaling server + PostgreSQL + Redis + coturn)
  127. - **Web Admin Panel** — full-featured management dashboard for the signaling server:
  128. - Real-time monitoring with ECharts trend charts (connections, new devices over 24h/7d/30d)
  129. - Device management with search, filter, sort, pagination, batch operations, and device groups
  130. - User management with batch enable/disable/delete/set-level
  131. - Admin TOTP two-factor authentication (QR code setup, Google Authenticator compatible)
  132. - Operation audit logs with filtering by action/admin/time range
  133. - IP whitelist (CIDR support) for admin panel access control
  134. - Webhook notifications (device online/offline, new device/user, connection failures)
  135. - CSV data export for devices, users, and activity logs
  136. ## Architecture
  137. QuickDesk uses a modular multi-process architecture:
  138. ```mermaid
  139. graph TD
  140. subgraph AI["AI Agent (Claude / GPT / Cursor)"]
  141. A1["MCP Protocol"]
  142. end
  143. subgraph MCP["quickdesk-mcp (Rust Bridge)"]
  144. M1["MCP stdio ↔ WebSocket"]
  145. M2["MCP HTTP/SSE ↔ WebSocket"]
  146. end
  147. subgraph GUI["QuickDesk GUI (Qt 6)"]
  148. direction LR
  149. WS["WebSocket API Server"]
  150. QML["QML/C++"]
  151. MainWin["Main Window"]
  152. RemoteWin["Remote Desktop Window"]
  153. end
  154. subgraph Host["quickdesk-host (Chromium Remoting)"]
  155. H1["Screen Capture"]
  156. H2["Video Encoding"]
  157. H3["Input Event Handling"]
  158. H4["WebRTC Connection"]
  159. end
  160. subgraph Client["quickdesk-client (Chromium Remoting)"]
  161. C1["Video Decoding"]
  162. C2["Input Event Injection"]
  163. C3["Shared Memory Video Frames"]
  164. C4["WebRTC Connection"]
  165. end
  166. subgraph Signaling["Signaling Server (Go + Gin)"]
  167. S1["WebSocket Signaling"]
  168. S2["ICE Config Distribution"]
  169. S3["Device Registration & Auth"]
  170. S4["PostgreSQL + Redis"]
  171. end
  172. subgraph TURN["TURN Server (coturn)"]
  173. T1["Relay when P2P traversal fails"]
  174. end
  175. AI -- "stdio (JSON-RPC)" --> MCP
  176. AI -. "HTTP/SSE" .-> M2
  177. MCP -- "WebSocket" --> WS
  178. GUI -- "Native Messaging\n(stdin/stdout JSON)" --> Host
  179. GUI -- "Native Messaging\n(stdin/stdout JSON)" --> Client
  180. Host -- "WebSocket" --> Signaling
  181. Client -- "WebSocket" --> Signaling
  182. Signaling -- "ICE Config" --> TURN
  183. Host -. "WebRTC P2P / TURN Relay" .-> Client
  184. ```
  185. ### Tech Stack
  186. | Layer | Technology |
  187. |-------|------------|
  188. | AI Integration | MCP Server (Rust) + WebSocket API |
  189. | GUI Client | Qt 6 (QML + C++17) |
  190. | UI Style | Fluent Design Component Library (custom-built) |
  191. | Remote Protocol Core | Chromium Remoting (C++) |
  192. | Video Codecs | H.264 / VP8 / VP9 / AV1 |
  193. | Network Transport | WebRTC (ICE/STUN/TURN) |
  194. | IPC | Native Messaging (JSON) + Shared Memory |
  195. | Signaling Server | Go + Gin + GORM |
  196. | Data Storage | PostgreSQL + Redis |
  197. | TURN Relay | coturn |
  198. | Logging | spdlog |
  199. | Build System | CMake 3.19+ |
  200. | CI/CD | GitHub Actions |
  201. ## Getting Started
  202. ### Download
  203. Go to [Releases](https://github.com/barry-ran/QuickDesk/releases) to download the latest version:
  204. | Platform | Download |
  205. |----------|----------|
  206. | Windows x64 | [QuickDesk-win-x64-setup.exe](https://github.com/barry-ran/QuickDesk/releases/latest) |
  207. | macOS ARM64 | [QuickDesk-mac-arm64.dmg](https://github.com/barry-ran/QuickDesk/releases/latest) |
  208. ### Usage
  209. 1. Install and run QuickDesk on both the **host** (remote) and **client** (local) machines
  210. 2. The host will automatically generate a **Device ID** and **Access Code**
  211. 3. On the client, enter the host's Device ID and Access Code, then click **Connect**
  212. 4. You're now remotely controlling the host machine
  213. ### Silent install (Windows installer)
  214. The Windows package is built with **Inno Setup** (`scripts/installer/quickdesk.iss`). Standard Inno command-line switches apply:
  215. | Switch | Meaning |
  216. |--------|---------|
  217. | `/SILENT` | No wizard pages; progress window may appear |
  218. | `/VERYSILENT` | Fully unattended (no progress window) |
  219. | `/DIR="path"` | Install directory (optional) |
  220. | `/TASKS="..."` | Comma-separated tasks from `[Tasks]` |
  221. Available tasks:
  222. | Task | Description |
  223. |------|-------------|
  224. | `desktopicon` | Create desktop shortcut |
  225. | `startmenuicon` | Create Start Menu shortcut |
  226. | `vdd` | Install virtual display driver (IDD) and related files, required for virtual display feature |
  227. All three tasks are selected by default (`Flags: checkedonce` — checked on first install, preserves user choice on upgrades). To skip the virtual display driver, explicitly exclude `vdd` via `/TASKS`.
  228. Examples:
  229. ```bat
  230. REM Default tasks (includes virtual display driver when selected in script defaults)
  231. QuickDesk-win-x64-setup.exe /VERYSILENT
  232. REM Explicit tasks
  233. QuickDesk-win-x64-setup.exe /VERYSILENT /TASKS="desktopicon,startmenuicon,vdd"
  234. REM Install without virtual display driver
  235. QuickDesk-win-x64-setup.exe /VERYSILENT /TASKS="desktopicon,startmenuicon"
  236. REM Custom install path
  237. QuickDesk-win-x64-setup.exe /VERYSILENT /DIR="D:\QuickDesk"
  238. ```
  239. After a silent install, **QuickDesk.exe is not auto-launched** (`skipifsilent` in the installer script), but the **QuickDeskHost** Windows service is still installed and started when configured in `[Run]`.
  240. Administrator rights are required (`PrivilegesRequired=admin` in the script).
  241. ## Build from Source
  242. ### Requirements
  243. - CMake 3.19+
  244. - Qt 6.5+ (Multimedia and WebSockets modules required)
  245. - C++17 compiler
  246. ### Windows
  247. ```bash
  248. # Requires Visual Studio 2022 + MSVC
  249. # Set Qt path environment variable
  250. set ENV_QT_PATH=C:\Qt\6.8.3
  251. # Build
  252. scripts\build_qd_win.bat Release
  253. # Package (requires Inno Setup)
  254. scripts\publish_qd_win.bat Release
  255. scripts\package_qd_win.bat Release
  256. ```
  257. ### macOS
  258. ```bash
  259. # Requires Xcode Command Line Tools
  260. # Set Qt path environment variable
  261. export ENV_QT_PATH=/path/to/Qt/6.8.3
  262. # Build
  263. bash scripts/build_qd_mac.sh Release
  264. # Package
  265. bash scripts/publish_qd_mac.sh Release
  266. bash scripts/package_qd_mac.sh Release
  267. ```
  268. ### API Key (Optional)
  269. If you deploy your own signaling server with API Key enabled, there are two ways to configure the API Key:
  270. **Method 1: Runtime Configuration (Recommended)**
  271. In QuickDesk **Settings → Network → API Key**, enter your signaling server's API Key. This is the recommended approach — no recompilation needed, and each deployment can use its own key.
  272. **Method 2: Build-time Injection**
  273. You can also inject the API Key at build time as a compile-time default:
  274. ```bash
  275. # Windows
  276. set ENV_QUICKDESK_API_KEY=your-secret-key
  277. scripts\build_qd_win.bat Release
  278. # macOS
  279. ENV_QUICKDESK_API_KEY=your-secret-key bash scripts/build_qd_mac.sh Release
  280. ```
  281. > **Priority**: Runtime API Key (from Settings) takes precedence over the build-time key. If both are set, the runtime value is used.
  282. Without either configuration, the client can only connect to signaling servers without API Key protection.
  283. > **WebClient note:** The WebClient is a static web page running in the browser. Since API keys embedded in JavaScript are visible via DevTools, the WebClient uses **Origin whitelist** validation instead of API Key. Configure `ALLOWED_ORIGINS` on the signaling server to restrict which domains can access it. Browsers automatically send the `Origin` header and JavaScript cannot forge it, so only the WebClient served from your official domain will be allowed.
  284. See [Signaling Server Deployment](docs/signaling-server-deployment.md) for details.
  285. ## Self-Hosted Deployment
  286. QuickDesk supports full self-hosted deployment. You can deploy all services on your own servers to ensure data security.
  287. ### Components
  288. 1. **Signaling Server** (required): Handles device registration and signaling relay
  289. → [Signaling Server Deployment Guide](docs/signaling-server-deployment.md)
  290. 2. **TURN Relay Server** (recommended): Provides relay when P2P direct connection fails
  291. → [TURN Server Deployment Guide](docs/turn-server-deployment.md)
  292. ### Docker Deploy (Signaling Server)
  293. Three deployment methods for the signaling server:
  294. ```bash
  295. cd SignalingServer
  296. cp .env.example .env && vim .env
  297. # Option 1: Pull pre-built image (recommended)
  298. ./deploy-pull.sh
  299. # Option 2: Build from source
  300. ./deploy-build.sh
  301. # Option 3: Offline deploy (no internet needed)
  302. ./deploy-offline.sh quickdesk-signaling-image.tar.gz
  303. ```
  304. Pre-built Docker images are automatically published to `ghcr.io/barry-ran/quickdesk-signaling` on each tagged release. See the [deployment guide](docs/signaling-server-deployment.md) for details.
  305. ### Client Configuration
  306. In QuickDesk **Settings → Network**:
  307. - Signaling server address: `ws://your-server.com:8000` or `wss://your-server.com:8000`
  308. - API Key: Enter the API Key configured on your signaling server (if enabled)
  309. - Custom STUN server: `stun:your-server.com:3478`
  310. - Custom TURN server: `turn:your-server.com:3478` (username and password required)
  311. ## Project Structure
  312. ```
  313. QuickDesk/
  314. ├── QuickDesk/ # Qt GUI client
  315. │ ├── main.cpp # Application entry point
  316. │ ├── src/
  317. │ │ ├── api/ # WebSocket API server + request handlers
  318. │ │ ├── controller/ # Main controller
  319. │ │ ├── manager/ # Business managers (Host/Client/Process/TURN/...)
  320. │ │ ├── component/ # Video rendering, key mapping, cursor sync
  321. │ │ ├── core/ # Config center, user data
  322. │ │ ├── viewmodel/ # MVVM ViewModel
  323. │ │ └── language/ # i18n
  324. │ ├── qml/
  325. │ │ ├── views/ # Main window, remote desktop window
  326. │ │ ├── pages/ # Remote control, settings, about pages
  327. │ │ ├── component/ # Fluent Design component library
  328. │ │ └── quickdeskcomponent/ # QuickDesk-specific components
  329. │ ├── base/ # Base utilities
  330. │ └── infra/ # Infrastructure (database, logging, HTTP)
  331. ├── quickdesk-mcp/ # Rust MCP Bridge (stdio ↔ WebSocket)
  332. │ └── src/
  333. │ ├── main.rs # Entry point, CLI args, MCP server startup
  334. │ ├── server.rs # MCP tools, prompts, resources
  335. │ └── ws_client.rs # WebSocket client for Qt API
  336. ├── quickdesk-skill-host/ # Rust host-side skill host (Cargo workspace)
  337. │ ├── agent/ # Skill host main binary
  338. │ ├── mcp-server-common/ # Shared MCP server framework
  339. │ └── skills/ # Built-in skill MCP servers
  340. │ ├── sys-info/ # System information skill
  341. │ ├── file-ops/ # File operations skill
  342. │ └── shell-runner/ # Shell execution skill
  343. ├── SignalingServer/ # Go signaling server
  344. │ ├── cmd/signaling/ # Entry point
  345. │ └── internal/ # Business logic
  346. ├── scripts/ # Build, package, publish scripts
  347. ├── docs/ # Documentation
  348. │ ├── mcp-integration.md # MCP integration guide (English)
  349. │ └── MCP接入指南.md # MCP integration guide (Chinese)
  350. ├── .github/workflows/ # CI/CD configuration
  351. └── version # Version number
  352. ```
  353. ## Roadmap
  354. - [x] Windows support
  355. - [x] macOS support
  356. - [x] P2P direct connection + TURN relay
  357. - [x] Multi-tab multi-connection
  358. - [x] Auto-refresh access code
  359. - [x] Video performance stats overlay
  360. - [x] Fluent Design UI
  361. - [x] Light and dark themes
  362. - [x] i18n (Chinese / English)
  363. - [x] **MCP Server — AI agents can control remote desktops**
  364. - [x] **20+ MCP tools (screenshot, click, type, drag, hotkey, clipboard, etc.)**
  365. - [x] **MCP Resources & Prompts**
  366. - [x] **Host-side skill host with built-in skills (sys-info, file-ops, shell-runner)**
  367. - [x] **OCR-based UI analysis tools (get_ui_state, find_element, screen_diff_summary, etc.)**
  368. - [x] **Persistent MCP transport mode and skill host settings**
  369. - [x] **Multi-directory skills loading with user-configurable paths**
  370. - [x] **Device memory & history retrieval (auto-profiling, operation logs, failure patterns)**
  371. - [x] **Workflow recording & playback (record, replay, parameterize)**
  372. - [x] **Trust layer & safety (risk assessment, confirmation dialogs, emergency stop, audit log)**
  373. - [x] **Privacy screen — blacks out host physical display and blocks local input during remote sessions**
  374. - [x] **Virtual display — IDD virtual display driver for multi-screen extension, headless remote, and resolution adaptation**
  375. - [x] File transfer
  376. - [x] Audio streaming
  377. - [x] Unattended access
  378. - [ ] Linux support
  379. - [ ] iOS / Android clients
  380. - [ ] Address book & device groups
  381. ## Contributing
  382. Contributions are welcome! Please follow these guidelines:
  383. 1. Fork the repository and create a feature branch
  384. 2. Keep code style consistent with the project
  385. 3. Ensure the build passes before submitting a PR
  386. 4. Each PR should contain a single feature or fix
  387. ## License
  388. QuickDesk's own code is licensed under the [MIT License](LICENSE), free for commercial use.
  389. The bundled `quickdesk-remoting` component is based on Chromium and licensed under the [BSD 3-Clause License](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/LICENSE).
  390. For complete third-party license information, see [THIRD_PARTY_LICENSES](THIRD_PARTY_LICENSES).
  391. ## Acknowledgments
  392. - [Chromium Remoting](https://chromium.googlesource.com/chromium/src/+/refs/tags/140.0.7339.249/remoting/) — Remote desktop protocol core
  393. - [Qt](https://www.qt.io/) — Cross-platform GUI framework
  394. - [spdlog](https://github.com/gabime/spdlog) — High-performance logging library
  395. - [coturn](https://github.com/coturn/coturn) — TURN relay server
  396. ## Star History
  397. [![Star History Chart](https://api.star-history.com/svg?repos=barry-ran/QuickDesk&type=Date)](https://star-history.com/#barry-ran/QuickDesk&Date)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.