unbrew/README.md

45 lines
1.4 KiB
Markdown
Raw Normal View History

2020-05-10 23:23:23 +00:00
# 🍺 unbrew
2020-08-01 19:11:00 +00:00
![NPM Version](https://img.shields.io/npm/v/unbrew)
![NPM Wekly Downloads](https://img.shields.io/npm/dm/unbrew)
![Dependecies](https://img.shields.io/david/cupcakearmy/unbrew)
2020-05-10 23:23:23 +00:00
The missing brew cleanup utility.
2020-06-02 07:53:10 +00:00
This is finally the easy way to **clean your forgotten packages and dependencies**.
2020-05-10 23:36:51 +00:00
2020-05-10 23:23:23 +00:00
![Demo Video](https://github.com/cupcakearmy/unbrew/raw/master/.github/demo.gif)
## 📦 Installation
### Single use
```
npx unbrew
```
### Permanent install
```
npm -g install unbrew
# or
yarn global add unbrew
```
```
# Run
unbrew
```
2020-05-10 23:36:51 +00:00
## ☁️ Motivation
2020-05-10 23:23:23 +00:00
Well... anyone that has been using brew in macOS for some time will have encountered the issue of doing a simple `brew list` and discovering loads of packages they have never heard of. Often this is the result of installing some packages that bring dependecies, but since brew does not uninstall them when you delete the package they came with, they will hang around for ever basically.
2020-05-10 23:36:51 +00:00
## 🤷‍♀️ How does it work?
It's actually pretty simple:
1. Check your leaves with `brew leaves`. This basically is a list of all the brew packages that are not required by another one. This means that only the packages you want to have installed + garbage will be a leave.
2. You select which leaves are relevant to you, everything gets deleted over and over again until only your packages and their dependencies are left.
3. We run also `brew cleanup` for good measure