1
0
mirror of https://github.com/tw93/Mole.git synced 2026-02-10 00:54:15 +00:00

Simpler documentation

This commit is contained in:
Tw93
2025-10-09 00:44:46 +08:00
parent a443e54376
commit 82309521f0

156
GUIDE.md
View File

@@ -27,54 +27,33 @@
**方法一:一键安装(推荐)**
1. **复制安装命令**
选中下面这行,按 `Command (⌘)` + `C` 复制:
复制下面命令,粘贴到终端,按回车:
```bash
curl -fsSL https://raw.githubusercontent.com/tw93/mole/main/install.sh | bash
```
```bash
curl -fsSL https://raw.githubusercontent.com/tw93/mole/main/install.sh | bash
```
2. **粘贴到终端**
- 按 `Command (⌘)` + `V` 粘贴
- 或者右键选择粘贴
3. **开始安装**
- 按回车
- 等几秒,自动安装
- 看到安装成功提示就好了
**方法二:通过 Homebrew 安装**
如果你装了 Homebrew用这个
**方法二Homebrew**
```bash
brew install tw93/tap/mole
```
> 什么是 HomebrewMac 软件管理工具。不知道的话用方法一
> 不知道 Homebrew 是什么就用方法一。只选一种方法装,别两种都用
>
> **注意:** 只选一种方法装,别两种都用,会冲突
>
> 安装时可能要验证管理员权限Touch ID 或输密码都行,输密码时不显示字符是正常的
> 安装时可能要验证权限,输密码时不显示字符是正常的
---
## 第三步:开始使用
1. **启动 Mole**
在终端输入并回车:
终端输入 `mo` 回车。找不到命令就试 `mole`
```bash
mo
```
找不到命令的话,试试 `mole`,功能一样。
2. **界面操作**
- `` `` 方向键选菜单
- `空格键` 选中/取消
- `回车键` 确认
- `q` 键退出
**操作方式:**
- `↑` `↓` 选菜单
- `空格` 选中/取消
- `回车` 确认
- `q` 退出
---
@@ -84,19 +63,19 @@ 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
```
只显示会删什么,不会真删。先看看再决定。
只显示会删什么,不会真删。
**白名单管理:**
@@ -104,7 +83,7 @@ mo clean --dry-run
mo clean --whitelist
```
选哪些缓存不删,比如开发工具的大型缓存
选哪些缓存不删。
**正式清理:**
@@ -112,7 +91,7 @@ mo clean --whitelist
mo clean
```
清理系统缓存、日志、临时文件等,释放空间。Mole 只删可重新生成的文件,放心用
清理系统缓存、日志、临时文件等。Mole 只删可重新生成的文件。
### 卸载应用
@@ -120,12 +99,17 @@ mo clean
mo uninstall
```
这个功能:
方向键选,空格标记,回车确认。连残留文件一起删。
- 显示所有已装应用
- 方向键选,空格标记,可多选
- 回车确认删除
- **连残留文件一起删**
### 磁盘空间分析
```bash
mo analyze
```
看哪些文件和文件夹占空间大。
**操作:** `↑` `↓` 选择、`回车` 进入、`←` 返回、`Delete` 删除、`q` 退出
### 查看帮助
@@ -133,92 +117,38 @@ mo uninstall
mo --help
```
查看所有命令。
### 磁盘空间分析 🆕
```bash
mo analyze
```
看哪些文件和文件夹占空间大,快速找到并清理。
**操作:**
- `` ``:选择
- `回车`:进入文件夹/预览文件
- ``:返回上级
- `Delete`:删除
- `q`:退出
> 需要权限时先试 Touch ID不支持再输密码。
**提示:**
- 文件夹按大小排序
- 文本文件直接预览,其他用默认应用打开
- 超过 15 项自动分页
---
## 第五步:注意事项
### 使用建议
**推荐:** 每月清理一次,或磁盘快满时
**推荐:** 定期清理,每月一次或磁盘快满时
**避免:** 频繁清理,或运行重要程序时清理
**避免:** 频繁清理,或在运行重要程序时清理
### 安全保障
Mole 只删缓存和日志,不碰这些:
- 应用配置
- 应用数据
- 系统文件
- IDE 数据
- 数据库
**安全:** Mole 只删缓存和日志,不碰应用配置、应用数据、系统文件、数据库
---
## 常见问题
### 为什么输密码看不到字符?
**输密码看不到字符?** 终端安全设计,直接输完按回车。
Mac 终端安全设计,直接输完按回车就行
**安装失败?** 检查网络,重新跑命令,还不行去 [GitHub Issues](https://github.com/tw93/mole/issues) 问
### 安装失败怎么办?
1. 检查网络
2. 重新跑安装命令
3. 还不行去 [GitHub Issues](https://github.com/tw93/mole/issues) 问
### 清理相关
**清理后能恢复吗?** 不用恢复。Mole 只删缓存和日志,应用会自动重新生成。注意:应用卸载后无法恢复。
**清理后能恢复吗?** 不用恢复。Mole 只删缓存和日志,应用会自动重新生成。应用卸载后无法恢复。
**多久清理一次?** 每月一次,或磁盘快满时。
### 如何更新和卸载 Mole
**怎么更新?** `mo update`
**更新:** `mo update`Homebrew 装的会自动 `brew update && brew upgrade mole`
**怎么卸载?** `mo remove`
**卸载:** `mo remove`,自动识别安装方式,清理所有文件
**支持 Touch ID 吗?** Mole 用 `sudo` 请求权限,如果你给 `sudo` 启用了 Touch ID 就能用。
### Mole 支持 Touch ID 吗?
Mole 用 `sudo` 请求权限,默认输密码。如果你给 `sudo` 启用了 Touch ID可以直接按指纹失败再输密码。
### 如何让命令行支持 Touch ID
1. 打开配置:`sudo nano /etc/pam.d/sudo`
2. 在顶部注释下加:
```txt
auth sufficient pam_tid.so
```
3. 保存退出:`Ctrl+O` 回车,`Ctrl+X`。以后 `sudo` 会先提示 Touch ID。
**如何启用 Touch ID**
1. `sudo nano /etc/pam.d/sudo`
2. 在顶部注释下加 `auth sufficient pam_tid.so`
3. `Ctrl+O` 回车,`Ctrl+X` 退出
---