npkill 使用指南
npkill 是一个高效的命令行工具，专为 Node.js 开发者设计，用于快速扫描和删除项目中的 node_modules 目录，帮助释放磁盘空间。它提供交互式界面，让用户安全地选择并删除冗余依赖。本指南将一步步引导您掌握其使用，确保操作简单可靠。
1. 工具简介
npkill 的核心功能是扫描指定路径下的所有 node_modules 文件夹，并以交互方式展示其大小和路径。用户可标记并删除不需要的依赖，从而优化磁盘使用。它特别适合处理多个项目积累的依赖问题，避免手动删除的繁琐和风险。
2. 应用场景
- 🧹 磁盘空间清理：当多个 Node.js 项目积累大量依赖时，单个
node_modules可能占用数百 MB 至数 GB 空间。npkill 可快速列出所有项目依赖大小，帮助选择性删除。 - ⚡ 多项目管理：在维护多个前端或 Node.js 项目时，工具支持批量操作（如按空格选择），并允许设置扫描深度（例如
npkill --depth=3）。删除后实时显示释放的空间量（如Saved: X.XX GB）。 - 🔄 依赖重置：当依赖安装异常或需要强制更新时，npkill 比手动删除更安全高效。它仅针对
node_modules，避免误删源码，可配合npm install --force实现彻底重建。 - 📊 空间分析：可视化查看依赖分布，帮助识别空间占用高的项目。
3. 安装方法
通过 npm 全局安装 npkill：
npm install -g npkill
安装完成后，您可以通过命令行直接调用工具。
4. 基础使用
- 扫描当前目录：在终端运行以下命令，npkill 会扫描当前工作目录下的所有
node_modules。npx npkill - 扫描指定目录：使用
-d或--directory参数指定路径。例如，扫描~/projects目录：npx npkill -d ~/projects
5. 交互界面操作
运行命令后，会出现交互界面：
? Select node_modules to remove: (Use arrow keys)
4.5GB ── /projects/react-app/node_modules
2.1GB ── /projects/nextjs-blog/node_modules
1.7GB ── /projects/express-api/node_modules
- 键盘操作指南：
↑/↓：上下移动光标，选择目录。空格：标记或取消标记目录进行删除。回车：确认删除所有标记项。Ctrl+C：退出工具，不执行任何操作。
6. 常用参数
npkill 提供多个参数优化扫描和输出：
| 参数 | 作用 |
|---|---|
-d 或 --directory <path> | 指定扫描路径（如 -d /code） |
-s 或 --sort | 按大小排序输出（默认按路径排序） |
-e 或 --show-errors | 显示扫描过程中的错误信息 |
-C 或 --no-color | 禁用彩色输出 |
-f 或 --full | 显示完整路径（而非缩写） |
示例：扫描 /code 目录并按大小排序：
npx npkill -d /code -s
7. 删除保护机制
npkill 内置安全措施：
- 手动确认：删除前需按空格标记目录，再按回车确认，避免误操作。
- 目录保护：默认跳过包含
.git的目录（如 Git 仓库），防止误删重要文件。
8. 注意事项
为确保安全和效率：
- 备份重要项目：删除前，确保项目已提交到版本控制系统（如 Git）。
- 权限问题：在 macOS 或 Linux 系统，如果目录权限不足，可能需要添加
sudo（如sudo npx npkill）。 - 数据不可恢复：删除操作不可逆，谨慎标记和确认。
- 替代方案：对于小型项目，手动删除可能更快捷（如
rm -rf node_modules），但 npkill 更适合批量处理。
9. 版本检查
运行以下命令查看 npkill 版本：
npx npkill -v
输出示例：0.8.1。建议定期更新工具以获取最新功能。
使用建议
定期运行 npkill（如每月一次），可显著释放磁盘空间。结合 npm cache clean --force 清理缓存，效果更佳。尤其适合拥有多个前端项目的开发者，能高效管理依赖并优化系统性能。开始清理前，请先测试在小范围项目上，确保熟悉操作流程。
