mirrors/Mole
1
0
Fork 0
mirror of https://github.com/tw93/Mole.git synced 2026-03-22 19:40:07 +00:00
Code Activity

docs: refine README copy

Browse Source
This commit is contained in:
tw93
2026-02-22 20:46:34 +08:00
parent fd5ceea743
commit 1c2796377d
1 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@@ -18,11 +18,11 @@
## Features
- **All-in-one toolkit**: CleanMyMac, AppCleaner, DaisyDisk, and iStat Menus combined into a **single binary**
- **Deep cleaning**: Scans and removes caches, logs, and browser leftovers to **reclaim gigabytes of space**
- **Smart uninstaller**: Thoroughly removes apps along with launch agents, preferences, and **hidden remnants**
- **Disk insights**: Visualizes usage, manages large files, **rebuilds caches**, and refreshes system services
- **Live monitoring**: Real-time stats for CPU, GPU, memory, disk, and network to **diagnose performance issues**
- **All-in-one toolkit**: Combines CleanMyMac, AppCleaner, DaisyDisk, and iStat Menus in a **single binary**
- **Deep cleaning**: Removes caches, logs, and browser leftovers to **reclaim gigabytes of space**
- **Smart uninstaller**: Removes apps plus launch agents, preferences, and **hidden remnants**
- **Disk insights**: Visualizes usage, finds large files, **rebuilds caches**, and refreshes system services
- **Live monitoring**: Shows real-time CPU, GPU, memory, disk, and network stats
## Quick Start
@@ -39,7 +39,7 @@ brew install mole
curl -fsSL https://raw.githubusercontent.com/tw93/mole/main/install.sh | bash
```
**Windows:** Mole is designed for macOS, but we offer an experimental Windows version based on user demand. See the [windows branch](https://github.com/tw93/Mole/tree/windows), for early adopters only.
**Windows:** Mole is built for macOS. An experimental Windows version is available in the [windows branch](https://github.com/tw93/Mole/tree/windows) for early adopters.
**Run:**
@@ -73,15 +73,15 @@ mo analyze /Volumes # Analyze external drives only
## Tips
- **Terminal**: iTerm2 has known compatibility issues; we recommend Alacritty, kitty, WezTerm, Ghostty, or Warp.
- **Safety**: Built with strict protections. See [Security Audit](SECURITY_AUDIT.md). Preview changes with `mo clean --dry-run`.
- **Be Careful**: Although safe by design, file deletion is permanent. Please review operations carefully.
- **Debug Mode**: Use `--debug` for detailed logs (e.g., `mo clean --debug`). Combine with `--dry-run` for comprehensive preview including risk levels and file details.
- **Operation Log**: File operations are logged to `~/.config/mole/operations.log` for troubleshooting. Disable with `MO_NO_OPLOG=1`.
- **Video Tutorial**: Watch the [Mole tutorial video](https://www.youtube.com/watch?v=UEe9-w4CcQ0). Thanks to **PAPAYA 電腦教室**.
- **Terminal**: iTerm2 has known compatibility issues. We recommend Alacritty, kitty, WezTerm, Ghostty, or Warp.
- **Safety**: Mole uses strict protections, but deletions are permanent. Review carefully and preview with `mo clean --dry-run`. See [Security Audit](SECURITY_AUDIT.md).
- **Debug Mode**: Use `--debug` for detailed logs. Combine with `--dry-run` for a full preview with risk levels and file details.
- **Operation Log**: File operations are logged to `~/.config/mole/operations.log`. Disable with `MO_NO_OPLOG=1`.
- **Navigation**: Supports arrow keys and Vim bindings (`h/j/k/l`).
- **Status Shortcuts**: In `mo status`, press `k` to toggle cat visibility and save preference, `q` to quit.
- **Configuration**: Run `mo touchid` for Touch ID sudo, `mo completion` for shell tab completion, `mo clean --whitelist` to manage protected paths.
- **Simulator Runtime Volumes**: In `mo clean` -> Developer tools, Mole auto-detects and removes unused CoreSimulator `Volumes/Cryptex` entries (IN_USE items are safely skipped).
- **Status Shortcuts**: In `mo status`, press `k` to toggle the cat and save the preference, `q` to quit.
- **Configuration**: Use `mo touchid` for Touch ID sudo, `mo completion` for shell completion, and `mo clean --whitelist` to manage protected paths.
- **Simulator Runtime Volumes**: In `mo clean` -> Developer tools, Mole removes unused CoreSimulator `Volumes/Cryptex` entries and skips `IN_USE` items.
## Features in Detail
@@ -151,7 +151,7 @@ Use `mo optimize --whitelist` to exclude specific optimizations.
### Disk Space Analyzer
By default, overview skips external drives mounted under `/Volumes` for faster startup. To inspect external drives, run `mo analyze /Volumes` (or a specific mount path).
By default, Mole skips external drives under `/Volumes` for faster startup. To inspect them, run `mo analyze /Volumes` or a specific mount path.
```bash
$ mo analyze
@@ -169,7 +169,7 @@ Analyze Disk ~/Documents | Total: 156.8GB
### Live System Status
Real-time dashboard with system health score, hardware info, and performance metrics.
Real-time dashboard with health score, hardware info, and performance metrics.
```bash
$ mo status
@@ -194,11 +194,11 @@ Up ▄▄▄▃▃▃▄▆▆▇█▁▁▁▁▁ 0.02 MB/s Chrome
Proxy HTTP · 192.168.1.100 Terminal ▮▯▯▯▯ 12.5%
```
Health score based on CPU, memory, disk, temperature, and I/O load. Color-coded by range.
Health score is based on CPU, memory, disk, temperature, and I/O load, with color-coded ranges.
### Project Artifact Purge
Clean old build artifacts (`node_modules`, `target`, `build`, `dist`, etc.) from your projects to free up disk space.
Clean old build artifacts such as `node_modules`, `target`, `build`, and `dist` to free up disk space.
```bash
mo purge
@@ -215,15 +215,15 @@ Select Categories to Clean - 18.5GB (8 selected)
● backend-service 2.5GB | node_modules
```
> We recommend to install `fd` on your mac.
> We recommend installing `fd` on macOS.
> `brew install fd`
> **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.
> **Use with caution:** This permanently deletes selected artifacts. Review carefully before confirming. Projects newer than 7 days are marked and unselected by default.
<details>
<summary><strong>Custom Scan Paths</strong></summary>
Run `mo purge --paths` to configure which directories to scan, or edit `~/.config/mole/purge_paths` directly:
Run `mo purge --paths` to configure scan directories, or edit `~/.config/mole/purge_paths` directly:
```shell
~/Documents/MyProjects
@@ -231,13 +231,13 @@ Run `mo purge --paths` to configure which directories to scan, or edit `~/.confi
~/Work/ClientB
```
When custom paths are configured, only those directories are scanned. Otherwise, it defaults to `~/Projects`, `~/GitHub`, `~/dev`, etc.
When custom paths are configured, Mole scans only those directories. Otherwise, it uses defaults like `~/Projects`, `~/GitHub`, and `~/dev`.
</details>
### Installer Cleanup
Find and remove large installer files scattered across Downloads, Desktop, Homebrew caches, iCloud, and Mail. Each file is labeled by source to help you know where the space is hiding.
Find and remove large installer files across Downloads, Desktop, Homebrew caches, iCloud, and Mail. Each file is labeled by source.
```bash
mo installer
@@ -254,7 +254,7 @@ Select Installers to Remove - 3.8GB (5 selected)
## Quick Launchers
Launch Mole commands instantly from Raycast or Alfred:
Launch Mole commands from Raycast or Alfred:
```bash
curl -fsSL https://raw.githubusercontent.com/tw93/Mole/main/scripts/setup-quick-launchers.sh | bash
@@ -264,7 +264,7 @@ Adds 5 commands: `clean`, `uninstall`, `optimize`, `analyze`, `status`.
### Raycast Setup
After running the script above, **complete these steps in Raycast**:
After running the script, complete these steps in Raycast:
1. Open Raycast Settings (⌘ + ,)
2. Go to **Extensions** → **Script Commands**
@@ -273,15 +273,15 @@ After running the script above, **complete these steps in Raycast**:
5. Search in Raycast for: **"Reload Script Directories"** and run it
6. Done! Search for `mole`, `clean`, or `optimize` to use the commands
> **Note**: The script creates the commands automatically, but Raycast requires you to manually add the script directory. This is a one-time setup.
> **Note**: The script creates the commands, but Raycast still requires a one-time manual script directory setup.
### Terminal Detection
Mole automatically detects your terminal app (Warp, Ghostty, Alacritty, Kitty, WezTerm, etc.). To override, set `MO_LAUNCHER_APP=<name>` in your environment.
Mole auto-detects your terminal app. To override, set `MO_LAUNCHER_APP=<name>`.
## Community Love
Big thanks to all contributors who helped build Mole. Go follow them! ❤️
Thanks to everyone who helped build Mole. Go follow them. ❤️
<a href="https://github.com/tw93/Mole/graphs/contributors">
<img src="./CONTRIBUTORS.svg?v=2" width="1000" />
@@ -295,11 +295,11 @@ Real feedback from users who shared Mole on X.
## Support
- If Mole helped you, star the repo or [share it](https://twitter.com/intent/tweet?url=https://github.com/tw93/Mole&text=Mole%20-%20Deep%20clean%20and%20optimize%20your%20Mac.) with friends.
- Got ideas or found bugs? Check the [Contributing Guide](CONTRIBUTING.md) and open an issue or PR.
- Like Mole? <a href="https://miaoyan.app/cats.html?name=Mole" target="_blank">Buy Tw93 a Coke</a> to support the project! 🥤 Supporters below.
- Got ideas or bugs? Read the [Contributing Guide](CONTRIBUTING.md) and open an issue or PR.
- Like Mole? <a href="https://miaoyan.app/cats.html?name=Mole" target="_blank">Buy Tw93 a Coke</a> to support the project. 🥤 Supporters are below.
<a href="https://miaoyan.app/cats.html?name=Mole"><img src="https://miaoyan.app/assets/sponsors.svg" width="1000" loading="lazy" /></a>
## License
MIT License, feel free to enjoy and participate in open source.
MIT License. Feel free to use Mole and contribute.