2018-10-02 06:10:03 +00:00
|
|
|
# brew plugin
|
|
|
|
|
|
|
|
|
|
The plugin adds several aliases for common [brew](https://brew.sh) commands.
|
|
|
|
|
|
|
|
|
|
To use it, add `brew` to the plugins array of your zshrc file:
|
2020-05-26 15:36:55 +00:00
|
|
|
|
|
|
|
|
```zsh
|
2018-10-02 06:10:03 +00:00
|
|
|
plugins=(... brew)
|
|
|
|
|
```
|
|
|
|
|
|
2022-07-12 16:40:39 +00:00
|
|
|
## Shellenv
|
|
|
|
|
|
2023-09-13 08:48:16 +00:00
|
|
|
If `brew` is not found in the PATH, this plugin will attempt to find it in common locations, and execute
|
|
|
|
|
`brew shellenv` to set the environment appropriately. This plugin will also export
|
|
|
|
|
`HOMEBREW_PREFIX="$(brew --prefix)"` if not previously defined for convenience.
|
|
|
|
|
|
|
|
|
|
In case you installed `brew` in a non-common location, you can still set `BREW_LOCATION` variable pointing to
|
|
|
|
|
the `brew` binary before sourcing `oh-my-zsh.sh` and it'll set up the environment.
|
2022-07-12 16:40:39 +00:00
|
|
|
|
2018-10-02 06:10:03 +00:00
|
|
|
## Aliases
|
|
|
|
|
|
2021-09-24 20:12:45 +00:00
|
|
|
| Alias | Command | Description |
|
|
|
|
|
| -------- | --------------------------------------- | --------------------------------------------------------------------- |
|
|
|
|
|
| `bc` | `brew cleanup` | Run cleanup. |
|
|
|
|
|
| `bci` | `brew info --cask` | Display information about the given cask. |
|
|
|
|
|
| `bcin` | `brew install --cask` | Install the given cask. |
|
|
|
|
|
| `bcl` | `brew list --cask` | List installed casks. |
|
|
|
|
|
| `bco` | `brew outdated --cask` | Report all outdated casks. |
|
|
|
|
|
| `bcrin` | `brew reinstall --cask` | Reinstall the given cask. |
|
|
|
|
|
| `bcubc` | `brew upgrade --cask && brew cleanup` | Upgrade outdated casks, then run cleanup. |
|
|
|
|
|
| `bcubo` | `brew update && brew outdated --cask` | Update Homebrew data, then list outdated casks. |
|
|
|
|
|
| `bcup` | `brew upgrade --cask` | Upgrade all outdated casks. |
|
|
|
|
|
| `bfu` | `brew upgrade --formula` | Upgrade only formulas (not casks). |
|
2022-02-07 08:26:12 +00:00
|
|
|
| `bi` | `brew install` | Install a formula. |
|
2021-09-24 20:12:45 +00:00
|
|
|
| `bl` | `brew list` | List all installed formulae. |
|
|
|
|
|
| `bo` | `brew outdated` | List installed formulae that have an updated version available. |
|
|
|
|
|
| `brewp` | `brew pin` | Pin a specified formula so that it's not upgraded. |
|
|
|
|
|
| `brews` | `brew list -1` | List installed formulae or the installed files for a given formula. |
|
|
|
|
|
| `brewsp` | `brew list --pinned` | List pinned formulae, or show the version of a given formula. |
|
|
|
|
|
| `bsl` | `brew services list` | List all running services. |
|
|
|
|
|
| `bsoff` | `brew services stop` | Stop the service and unregister it from launching at login (or boot). |
|
|
|
|
|
| `bsoffa` | `bsoff --all` | Stop all started services. |
|
|
|
|
|
| `bson` | `brew services start` | Start the service and register it to launch at login (or boot). |
|
|
|
|
|
| `bsona` | `bson --all` | Start all stopped services. |
|
|
|
|
|
| `bsr` | `brew services run` | Run the service without registering to launch at login (or boot). |
|
|
|
|
|
| `bsra` | `bsr --all` | Run all stopped services. |
|
|
|
|
|
| `bu` | `brew update` | Update brew and all installed formulae. |
|
|
|
|
|
| `bubc` | `brew upgrade && brew cleanup` | Upgrade outdated formulae and casks, then run cleanup. |
|
|
|
|
|
| `bubo` | `brew update && brew outdated` | Update Homebrew data, then list outdated formulae and casks. |
|
|
|
|
|
| `bubu` | `bubo && bup` | Do the last two operations above. |
|
|
|
|
|
| `bugbc` | `brew upgrade --greedy && brew cleanup` | Upgrade outdated formulae and casks (greedy), then run cleanup. |
|
|
|
|
|
| `bup` | `brew upgrade` | Upgrade outdated, unpinned brews. |
|
|
|
|
|
| `buz` | `brew uninstall --zap` | Remove all files associated with a cask. |
|
2023-01-09 19:02:44 +00:00
|
|
|
|
2020-05-26 15:36:55 +00:00
|
|
|
## Completion
|
|
|
|
|
|
2023-09-13 08:48:16 +00:00
|
|
|
This plugin configures paths with Homebrew's completion functions automatically, so you don't need to do it
|
|
|
|
|
manually. See: https://docs.brew.sh/Shell-Completion#configuring-completions-in-zsh.
|
2023-06-15 09:01:02 +00:00
|
|
|
|
2023-09-13 08:48:16 +00:00
|
|
|
With the release of Homebrew 1.0, they decided to bundle the zsh completion as part of the brew installation,
|
|
|
|
|
so we no longer ship it with the brew plugin; now it only has brew aliases. If you find that brew completion
|
|
|
|
|
no longer works, make sure you have your Homebrew installation fully up to date.
|
