mirror of
https://github.com/tw93/Mole.git
synced 2026-02-04 11:31:46 +00:00
docs: refine README wording for improved clarity and conciseness, and add a contributors section.
This commit is contained in:
Tw93
42
README.md
42
README.md
@@ -18,7 +18,7 @@
|
||||
|
||||
## Features
|
||||
|
||||
- **Unified toolkit**: Consolidated features of CleanMyMac, AppCleaner, DaisyDisk, and iStat into a **single binary**
|
||||
- **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
|
||||
@@ -26,16 +26,16 @@
|
||||
|
||||
## Quick Start
|
||||
|
||||
**Install by Brew, recommended:**
|
||||
**Install via Homebrew — recommended:**
|
||||
|
||||
```bash
|
||||
brew install mole
|
||||
```
|
||||
|
||||
**or by Script, for older macOS or latest code:**
|
||||
**Or via script — for older macOS versions or latest code:**
|
||||
|
||||
```bash
|
||||
# Add '-s latest' for newest, '-s dev' for development, or '-s 1.17.0' for a version.
|
||||
# Add '-s latest' for the latest, '-s dev' for development, or '-s 1.17.0' for a specific version.
|
||||
curl -fsSL https://raw.githubusercontent.com/tw93/mole/main/install.sh | bash
|
||||
```
|
||||
|
||||
@@ -52,7 +52,7 @@ mo purge # Clean project build artifacts
|
||||
mo installer # Find and remove installer files
|
||||
|
||||
mo touchid # Configure Touch ID for sudo
|
||||
mo completion # Setup shell tab completion
|
||||
mo completion # Set up shell tab completion
|
||||
mo update # Update Mole
|
||||
mo remove # Remove Mole from system
|
||||
mo --help # Show help
|
||||
@@ -70,13 +70,13 @@ mo purge --paths # Configure project scan directories
|
||||
|
||||
## Tips
|
||||
|
||||
- **Terminal**: iTerm2 has known compatibility issues; we recommend Alacritty, kitty, WezTerm, Ghostty, or Warp.
|
||||
- **Terminal**: For best results, use Alacritty, kitty, WezTerm, Ghostty, or Warp. iTerm2 may have compatibility issues.
|
||||
- **Safety**: Built with strict protections. See our [Security Audit](SECURITY_AUDIT.md). Preview changes with `mo clean --dry-run`.
|
||||
- **Whitelist**: Manage protected paths with `mo clean --whitelist`.
|
||||
- **Touch ID**: Enable Touch ID for sudo commands by running `mo touchid`.
|
||||
- **Shell Completion**: Enable tab completion by running `mo completion` (auto-detect and install).
|
||||
- **Shell Completion**: Enable tab completion by running `mo completion` — auto-detects your shell.
|
||||
- **Navigation**: Supports standard arrow keys and Vim bindings (`h/j/k/l`).
|
||||
- **Debug**: View detailed logs by appending the `--debug` flag (e.g., `mo clean --debug`).
|
||||
- **Debug**: View detailed logs by appending the `--debug` flag, like `mo clean --debug`.
|
||||
- **Detailed Preview**: Combine `--dry-run --debug` for comprehensive operation details including risk levels, file paths, sizes, and expected outcomes. Check `~/.config/mole/mole_debug_session.log` for full details.
|
||||
|
||||
## Features in Detail
|
||||
@@ -142,7 +142,7 @@ System: 5/32 GB RAM | 333/460 GB Disk (72%) | Uptime 6d
|
||||
System optimization completed
|
||||
====================================================================
|
||||
|
||||
Use `mo optimize --whitelist` to protect specific optimization items from being run.
|
||||
Use `mo optimize --whitelist` to exclude specific optimizations.
|
||||
```
|
||||
|
||||
### Disk Space Analyzer
|
||||
@@ -188,7 +188,7 @@ Up ▮▯▯▯▯ 0.8 MB/s Chrome ▮▮▮▯▯ 2
|
||||
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, color-coded by severity.
|
||||
|
||||
### Project Artifact Purge
|
||||
|
||||
@@ -209,7 +209,7 @@ Select Categories to Clean - 18.5GB (8 selected)
|
||||
● backend-service 2.5GB | node_modules
|
||||
```
|
||||
|
||||
> **Use with caution:** This will permanently delete selected artifacts. Review carefully before confirming. Recent projects (< 7 days) are marked and unselected by default.
|
||||
> **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.
|
||||
|
||||
<details>
|
||||
<summary><strong>Custom Scan Paths</strong></summary>
|
||||
@@ -222,7 +222,7 @@ 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, defaults to `~/Projects`, `~/GitHub`, `~/dev`, etc.
|
||||
When custom paths are configured, only those directories are scanned. Otherwise, it defaults to `~/Projects`, `~/GitHub`, `~/dev`, etc.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -251,32 +251,34 @@ Launch Mole commands instantly from Raycast or Alfred:
|
||||
curl -fsSL https://raw.githubusercontent.com/tw93/Mole/main/scripts/setup-quick-launchers.sh | bash
|
||||
```
|
||||
|
||||
Adds 5 commands: `clean`, `uninstall`, `optimize`, `analyze`, `status`. Mole automatically detects your terminal, or you can set `MO_LAUNCHER_APP=<name>` to override. For Raycast, if this is your first script directory, add it in Raycast Extensions (Add Script Directory) and then run "Reload Script Directories" to load the new commands.
|
||||
Adds 5 commands: `clean`, `uninstall`, `optimize`, `analyze`, `status`.
|
||||
|
||||
Mole automatically detects your terminal, or set `MO_LAUNCHER_APP=<name>` to override. For Raycast users: if this is your first script directory, add it via Raycast Extensions → Add Script Directory, then run "Reload Script Directories".
|
||||
|
||||
## Community Love
|
||||
|
||||
Mole wouldn't be possible without these amazing contributors. They've built countless features that make Mole what it is today. Go follow them! ❤️
|
||||
|
||||
<a href="https://github.com/tw93/Mole/graphs/contributors">
|
||||
<img src="./CONTRIBUTORS.svg?v=2" width="1000" />
|
||||
</a>
|
||||
|
||||
Mole's development can not be without these Hackers. They contributed a lot of capabilities for Mole. Also, welcome to follow them! ❤️
|
||||
|
||||
Users from around the world are loving Mole! Join the community and share your experience.
|
||||
Join thousands of users worldwide who trust Mole to keep their Macs clean and optimized.
|
||||
|
||||
<img src="https://cdn.tw93.fun/pic/lovemole.jpeg" alt="Community feedback on Mole" width="1000" />
|
||||
|
||||
## Support
|
||||
|
||||
- If Mole saved you space, consider starring the repo or [recommending it](https://twitter.com/intent/tweet?url=https://github.com/tw93/Mole&text=Mole%20-%20Deep%20clean%20and%20optimize%20your%20Mac.) to more friends.
|
||||
- If Mole saved you disk space, consider starring the repo or [sharing it](https://twitter.com/intent/tweet?url=https://github.com/tw93/Mole&text=Mole%20-%20Deep%20clean%20and%20optimize%20your%20Mac.) with friends.
|
||||
- Have ideas or fixes? Check our [Contributing Guide](CONTRIBUTING.md), then open an issue or PR to help shape Mole's future.
|
||||
- Love Mole? Treat Tw93 to a Coke via <a href="https://miaoyan.app/cats.html?name=Mole" target="_blank">this link</a> to keep the project growing.
|
||||
- Love Mole? <a href="https://miaoyan.app/cats.html?name=Mole" target="_blank">Buy Tw93 an ice-cold Coke</a> to keep the project alive and kicking! 🥤
|
||||
|
||||
<details>
|
||||
<summary><strong>These friends sent me a lot of Coke</strong></summary>
|
||||
<summary><strong>Friends who bought me Coke</strong></summary>
|
||||
<br/>
|
||||
<a href="https://miaoyan.app/cats.html?name=Mole"><img src="https://miaoyan.app/assets/sponsors.svg" width="1000" /></a>
|
||||
</details>
|
||||
|
||||
## License
|
||||
|
||||
MIT License - feel free to enjoy and participate in open source.
|
||||
MIT License — feel free to enjoy and participate in open source.
|
||||
|
||||
Reference in New Issue
Block a user