Current Stable Release: v3.1.0 — An open-source, cross-platform desktop GUI for ClamAV engine. Built with Python and PySide6 (Qt).
Live walkthrough tour of pyEGClamUI desktop interface.
- Cross-Platform: Runs natively on Windows 10/11, Linux, and macOS.
- Engine Auto-Discovery: Automatically discovers
clamscan,clamd, andfreshclamacross system PATH, standard directories, and Homebrew paths viaClamEngineDetector. - ClamAV Daemon Integration: High-performance Unix domain socket (
/var/run/clamav/clamd.ctl,/opt/homebrew/...) and TCP socket (127.0.0.1:3310) communication withINSTREAMchunk framing support viaClamDaemonClient. - Multiple Scan Modes:
- Quick Scan: Lightweight check focusing on common high-priority directories (Downloads, Desktop, Temp).
- Full System Scan: Thorough scan across all accessible local storage drives and system partitions.
- Custom Scan: Target specific files, folders, or external drives of your choice.
- Memory Scan: Scans active processes and loaded executable modules for resident threats.
- Live Progress Tracking: Real-time file counters, active scanning path display, elapsed time, and threat notifications in
ScanDialog. - Isolated Quarantine Vault: Quarantined threats are given unique IDs, hashed with SHA-256, isolated safely with non-executable
.quarantineextensions, and support one-click restoration viaQuarantineManager. - Debounced Real-Time Guard: Monitors Downloads and Desktop using
watchdogwith a debounce worker queue to avoid locking files being downloaded or written viaRealTimeGuard. - Desktop & Menu Integration: XDG desktop entry and hicolor icon integration for Linux application menus via
LinuxDesktopManager, macOS Menu Bar status item, and Windows System Tray daemon viaSystemTrayManager. - FreshClam Updates: Check and update ClamAV virus signatures with one click from the UI without requiring elevated permissions via
ClamUpdater. - Vector High-DPI UI & Native Dark Frame: 100% procedural vector icons via
IconFactory(crisp on any scale/DPI) and native dark titlebar frame integration viaPlatformTheme(Windows DWM immersive dark mode, Linux GTK dark frame, macOS). - Dynamic 3-Tier Protection Matrix: Reactive visual status shield (Protected Emerald, Warning Amber, Unprotected Crimson) dynamically reflecting ClamAV binary detection, Real-Time Guard active state, and signature database freshness in
MainWindow. - Lightweight & Privacy-Focused: Zero telemetry, zero tracking, no network beacons, and 100% free and open-source (GPL-3.0).
Detailed architectural, technical, and operational documentation is available in the docs/ directory:
| Guide | Description |
|---|---|
| Documentation Index | Overview map and full repository structure |
| System Architecture | Decoupled layers, Qt signal/slot concurrency, and threading model |
| Core Engines | In-depth logic for Scanner, Detector, Daemon client, and Quarantine |
| Cross-Platform Matrix | Directory mapping, socket discovery, and platform specifics (Windows, Linux, macOS) |
| Configuration & Schemas | config.json schema, quarantine manifests, and local diagnostic exports |
| CLI Reference | Complete CLI syntax for pyegclamui, egclam, pyegclamui-scan, and pyegclamui-setup |
| Security & Privacy | Zero-telemetry policy, subprocess argument safety, and FOSS compliance |
| Application Versioning | SemVer policy, single source of truth (SSOT), and release bumping workflow |
| Universal Setup Suite | One-liner installers, global updater (--update), and desktop shortcut engine |
pyEGClamUI includes an automated, cross-platform bootstrap setup suite (setup/README.md) that provisions Python, creates an isolated virtual environment (.venv), checks ClamAV, and configures desktop shortcuts automatically.
Download the latest pyEGClamUI-v3.1.0-Windows-Setup.exe installer from GitHub Releases:
- 🛡️ Zero False Positives: Uses official signed Python 3.12 embedded runtime.
- ⚡ Ultra-Fast Scans: Automatically configures and launches ClamD resident daemon service (15 ms latency).
- 🖥️ Full Desktop Integration: Configures Desktop/Start Menu shortcuts and clean Windows uninstaller.
Run in PowerShell (Administrative or standard):
powershell -ExecutionPolicy Bypass -Command "Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/EG1DOTIN/pyEGClamUI/main/setup/windows/install.ps1' -OutFile setup.ps1; .\setup.ps1"Run in your terminal:
curl -sSL https://raw.githubusercontent.com/EG1DOTIN/pyEGClamUI/main/setup/install.sh | bashgit clone https://github.com/EG1DOTIN/pyEGClamUI.git
cd pyEGClamUI
# Run automated master installer (Python 3.9+)
python setup/setup.py --install --startTip
One-Command Updates: To update ClamAV virus signatures, ClamAV binaries, and pyEGClamUI all at once, simply run:
python setup/setup.py --updatepython -m venv .venv
# Windows:
.venv\Scripts\activate
# Linux/macOS:
source .venv/bin/activate
pip install -e .pyegclamui
# or use the short alias:
egclam# Quick scan
pyegclamui-scan --quick
# Full system scan
pyegclamui-scan --full
# Scan specific directory
pyegclamui-scan /path/to/folderpyEGClamUI interfaces with the open-source ClamAV engine on your system:
- Windows (10 / 11):
winget install Cisco.ClamAV(or use the built-in setup wizard:pyegclamui-setup --install) - Linux (Ubuntu / Debian / Mint):
sudo apt install clamav clamav-daemon - Linux (Fedora / RHEL):
sudo dnf install clamav clamd clamav-update - Linux (Arch Linux):
sudo pacman -S clamav - macOS:
brew install clamav
Comprehensive technical guides and architectural specifications are available in the docs/ directory:
- 📖 Documentation Index — Architectural blueprints, subsystem guides, and CLI reference.
- 🚀 Development & Release Workflow — Feature branching model, PR quality gates, and staging architecture.
- 🏷️ Application Versioning — Semantic Versioning, Single Source of Truth, and release runbook.
- 🛡️ Security & Privacy Model — Zero-telemetry policy, subprocess parameter isolation, and threat quarantine.
ClamAV® is a registered trademark of Cisco Systems, Inc.
pyEGClamUI is an independent open-source frontend and is not affiliated with, endorsed by, or sponsored by Cisco Systems, Inc.
- License: GNU General Public License v3.0 or later (GPL-3.0-or-later)
- Developed by: EG1