Skip to content

ArsenTech/clamav-gui

ClamAV GUI

ArsenTech's ClamAV GUI

A minimal, open-source GUI for ClamAV Antivirus that makes the Antivirus itself look professional and work exactly like ClamAV (A FOSS CLI Antivirus)

Report bug  ·  Request Feature

version Contributors Forks Stargazers downloads project_license sponsors-badge

Issues build-status commits since latest release GitHub Created At GitHub repo size

Table of Contents
  1. About
  2. Usage Manual
  3. Versioning
  4. Sponsors
  5. Contributing
  6. Star History
  7. License

About

ArsenTech's ClamAV GUI is a minimal, open-source interface for file scanning and threat detection that makes the Antivirus itself look professional and work exactly like ClamAV (A FOSS CLI Antivirus).

Built with Tauri, React, and modern desktop and web tools. This software is provided as-is. No data is collected or transmitted. This GUI uses ClamAV's clamscan and freshclam engines. Scan types are presets that define which locations and which limits are used.

Features

  • State-gated UI - Detects the ClamAV installation path before launching the software
  • Main and Full Scan - Scan the entire device for malicious files and malware
  • Custom and File Scan - Scan the mentioned folder/file for malware
  • Resolving infected files after scan - It includes actions like Quarantine and Delete
  • Definitions Updater - Update the definitions database directly from the GUI
  • Quarantine - Manage infected threats after scanning
  • History - View the entire GUI actions history and manage it + view or reveal logs
  • Antivirus Statistics - View the entire Antivirus Dashboard and Statistics + some real-time device stats
  • Real-Time Performance Stats - CPU, RAM Usage, and Disk Usage Stats all without leaving the GUI
  • Flags - Launch Full Scan and Main Scan Directly if needed
  • Scheduler - Schedule some scans if needed + manage other scheduled scan jobs
  • Real-Time Scan - Monitors file activity and scans files when they change. It doesn't install kernel drivers.
  • Settings - Tweak some options on ClamAV GUI if needed (Such as Scan Options, Appearance, and others)

Other Features

  • Skeleton Loader - A separate Skeleton loading on some pages for a clean UX
  • Notifications - Be informed when the scan is started or finished, or a new threat has been detected
  • System Tray - Quick Access through some actions, all by using a system tray
  • Multilingual Support - Use the ClamAV GUI in your native language besides English

Planned Improvements

v1.0.7 (Next, Stability)

  • Error Handling & Translation Improvements
    • Normalize backend errors
    • Map to frontend translations
    • Better error messages
  • Minimized Auto Start Setting (#12)
  • Silent Scheduled Scans Settings (Another Attempt)
  • Move several states into context to reduce rerenders and improve performance
  • Investigate macOS TextToSpeech false positive
  • Verify detection name and affected ClamAV versions
  • Determine whether exclusion should be default or optional
  • Make About tab appearance tab or stay as a grid
  • Lazy-load some heavy components
  • Validations with Zod before importing

Note

v1.0.7 is complete when

  • error handling is consistent
  • other features work as expected

v1.0.8 (Platform Expansion)

  • ClamAV Path Settings
  • Scheduler support for Linux and MacOS
  • Limit helpers::scheduler::windows::get_last_run_time only for Windows Users

v1.1.x (Planned, Major)

  • ClamAV Engine Updater
  • YARA Related Features
    • YARA Scan Type
    • YARA Real-time Option
    • YARA Configuration in settings
  • Feature to submit suspicious signatures to ClamAV
  • Detect clamdscan
  • Detect clamd
  • Add backend selector
  • Use selected backend

Future Improvements

  • Validate daemon status
  • Optional multiscan
  • Advanced clamd configuration

Nice to have

  • Write the documentation in the docs/ folder.
    • Usage Guide
    • Installation Guide
      • Extend the Installation guide to Mac and Linux Users
    • Troubleshooting
      • Continue writing the Troubleshooting Guide once it has new or missing info
    • FAQs
      • Continue writing the FAQ section once it has new or missing info
    • Translation Guide
  • Translate new parts after running npm run i18n:missing-keys [lang-codes] and typing
    • 🇫🇷 French - fr
    • 🇵🇱 Polish - pl
  • Expanded approach of the Bug fix for the issue #11
    • True scan restoration (no reset of progress)
    • Better scan continuity (UI feedback)
    • Smarter scan awareness (optional scanType in status)

Built With

  • Tauri
  • React
  • ShadCN UI
  • Tailwind CSS
  • Typescript
  • Vite
  • Rust
  • React Router

Download

You can find the latest stable version of the ClamAV GUI right here

GitHub Downloads (all assets, latest release)

Usage Manual

Full documentation is available here: ➡️ Documentation

Versioning

This website follows Semantic Versioning. You can view the full Changelog for details on each website version.

Sponsors

Check out our awesome sponsors! ❤️ Sponsors List

Contributing

Contributions are Always Welcome! Please read both Code of Conduct and CONTRIBUTING.md before contributing.

Top Contributors

Top Contributors

Star History

Star History Chart

License

This project is licensed under the GNU General Public License v3.0 or later.

ClamAV is a trademark of Cisco Systems, Inc. This project is an independent, open-source GUI and is not affiliated with or endorsed by Cisco.

Support And Follow

YouTube Patreon Codepen DeviantArt Odysee Scratch

GitHub @ArsenTech  ·  YouTube @ArsenTech  ·  Patreon ArsenTech  ·  ArsenTech's Website