Skip to content

AFZidan/syspilot

Repository files navigation

SysPilot

![S## Platform Support

Platform Status Features
Linux ✅ Complete Full cleanup, monitoring, GUI, releases available
Windows 🚧 In Development Architecture ready, implementation in progress
macOS 📋 Planned Architecture ready, implementation planned

License: MIT Python 3.8+ Platform CI/CD Quality Gate Status Code Coverage GitHub release GitHub issues GitHub stars Downloads

A powerful, cross-platform system cleanup and performance monitoring tool

📥 Download📖 Documentation🐛 Report Issues💬 Discussions


Overview

SysPilot is a modern system utility that helps keep your computer clean and running efficiently. It provides real-time system monitoring, automated cleanup, and intuitive visualization through both GUI and CLI interfaces.

Key Features

  • System Cleanup - Remove temporary files, cache, and free up disk space
  • Real-time Monitoring - Track CPU, memory, disk usage with interactive charts
  • Temperature Monitoring - Monitor CPU temperature with visual indicators
  • Background Operation - System tray integration and scheduled tasks
  • Cross-Platform Ready - Linux (complete), Windows & macOS (in development)

Platform Support

Platform Status Features
Linux ✅ Complete Full cleanup, monitoring, GUI, releases available
Windows 🚧 In Development Architecture ready, implementation in progress
macOS 📋 Planned Architecture ready, implementation planned

Quick Start

Installation

Recommended method (using pipx):

git clone https://github.com/AFZidan/syspilot.git
cd syspilot
chmod +x install_pipx.sh
./install_pipx.sh

Alternative method:

git clone https://github.com/AFZidan/syspilot.git
cd syspilot
chmod +x install.sh
./install.sh

Usage

# Launch GUI
syspilot

# CLI mode
syspilot --cli

# Background service
syspilot --daemon

Requirements

  • Python 3.8 or higher
  • Linux (Ubuntu 18.04+, Debian 10+)
  • Required system packages (auto-installed)

Development

Setup Environment

git clone https://github.com/AFZidan/syspilot.git
cd syspilot
python3 -m venv venv
source venv/bin/activate
pip install -r requirements-dev.txt

Running Tests

python -m pytest
python -m pytest --cov=syspilot --cov-report=html

Code Quality

black syspilot/
flake8 syspilot/

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new functionality
  4. Ensure tests pass
  5. Submit a pull request

Roadmap

  • v1.x - ✅ Linux support (Complete)
  • v2.x - 🚧 Windows support (In Progress)
  • v3.x - 📋 macOS support (Planned)

Project Structure

syspilot/
├── core/                    # Core Qt application
├── platforms/              # Platform-specific implementations
│   ├── linux/              # ✅ Linux support (complete)
│   ├── windows/            # 🚧 Windows support (in progress)
│   └── macos/              # 📋 macOS support (planned)
├── services/               # Shared services
├── utils/                  # Configuration & utilities
└── widgets/                # GUI components & charts

License

MIT License - see LICENSE for details.

Support & Links

About

SysPilot - Cross-Platform System Automation & Cleanup Tool

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors