mirror of
https://github.com/tw93/Mole.git
synced 2026-02-04 17:24:45 +00:00
chore: docs update
This commit is contained in:
Bhadra
312
README.md
312
README.md
@@ -1,6 +1,32 @@
|
|||||||
# Mole for Windows
|
<div align="center">
|
||||||
|
<h1>Mole</h1>
|
||||||
|
<p><em>Deep clean and optimize your Windows.</em></p>
|
||||||
|
</div>
|
||||||
|
|
||||||
Windows support for [Mole](https://github.com/tw93/Mole) - A system maintenance toolkit.
|
<p align="center">
|
||||||
|
<a href="https://github.com/tw93/mole/stargazers"><img src="https://img.shields.io/github/stars/tw93/mole?style=flat-square" alt="Stars"></a>
|
||||||
|
<a href="https://github.com/tw93/mole/releases"><img src="https://img.shields.io/github/v/tag/tw93/mole?label=version&style=flat-square" alt="Version"></a>
|
||||||
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="License"></a>
|
||||||
|
<a href="https://github.com/tw93/mole/commits"><img src="https://img.shields.io/github/commit-activity/m/tw93/mole?style=flat-square" alt="Commits"></a>
|
||||||
|
<a href="https://twitter.com/HiTw93"><img src="https://img.shields.io/badge/follow-Tw93-red?style=flat-square&logo=Twitter" alt="Twitter"></a>
|
||||||
|
<a href="https://t.me/+GclQS9ZnxyI2ODQ1"><img src="https://img.shields.io/badge/chat-Telegram-blueviolet?style=flat-square&logo=Telegram" alt="Telegram"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="https://cdn.tw93.fun/img/mole.jpeg" alt="Mole - 95.50GB freed" width="1000" />
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **All-in-one toolkit**: CCleaner, IObit Uninstaller, WinDirStat, and Task Manager combined into a single PowerShell toolkit
|
||||||
|
- **Deep cleaning**: Scans and removes temp files, caches, and browser leftovers to reclaim gigabytes of space
|
||||||
|
- **Smart uninstaller**: Thoroughly removes apps along with AppData, preferences, and hidden remnants
|
||||||
|
- **Disk insights**: Visualizes usage, manages large files, and refreshes system services
|
||||||
|
- **Live monitoring**: Real-time stats for CPU, memory, disk, and network to diagnose performance issues
|
||||||
|
|
||||||
|
## Platform Support
|
||||||
|
|
||||||
|
Mole is designed for Windows 10/11. This is the native Windows version ported from the [macOS original](https://github.com/tw93/Mole/tree/main). For macOS users, please visit the [main branch](https://github.com/tw93/Mole) for the native macOS version.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
@@ -8,19 +34,206 @@ Windows support for [Mole](https://github.com/tw93/Mole) - A system maintenance
|
|||||||
- PowerShell 5.1 or later (pre-installed on Windows 10/11)
|
- PowerShell 5.1 or later (pre-installed on Windows 10/11)
|
||||||
- Go 1.24+ (for building TUI tools)
|
- Go 1.24+ (for building TUI tools)
|
||||||
|
|
||||||
## Installation
|
## Quick Start
|
||||||
|
|
||||||
### Quick Install
|
Install via PowerShell:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
# Clone the repository
|
# Download and run installer (recommended)
|
||||||
git clone https://github.com/tw93/Mole.git
|
iwr -Uri "https://raw.githubusercontent.com/tw93/mole/windows/install.ps1" -OutFile "$env:TEMP\mole-install.ps1"; & "$env:TEMP\mole-install.ps1" -AddToPath
|
||||||
cd Mole/windows
|
|
||||||
|
# Or install with specific options
|
||||||
|
# -Branch windows for latest code, -Tag v1.17.0 for specific version
|
||||||
|
iwr -Uri "https://raw.githubusercontent.com/tw93/mole/windows/install.ps1" -OutFile "$env:TEMP\mole-install.ps1"; & "$env:TEMP\mole-install.ps1" -AddToPath -CreateShortcut
|
||||||
|
```
|
||||||
|
|
||||||
|
Or install manually:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
# Clone the repository and checkout windows branch
|
||||||
|
git clone -b windows https://github.com/tw93/Mole.git
|
||||||
|
cd Mole
|
||||||
|
|
||||||
# Run the installer
|
# Run the installer
|
||||||
.\install.ps1 -AddToPath
|
.\install.ps1 -AddToPath
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Run:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
mole # Interactive menu
|
||||||
|
mole clean # Deep cleanup
|
||||||
|
mole uninstall # Remove apps + leftovers
|
||||||
|
mole optimize # Refresh caches & services
|
||||||
|
mole analyze # Visual disk explorer
|
||||||
|
mole status # Live system health dashboard
|
||||||
|
mole purge # Clean project build artifacts
|
||||||
|
|
||||||
|
mole -ShowHelp # Show help
|
||||||
|
mole -Version # Show installed version
|
||||||
|
|
||||||
|
mole clean -DryRun # Preview the cleanup plan
|
||||||
|
mole clean -Whitelist # Manage protected caches
|
||||||
|
mole clean -DryRun -Debug # Detailed preview with risk levels
|
||||||
|
|
||||||
|
mole optimize -DryRun # Preview optimization actions
|
||||||
|
mole optimize -Debug # Run with detailed operation logs
|
||||||
|
mole purge -Paths # Configure project scan directories
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- **Safety**: Built with strict protections. Preview changes with `mole clean -DryRun`.
|
||||||
|
- **Be Careful**: Although safe by design, file deletion is permanent. Please review operations carefully.
|
||||||
|
- **Debug Mode**: Use `-Debug` for detailed logs (e.g., `mole clean -Debug`). Combine with `-DryRun` for comprehensive preview including risk levels and file details.
|
||||||
|
- **Navigation**: Supports arrow keys for TUI navigation.
|
||||||
|
- **Configuration**: Use `mole clean -Whitelist` to manage protected paths, `mole purge -Paths` to configure scan directories.
|
||||||
|
|
||||||
|
## Features in Detail
|
||||||
|
|
||||||
|
### Deep System Cleanup
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
mole clean
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
Scanning cache directories...
|
||||||
|
|
||||||
|
✓ User temp files 12.3GB
|
||||||
|
✓ Browser cache (Chrome, Edge, Firefox) 8.5GB
|
||||||
|
✓ Developer tools (Node.js, npm, Python) 15.2GB
|
||||||
|
✓ Windows logs and temp files 4.1GB
|
||||||
|
✓ App-specific cache (Spotify, Slack, VS Code) 6.8GB
|
||||||
|
✓ Recycle Bin 9.2GB
|
||||||
|
|
||||||
|
====================================================================
|
||||||
|
Space freed: 56.1GB | Free space now: 180.3GB
|
||||||
|
====================================================================
|
||||||
|
```
|
||||||
|
|
||||||
|
### Smart App Uninstaller
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
mole uninstall
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
Select Apps to Remove
|
||||||
|
═══════════════════════════
|
||||||
|
▶ ☑ Adobe Photoshop 2024 (4.2GB) | Old
|
||||||
|
☐ IntelliJ IDEA (2.8GB) | Recent
|
||||||
|
☐ Premiere Pro (3.4GB) | Recent
|
||||||
|
|
||||||
|
Uninstalling: Adobe Photoshop 2024
|
||||||
|
|
||||||
|
✓ Removed application
|
||||||
|
✓ Cleaned 52 related files across 8 locations
|
||||||
|
- AppData, Caches, Preferences
|
||||||
|
- Logs, Registry entries
|
||||||
|
- Extensions, Plugins
|
||||||
|
|
||||||
|
====================================================================
|
||||||
|
Space freed: 4.8GB
|
||||||
|
====================================================================
|
||||||
|
```
|
||||||
|
|
||||||
|
### System Optimization
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
mole optimize
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
System: 12/32 GB RAM | 280/460 GB Disk (61%) | Uptime 6d
|
||||||
|
|
||||||
|
✓ Clear Windows Update cache
|
||||||
|
✓ Reset DNS cache
|
||||||
|
✓ Clean event logs and diagnostic reports
|
||||||
|
✓ Refresh Windows Search index
|
||||||
|
✓ Clear thumbnail cache
|
||||||
|
✓ Optimize startup programs
|
||||||
|
|
||||||
|
====================================================================
|
||||||
|
System optimization completed
|
||||||
|
====================================================================
|
||||||
|
```
|
||||||
|
|
||||||
|
### Disk Space Analyzer
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
mole analyze
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
Analyze Disk C:\Users\YourName\Documents | Total: 156.8GB
|
||||||
|
|
||||||
|
▶ 1. ███████████████████ 48.2% | 📁 Downloads 75.4GB >6mo
|
||||||
|
2. ██████████░░░░░░░░░ 22.1% | 📁 Videos 34.6GB
|
||||||
|
3. ████░░░░░░░░░░░░░░░ 14.3% | 📁 Pictures 22.4GB
|
||||||
|
4. ███░░░░░░░░░░░░░░░░ 10.8% | 📁 Documents 16.9GB
|
||||||
|
5. ██░░░░░░░░░░░░░░░░░ 5.2% | 📄 backup_2023.zip 8.2GB
|
||||||
|
|
||||||
|
↑↓←→ Navigate | O Open | F Show | Del Delete | L Large files | Q Quit
|
||||||
|
```
|
||||||
|
|
||||||
|
### Live System Status
|
||||||
|
|
||||||
|
Real-time dashboard with system health score, hardware info, and performance metrics.
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
mole status
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
Mole Status Health ● 92 Desktop PC · Intel i7 · 32GB · Windows 11
|
||||||
|
|
||||||
|
⚙ CPU ▦ Memory
|
||||||
|
Total ████████████░░░░░░░ 45.2% Used ███████████░░░░░░░ 58.4%
|
||||||
|
Load 0.82 / 1.05 / 1.23 (8 cores) Total 18.7 / 32.0 GB
|
||||||
|
Core 1 ███████████████░░░░ 78.3% Free ████████░░░░░░░░░░ 41.6%
|
||||||
|
Core 2 ████████████░░░░░░░ 62.1% Avail 13.3 GB
|
||||||
|
|
||||||
|
▤ Disk ⚡ Power
|
||||||
|
Used █████████████░░░░░░ 67.2% Status AC Power
|
||||||
|
Free 156.3 GB Temp 58°C
|
||||||
|
Read ▮▯▯▯▯ 2.1 MB/s
|
||||||
|
Write ▮▮▮▯▯ 18.3 MB/s
|
||||||
|
|
||||||
|
⇅ Network ▶ Processes
|
||||||
|
Down ▮▮▯▯▯ 3.2 MB/s Code ▮▮▮▮▯ 42.1%
|
||||||
|
Up ▮▯▯▯▯ 0.8 MB/s Chrome ▮▮▮▯▯ 28.3%
|
||||||
|
```
|
||||||
|
|
||||||
|
Health score based on CPU, memory, disk, temperature, and I/O load. Color-coded by range.
|
||||||
|
|
||||||
|
### Project Artifact Purge
|
||||||
|
|
||||||
|
Clean old build artifacts (`node_modules`, `target`, `build`, `dist`, etc.) from your projects to free up disk space.
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
mole purge
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
Select Categories to Clean - 18.5GB (8 selected)
|
||||||
|
|
||||||
|
➤ ● my-react-app 3.2GB | node_modules
|
||||||
|
● old-project 2.8GB | node_modules
|
||||||
|
● rust-app 4.1GB | target
|
||||||
|
● next-blog 1.9GB | node_modules
|
||||||
|
○ current-work 856MB | node_modules | Recent
|
||||||
|
● django-api 2.3GB | venv
|
||||||
|
● vue-dashboard 1.7GB | node_modules
|
||||||
|
● backend-service 2.5GB | node_modules
|
||||||
|
```
|
||||||
|
|
||||||
|
Use with caution: This will permanently delete selected artifacts. Review carefully before confirming. Recent projects — less than 7 days old — are marked and unselected by default.
|
||||||
|
|
||||||
|
Custom scan paths can be configured with `mole purge -Paths`.
|
||||||
|
|
||||||
|
## Installation Options
|
||||||
|
|
||||||
### Manual Installation
|
### Manual Installation
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
@@ -37,51 +250,19 @@ cd Mole/windows
|
|||||||
.\install.ps1 -Uninstall
|
.\install.ps1 -Uninstall
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Configuration
|
||||||
|
|
||||||
```powershell
|
Mole stores its configuration in:
|
||||||
# Interactive menu
|
|
||||||
mole
|
|
||||||
|
|
||||||
# Show help
|
- Config: `~\.config\mole\`
|
||||||
mole -ShowHelp
|
- Cache: `~\.cache\mole\`
|
||||||
|
- Whitelist: `~\.config\mole\whitelist.txt`
|
||||||
# Show version
|
- Purge paths: `~\.config\mole\purge_paths.txt`
|
||||||
mole -Version
|
|
||||||
|
|
||||||
# Commands
|
|
||||||
mole clean # Deep system cleanup
|
|
||||||
mole clean -DryRun # Preview cleanup without deleting
|
|
||||||
mole uninstall # Interactive app uninstaller
|
|
||||||
mole optimize # System optimization
|
|
||||||
mole purge # Clean developer artifacts
|
|
||||||
mole analyze # Disk space analyzer
|
|
||||||
mole status # System health monitor
|
|
||||||
```
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
|---------|-------------|
|
|
||||||
| `clean` | Deep cleanup of temp files, caches, and logs |
|
|
||||||
| `uninstall` | Interactive application uninstaller |
|
|
||||||
| `optimize` | System optimization and health checks |
|
|
||||||
| `purge` | Clean project build artifacts (node_modules, etc.) |
|
|
||||||
| `analyze` | Interactive disk space analyzer (TUI) |
|
|
||||||
| `status` | Real-time system health monitor (TUI) |
|
|
||||||
|
|
||||||
## Environment Variables
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|----------|-------------|
|
|
||||||
| `MOLE_DRY_RUN=1` | Preview changes without making them |
|
|
||||||
| `MOLE_DEBUG=1` | Enable debug output |
|
|
||||||
| `MO_ANALYZE_PATH` | Starting path for analyze tool |
|
|
||||||
|
|
||||||
## Directory Structure
|
## Directory Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
windows/
|
mole/ (windows branch)
|
||||||
├── mole.ps1 # Main CLI entry point
|
├── mole.ps1 # Main CLI entry point
|
||||||
├── install.ps1 # Windows installer
|
├── install.ps1 # Windows installer
|
||||||
├── Makefile # Build automation for Go tools
|
├── Makefile # Build automation for Go tools
|
||||||
@@ -119,7 +300,7 @@ windows/
|
|||||||
The analyze and status commands require Go to be installed:
|
The analyze and status commands require Go to be installed:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
cd windows
|
# From the repository root
|
||||||
|
|
||||||
# Build both tools
|
# Build both tools
|
||||||
make build
|
make build
|
||||||
@@ -131,39 +312,20 @@ go build -o bin/status.exe ./cmd/status/
|
|||||||
# The wrapper scripts will auto-build if Go is available
|
# The wrapper scripts will auto-build if Go is available
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
## Support
|
||||||
|
|
||||||
Mole stores its configuration in:
|
- If Mole saved you disk space, consider starring the repo or [sharing it](https://twitter.com/intent/tweet?url=https://github.com/tw93/Mole/tree/windows&text=Mole%20-%20Deep%20clean%20and%20optimize%20your%20Windows%20PC.) with friends.
|
||||||
- Config: `~\.config\mole\`
|
- Have ideas or fixes? Check our [Contributing Guide](https://github.com/tw93/Mole/blob/windows/CONTRIBUTING.md), then open an issue or PR to help shape Mole's future.
|
||||||
- Cache: `~\.cache\mole\`
|
- Love Mole? [Buy Tw93 an ice-cold Coke](https://miaoyan.app/cats.html?name=Mole) to keep the project alive and kicking! 🥤
|
||||||
- Whitelist: `~\.config\mole\whitelist.txt`
|
|
||||||
- Purge paths: `~\.config\mole\purge_paths.txt`
|
|
||||||
|
|
||||||
## Development Phases
|
## Community Love
|
||||||
|
|
||||||
### Phase 1: Core Infrastructure ✅
|
Mole wouldn't be possible without these amazing contributors. They've built countless features that make Mole what it is today. Go follow them! ❤️
|
||||||
- [x] `install.ps1` - Windows installer
|
|
||||||
- [x] `mole.ps1` - Main CLI entry point
|
|
||||||
- [x] `lib/core/*` - Core utility libraries
|
|
||||||
|
|
||||||
### Phase 2: Cleanup Features ✅
|
[](https://github.com/tw93/Mole/graphs/contributors)
|
||||||
- [x] `bin/clean.ps1` - Deep cleanup orchestrator
|
|
||||||
- [x] `bin/uninstall.ps1` - App removal with leftover detection
|
|
||||||
- [x] `bin/optimize.ps1` - System optimization
|
|
||||||
- [x] `bin/purge.ps1` - Project artifact cleanup
|
|
||||||
- [x] `lib/clean/*` - Cleanup modules
|
|
||||||
|
|
||||||
### Phase 3: TUI Tools ✅
|
Join thousands of users worldwide who trust Mole to keep their systems clean and optimized.
|
||||||
- [x] `cmd/analyze/` - Disk usage analyzer (Go)
|
|
||||||
- [x] `cmd/status/` - Real-time system monitor (Go)
|
|
||||||
- [x] `bin/analyze.ps1` - Analyzer wrapper
|
|
||||||
- [x] `bin/status.ps1` - Status wrapper
|
|
||||||
|
|
||||||
### Phase 4: Testing & CI (Planned)
|
|
||||||
- [ ] `tests/` - Pester tests
|
|
||||||
- [ ] GitHub Actions workflows
|
|
||||||
- [ ] `scripts/build.ps1` - Build automation
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Same license as the main Mole project.
|
MIT License — feel free to enjoy and participate in open source.
|
||||||
|
|||||||
Reference in New Issue
Block a user