Getting Started
A straightforward guide to launching the interface, updating definitions, running scans, and managing quarantined files.
Launch the Interface & Verify Engine Detection
When you launch the app (by clicking its desktop shortcut or running pyegclamui /
egclam from your terminal), it automatically checks for installed clamscan,
clamd, and freshclam binaries. If ClamAV is not yet detected, the built-in
wizard will guide you through linking or installing the engine.
Update Virus Definitions
Keep your virus definitions current for up-to-date detection. On the Status Tab, check the Virus Definitions card. If an update is needed, click "Check for Updates" to download the latest signatures directly using FreshClam.
Run a Scan
Navigate to the Scan Tab and choose the appropriate scan profile:
- • Quick Scan: Fast inspection of high-priority system areas most prone to infection.
- • Full System Scan: Comprehensive scan across all connected drive partitions.
- • Custom Drag & Drop: Drag any file or folder directly into the window to inspect it.
- • Memory Scan (Windows): Inspects active running processes in system memory.
Configure Real-Time Folder Guard
Open the Settings Tab to enable Real-Time Protection. By default, it monitors up to two selected folders (defaults to Downloads and Desktop) to scan new files as they arrive. You can customize either folder path to point to any directory on your system.
Managing Quarantined Files
When a suspicious file is detected, it is securely moved into an isolated quarantine vault to prevent accidental execution.
- • To Restore: Select the file in the Quarantine Tab and click "Restore Selected" to safely return it to its original location.
- • To Delete to Trash: Send the file to your system Recycle Bin / Trash.
- • To Purge Permanently: Permanently delete the file from your disk.
Privacy-Preserving Issue Reporting
If you encounter an issue, the application protects your privacy when asking for help:
- • Automatic Path Redaction: When copying an error report to file a GitHub issue, personal paths and usernames are automatically masked so your private files and identity are never exposed.
- • Inspect Before Sending: You can always review diagnostic information before copying or sharing.
Need Deep Technical Architecture?
Explore engine architecture diagrams, Real-Time Guard kernel event watchdog models, daemon socket streaming, and CLI references in our technical documentation.