- π― One-Click Cleanup: Simple, elegant interface with a single button
- π¨ Liquid Glass UI: Modern glassmorphism design with interactive effects
- π‘οΈ Safe Cleaning: Only removes non-essential files and temporary data
- π Real-time Feedback: Progress indicator and detailed cleanup results
- β‘ Worker Threads: Non-blocking cleanup operations for smooth UI
- π Comprehensive Coverage: Cleans 60+ different locations including:
- Windows temporary files and cache
- Browser data (Chrome, Edge, Firefox)
- Application cache (Teams, Slack, Zoom, Spotify, Discord)
- System logs and crash dumps
- Recycle bin and Windows update cache
- System Temp:
C:\Windows\Temp
,%TEMP%
- Browser Cache: Chrome, Edge, Firefox cache and cookies
- App Data: Teams, Slack, Zoom, Spotify, Discord logs/cache
- Windows Logs: Event logs, crash dumps, CBS logs
- Prefetch: Windows prefetch files
- Update Cache: Windows Update temporary files
- Recycle Bin: Deleted files in recycle bin
- Personal documents and files
- Installed programs and settings
- Critical system files
- Active registry keys
System Requirements:
|
# Clone the repository
git clone https://github.com/git-x-ai/clean.me.git
cd clean.me
# Install dependencies
npm install
# Run the application
npm start
# Build for distribution
npm run build Requirements:
|
- Node.js 16+ and npm
- Windows 10 or later
- Git for version control
# Clone and install
git clone https://github.com/git-x-ai/clean.me.git
cd clean.me
npm install
# Development with hot reload
npm run dev
# Build CSS (watch mode)
npm run build:css:watch
# Build for production
npm run build
Command | Description |
---|---|
npm start |
Start the application |
npm run dev |
Development mode with CSS build |
npm run build |
Build CSS and create distributable |
npm run build:css |
Build Tailwind CSS (minified) |
npm run build:css:watch |
Watch and rebuild CSS on changes |
npm run dist |
Create distribution without publishing |
clean.me/
βββ src/ # Source code
β βββ main.js # Electron main process
β βββ renderer.js # UI renderer process
β βββ cleanup.js # Cleanup worker management
β βββ cleanup-worker.js # Cleanup logic (worker thread)
β βββ index.html # Main UI
β βββ debug.html # Debug console
β βββ input.css # Tailwind CSS input
β βββ styles.css # Generated CSS (auto-generated)
βββ assets/ # Images and icons
β βββ logo.png # App logo
β βββ favicon.ico # Taskbar icon
β βββ github.svg # GitHub icon
β βββ wizard.bmp # Installer sidebar
βββ build/ # Build scripts and manifests
βββ docs/ # Documentation
βββ dist/ # Build output (generated)
Clean.me is designed with security in mind:
- No network access - Works entirely offline
- Safe operations only - Never modifies critical system files
- Open source - Full transparency of operations
- Minimal permissions - Only requests necessary access
See our Security Policy for details.
We welcome contributions! Please see our Contributing Guide for details.
- Fork the repository
- Create a feature branch
- Make your changes
- Test thoroughly
- Submit a pull request
- OS: Windows 10 or later
- Permissions: Administrator privileges (for system file cleanup)
- RAM: 100MB minimum
- Storage: 200MB for installation
This project is dual-licensed for maximum flexibility:
- β Free for personal and educational use - Use, modify, and share freely
- π Modifications must be contributed back - Help improve the project
- πΌ Commercial use requires permission - Contact us for licensing
See the LICENSE file for complete details.
For commercial licensing inquiries, visit our Discord.
- Built with Electron
- Styled with Tailwind CSS
- Icons and design inspiration from modern UI/UX principles
π Bug Reports | π‘ Feature Requests | π¬ Community |
---|---|---|
Open an Issue | Request a Feature | Join Discord |
π Documentation | π Website | β Support Us |
---|---|---|
Read the Docs | CCC Suite | Star on GitHub |