From a3c3975f5f26701cf82cb61970ccc0f5a7e54b6c Mon Sep 17 00:00:00 2001 From: Tw93 Date: Sat, 4 Oct 2025 17:58:33 +0800 Subject: [PATCH] :sparkles: Clearer documentation --- README.md | 136 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 71 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index a66ffea..22f85cc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@
- Mole Logo -

Mole

+

Mole

๐Ÿฆก Dig deep like a mole to clean your Mac.

@@ -13,14 +12,21 @@ Telegram

-## Highlights +

+ Mole - 95.50GB freed +

+ +## Features at a Glance - ๐Ÿฆ **Deep System Cleanup** - Remove hidden caches, logs, and temp files in one sweep - ๐Ÿ“ฆ **Thorough Uninstall** - 22+ locations cleaned vs 1 standard, beats CleanMyMac/Lemon +- ๐Ÿ“Š **Interactive Disk Analyzer** - Navigate folders like a file manager, find and delete large files instantly - โšก๏ธ **Fast & Lightweight** - Terminal-based, zero bloat, arrow-key navigation with pagination - ๐Ÿงน **Massive Space Recovery** - Reclaim 100GB+ of wasted disk space -## Installation +## Quick Start + +**Install:** ```bash curl -fsSL https://raw.githubusercontent.com/tw93/mole/main/install.sh | bash @@ -32,111 +38,111 @@ Or via Homebrew: brew install tw93/tap/mole ``` -> Pick one method to avoid conflicts, new users check [ๅฐ็™ฝไฝฟ็”จๆŒ‡ๅ—](./GUIDE.md) - -## Usage +**Run:** ```bash -mole # Interactive main menu -mole clean # Deep system cleanup -mole clean --dry-run # Preview cleanup (no deletions) -mole uninstall # Interactive app uninstaller -mole update # Update to latest version +mole # Interactive menu +mole clean # System cleanup +mole clean --dry-run # Preview mode +mole uninstall # Uninstall apps +mole analyze # Disk analyzer +mole update # Update Mole mole --help # Show help ``` -> Installed via Homebrew? Use `brew upgrade mole` to update +> ๐Ÿ’ก New to terminal? Check [ๅฐ็™ฝไฝฟ็”จๆŒ‡ๅ—](./GUIDE.md) ยท Homebrew users: `brew upgrade mole` to update -## Examples +## Features -### Deep System Cleanup +### ๐Ÿงน Deep System Cleanup ```bash $ mole clean -Starting user-level cleanup... - โ–ถ System essentials - โœ“ User app cache (28 items) (45.2GB) - โœ“ User app logs (15 items) (2.1GB) + โœ“ User app cache (45.2GB) # Caches, logs, trash (20-50GB) + โœ“ User app logs (2.1GB) โœ“ Trash (12.3GB) -โ–ถ Browser cleanup - โœ“ Chrome cache (8 items) (8.4GB) +โ–ถ Browser cleanup # Chrome, Safari, Arc (5-15GB) + โœ“ Chrome cache (8.4GB) โœ“ Safari cache (2.1GB) - โœ“ Arc cache (3.2GB) -โ–ถ Extended developer caches +โ–ถ Developer tools # npm, Docker, Xcode (15-40GB) โœ“ Xcode derived data (9.1GB) - โœ“ Node.js cache (4 items) (14.2GB) - โœ“ VS Code cache (1.4GB) + โœ“ Node.js cache (14.2GB) -โ–ถ Applications - โœ“ JetBrains cache (3.8GB) - โœ“ Slack cache (2.2GB) - โœ“ Discord cache (1.8GB) +โ–ถ Others # Cloud, Office, Media (10-40GB) + โœ“ Dropbox cache (5.2GB) + โœ“ Spotify cache (3.1GB) ==================================================================== ๐ŸŽ‰ CLEANUP COMPLETE! ๐Ÿ’พ Space freed: 95.50GB | Free space now: 223.5GB -๐Ÿ“Š Files cleaned: 6420 | Categories processed: 6 ==================================================================== ``` -### Smart App Uninstaller +**Protect important files:** + +```bash +# View whitelist +mole clean --whitelist + +# Add protection +echo '~/Library/Caches/ms-playwright*' >> ~/.config/mole/whitelist +``` + +### ๐Ÿ—‘๏ธ Smart App Uninstaller ```bash $ mole uninstall -Select Apps to Remove - +๐Ÿ—‘๏ธ Select Apps to Remove +โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ• โ–ถ โ˜‘ Adobe Creative Cloud (12.4G) | Old โ˜ WeChat (2.1G) | Recent โ˜ Final Cut Pro (3.8G) | Recent ๐Ÿ—‘๏ธ Uninstalling: Adobe Creative Cloud - โœ“ Removed application - โœ“ Cleaned 52 related files + โœ“ Removed application # /Applications/ + โœ“ Cleaned 52 related files # ~/Library/ (12 locations) + - Support files & caches # Application Support, Caches + - Preferences & logs # Preferences, Logs + - WebKit storage & cookies # WebKit, HTTPStorages + - Extensions & plugins # Internet Plug-Ins, Services + - System files (sudo) # /Library/, Launch daemons ==================================================================== ๐ŸŽ‰ UNINSTALLATION COMPLETE! -๐Ÿ—‘๏ธ Apps uninstalled: 1 | Space freed: 12.8GB +Space freed: 12.8GB ==================================================================== ``` -## What Mole Cleans - -| Category | Targets | Typical Recovery | -|----------|---------|------------------| -| **System** | App caches, logs, trash, crash reports, Spotlight cache | 20-50GB | -| **Browsers** | Safari, Chrome, Edge, Arc, Firefox, Brave cache | 5-15GB | -| **Developer** | npm, pip, Docker, Homebrew, Xcode, Android Studio | 15-40GB | -| **Cloud Storage** | Dropbox, Google Drive, OneDrive, Baidu Netdisk cache | 5-20GB | -| **Office Apps** | Microsoft Office, iWork, WPS Office cache | 2-8GB | -| **Media Apps** | Spotify, Music, VLC, IINA, video players cache | 3-12GB | -| **Communication** | Slack, Discord, Teams, WeChat, Zoom cache | 3-10GB | -| **Virtualization** | VMware, Parallels, VirtualBox, Vagrant cache | 5-15GB | - -**Protect Important Files:** Create `~/.config/mole/whitelist` to preserve critical caches: +### ๐Ÿ“Š Disk Space Analyzer ```bash -# View current whitelist -mole clean --whitelist +$ mole analyze -# Example: Protect Playwright browsers and build tools -echo '~/Library/Caches/ms-playwright*' >> ~/.config/mole/whitelist +๐Ÿ“Š Analyzing: /Users/tw93 +โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ• +Total: 156.8GB + +โ”œโ”€ ๐Ÿ“ Library 45.2GB +โ”‚ โ”œโ”€ ๐Ÿ“ Caches 28.4GB +โ”‚ โ””โ”€ ๐Ÿ“ Application Support 16.8GB +โ”œโ”€ ๐Ÿ“ Downloads 32.6GB +โ”‚ โ”œโ”€ ๐Ÿ“„ Xcode-14.3.1.dmg 12.3GB +โ”‚ โ”œโ”€ ๐Ÿ“„ backup_2023.zip 8.6GB +โ”‚ โ””โ”€ ๐Ÿ“ฆ old_projects.tar.gz 5.2GB +โ”œโ”€ ๐Ÿ“ Movies 28.9GB +โ”‚ โ”œโ”€ ๐Ÿ“„ vacation_2023.mov 15.4GB +โ”‚ โ””โ”€ ๐Ÿ“„ screencast_raw.mp4 8.8GB +โ”œโ”€ ๐Ÿ“ Documents 18.4GB +โ””โ”€ ๐Ÿ“ Desktop 12.7GB + +๐Ÿ’ก Navigate folders to find large files, press Delete key to remove ``` -## What Mole Uninstalls - -| Category | What Gets Removed | Locations | -|----------|------------------|-----------| -| **App Bundle** | Main application executable | `/Applications/` | -| **User Data** | Support files, caches, preferences, logs, containers, saved states | `~/Library/` (12 locations) | -| **Web Data** | WebKit storage, HTTP storage, cookies | `~/Library/WebKit/`, `~/Library/HTTPStorages/` | -| **Extensions** | Plugins, scripts, services, frameworks, QuickLook generators | `~/Library/Internet Plug-Ins/`, `~/Library/Services/` | -| **System** | Launch daemons, helper tools, system preferences, install receipts | `/Library/`, `/var/db/receipts/` (requires sudo) | - ## FAQ 1. **Will Mole delete important files?** - No. Mole has built-in protection and skips system-critical files. @@ -147,8 +153,8 @@ echo '~/Library/Caches/ms-playwright*' >> ~/.config/mole/whitelist ## Support - โญ๏ธ **Star this repo** if Mole helped you recover disk space -- ๐Ÿ› **Report issues** via [GitHub Issues](https://github.com/tw93/mole/issues) - ๐Ÿ’ฌ **Share with friends** who need to clean their Macs +- ๐Ÿ› **Report issues** via [GitHub Issues](https://github.com/tw93/mole/issues) - ๐Ÿฑ I have two cats, feed them canned food if you'd like ## License