1
0
mirror of https://github.com/tw93/Mole.git synced 2026-02-11 12:59:16 +00:00

Simpler documentation

This commit is contained in:
Tw93
2025-10-09 00:32:55 +08:00
parent 2cf4d4466c
commit a66ada115f
2 changed files with 94 additions and 88 deletions

159
GUIDE.md
View File

@@ -1,6 +1,6 @@
# Mole Mac 清理工具 - 小白使用指南
# Mole 小白使用指南
> 一个完全不懂技术的 Mac 用户也能轻松使用的清理工具教程
> 不懂技术也能用的 Mac 清理工具教程
## 第一步:打开终端
@@ -8,18 +8,18 @@
**方法一:快捷键(推荐)**
1.下键盘上的 `Command (⌘)` + `空格键`
2.弹出的搜索框输入 `终端``Terminal`
3. 按回车键,会打开一个黑色或白色的窗口
1.`Command (⌘)` + `空格键`
2. 在搜索框输入 `终端``Terminal`
3. 按回车
**方法二:应用程序**
1. 打开"访达"Finder
2.左侧的"应用程序"
3. 找到"实用工具"文件夹
4. 双击"终端"图标
1. 打开访达
2. 点左侧的应用程序
3. 找到实用工具文件夹
4. 双击终端
> 小提示:这个窗口看起来可能有点专业,但别担心,接下来的操作都很简单
> 小提示:别担心,接下来的操作都很简单
---
@@ -28,53 +28,53 @@
**方法一:一键安装(推荐)**
1. **复制安装命令**
用鼠标选中下面这行,然后`Command (⌘)` + `C` 复制:
选中下面这行,按 `Command (⌘)` + `C` 复制:
```bash
curl -fsSL https://raw.githubusercontent.com/tw93/mole/main/install.sh | bash
```
2. **粘贴到终端**
- 在终端窗口中,按 `Command (⌘)` + `V` 粘贴
- 或者右键点击终端窗口,选择"粘贴"
- 按 `Command (⌘)` + `V` 粘贴
- 或者右键选择粘贴
3. **开始安装**
- 按下 `回车键`
- 等几秒钟,会自动安装完成
- 看到类似"安装成功"的提示就完成
- 按回车
- 等几秒自动安装
- 看到安装成功提示就
**方法二:通过 Homebrew 安装**
如果你的电脑已经安装了 Homebrew可以使用这个命令
如果你装了 Homebrew用这个
```bash
brew install tw93/tap/mole
```
> 什么是 Homebrew一个 Mac 软件管理工具。如果你不知道这是什么,请使用方法一。
> 什么是 HomebrewMac 软件管理工具。不知道的话用方法一。
>
> **重要** 只选一种方法安装!不要同时用两种方法,会产生冲突。
> **注意** 只选一种方法装,别两种都用,会冲突。
>
> 注意:第一次安装可能会要求你验证管理员权限,支持 Touch ID 或输密码(输入时不显示任何字符,这是正常的
> 安装可能验证管理员权限Touch ID 或输密码都行,输密码时不显示字符是正常的
---
## 第三步:开始使用
1. **启动 Mole**
在终端输入以下命令并按回车:
在终端输入回车:
```bash
mo
```
如果提示找不到命令,也可以输入 `mole`功能完全相同)
找不到命令的话,试试 `mole`功能一样
2. **了解界面操作**
- 用键盘的 `` `` 方向键 选择菜单
- `空格键` 选中取消选中
- `回车键` 确认执行
- `q` 键退出当前界面
2. **界面操作**
- `` `` 方向键菜单
- `空格键` 选中/取消
- `回车键` 确认
- `q` 键退出
---
@@ -82,29 +82,29 @@ brew install tw93/tap/mole
### 重要提示
**首次使用强烈建议:**
**首次使用建议:**
1. **预览模式:** 先运行 `mo clean --dry-run` 查看将删除的内容,不会真的删除任何文件
2. **白名单保护:** 使用 `mo clean --whitelist` 保护重要缓存文件
3. **谨慎使用:** 如果你的 Mac 非常重要(生产环境、关键工作设备),建议等待 Mole 更成熟稳定后再使
1. **预览模式:** 先 `mo clean --dry-run` 看看会删什么,不会真删
2. **白名单保护:** 用 `mo clean --whitelist` 保护重要缓存
3. **谨慎使用:** Mac 很重要的话,等 Mole 更成熟
### 清理垃圾文件
**安全预览模式(推荐第一次使用):**
**预览模式(第一次用建议先试**
```bash
mo clean --dry-run
```
这个命令只会**显示**哪些文件会被清理,**不会真的删除**。你可以先看看效果再决定。
只显示会删什么,不会真删。先看看再决定。
**管理白名单(保护重要缓存)**
**白名单管理**
```bash
mo clean --whitelist
```
交互式选择哪些缓存不要删除,比如开发工具的大型缓存Homebrew、Gradle 等)
哪些缓存不,比如开发工具的大型缓存。
**正式清理:**
@@ -112,21 +112,20 @@ mo clean --whitelist
mo clean
```
清理系统缓存、日志、临时文件等,释放磁盘空间。Mole 很安全,只删可重新生成的文件。
清理系统缓存、日志、临时文件等释放空间。Mole 只删可重新生成的文件,放心用
### 卸载应用(彻底删除)
### 卸载应用
```bash
mo uninstall
```
这个功能
这个功能:
- 显示你电脑上所有已安装的应用
- 方向键选择要卸载的应用
- 按空格键标记(可以多选)
- 按回车确认删除
- **会连同应用的残留文件一起删除**
- 显示所有已装应用
- 方向键选,空格标记,可多选
- 回车确认删除
- **连残留文件一起删**
### 查看帮助
@@ -134,7 +133,7 @@ mo uninstall
mo --help
```
可以查看所有可用的命令和说明
查看所有命令
### 磁盘空间分析 🆕
@@ -142,23 +141,23 @@ mo --help
mo analyze
```
交互式查看哪些文件和文件夹占空间,帮助你快速找到并清理大文件
看哪些文件和文件夹占空间,快速找到并清理。
**基本操作:**
**操作:**
- `` ``上下选择
- `回车`:进入文件夹 / 打开文件预览
- `` ``:选择
- `回车`:进入文件夹/预览文件
- ``:返回上级
- `Delete`:删除(需确认)
- `Delete`:删除
- `q`:退出
> 需要管理员权限时会先尝试 Touch ID失败或不支持时自动回退为密码输入
> 需要权限时先试 Touch ID不支持再输密码
**提示:**
**提示:**
- 文件夹按大小排序,一目了然
- 文本文件可以直接预览,其他文件用系统默认应用打开
- 超过 15 项自动分页,继续按方向键滚动查看
- 文件夹按大小排序
- 文本文件直接预览,其他默认应用打开
- 超过 15 项自动分页
---
@@ -166,59 +165,67 @@ mo analyze
### 使用建议
**推荐:** 定期清理每月一次或磁盘快满时 · **避免:** 频繁清理(一周一次就够)或运行重要程序时清理
**推荐:** 定期清理每月一次或磁盘快满时
**避免:** 频繁清理,或在运行重要程序时清理
### 安全保障
**Mole 只删除可重新生成的缓存和日志,不会删除:** 应用配置(.plist、应用数据Application Support、系统关键文件、IDE 数据、数据库等
Mole 只删缓存和日志,不碰这些:
- 应用配置
- 应用数据
- 系统文件
- IDE 数据
- 数据库
---
## 常见问题
### 为什么输密码看不到字符?
### 为什么输密码看不到字符?
这是 Mac 终端安全设计,密码不会显示,直接输入后按回车就行。
Mac 终端安全设计,直接输按回车就行。
### 安装失败怎么办?
1. 检查网络连接是否正常
2. 尝试重新运行安装命令
3. 如果还不行,可以去 [GitHub Issues](https://github.com/tw93/mole/issues) 寻求帮助
1. 检查网络
2. 重新跑安装命令
3. 还不行去 [GitHub Issues](https://github.com/tw93/mole/issues)
### 清理相关问题
### 清理相关
**清理后能恢复吗?** 不需要!Mole 只删缓存和日志,应用会自动重新生成注意:应用卸载后无法恢复
**清理后能恢复吗?** 不用恢复。Mole 只删缓存和日志,应用会自动重新生成注意:应用卸载后无法恢复
**多久清理一次?** 建议每月一次,磁盘快满时立即清理
**多久清理一次?** 每月一次,磁盘快满时
### 如何更新和卸载 Mole
**更新:** 直接运行 `mo update`Homebrew 装会自动执行 `brew update && brew upgrade mole`
**更新:** `mo update`Homebrew 装会自动 `brew update && brew upgrade mole`
**卸载:** 任何安装方式都用 `mo remove`(会自动识别安装方式,清理所有相关文件
**卸载:** `mo remove`自动识别安装方式,清理所有文件
### Mole 会要求输入密码吗?支持 Touch ID 吗?
### Mole 支持 Touch ID 吗?
Mole 通过 `sudo` 请求管理员权限,默认提示输入密码。若你已经为 `sudo` 启用了 Touch ID同一个提示可以直接按指纹,失败再输密码。
Mole `sudo` 请求权限,默认输密码。如果你给 `sudo` 启用了 Touch ID可以直接按指纹失败再输密码。
### 如何让命令行支持 Touch ID
1. 打开配置文件`sudo nano /etc/pam.d/sudo`
2. 在文件顶部注释行下面加入
1. 打开配置:`sudo nano /etc/pam.d/sudo`
2. 在顶部注释下加
```txt
auth sufficient pam_tid.so
```
3. 保存退出`Ctrl+O` 回车,`Ctrl+X`。以后在终端运行 `sudo` 命令时就会先提示 Touch ID,仍可随时改为输入密码
3. 保存退出`Ctrl+O` 回车,`Ctrl+X`。以后 `sudo` 会先提示 Touch ID。
---
## 需要更多帮助?
## 需要帮助?
- [GitHub 项目主页](https://github.com/tw93/mole)
- [提交问题反馈](https://github.com/tw93/mole/issues)
- [完整使用文档](./README.md)
- [GitHub 主页](https://github.com/tw93/mole)
- [提交问题](https://github.com/tw93/mole/issues)
- [完整文档](./README.md)
**祝你使用愉快!如果觉得有用,欢迎分享给朋友~**
有用的话分享给朋友吧~