stow/oh-my-zsh/.oh-my-zsh/plugins/brew/README.md

   1 # brew plugin
   2
   3 The plugin adds several aliases for common [brew](https://brew.sh) commands.
   4
   5 To use it, add `brew` to the plugins array of your zshrc file:
   6
   7 ```zsh
   8 plugins=(... brew)
   9 ```
  10
  11 ## Shellenv
  12
  13 If `brew` is not found in the PATH, this plugin will attempt to find it in common
  14 locations, and execute `brew shellenv` to set the environment appropriately.
  15 This plugin will also export `HOMEBREW_PREFIX="$(brew --prefix)"` if not previously
  16 defined for convenience.
  17
  18 ## Aliases
  19
  20 | Alias    | Command                               | Description                                                         |
  21 | -------- | ------------------------------------- | ------------------------------------------------------------------- |
  22 | `bcubc`  | `brew upgrade --cask && brew cleanup` | Update outdated casks, then run cleanup.                            |
  23 | `bcubo`  | `brew update && brew outdated --cask` | Update Homebrew data, then list outdated casks.                     |
  24 | `brewp`  | `brew pin`                            | Pin a specified formula so that it's not upgraded.                  |
  25 | `brews`  | `brew list -1`                        | List installed formulae or the installed files for a given formula. |
  26 | `brewsp` | `brew list --pinned`                  | List pinned formulae, or show the version of a given formula.       |
  27 | `bubc`   | `brew upgrade && brew cleanup`        | Upgrade outdated formulae and casks, then run cleanup.              |
  28 | `bubo`   | `brew update && brew outdated`        | Update Homebrew data, then list outdated formulae and casks.        |
  29 | `bubu`   | `bubo && bubc`                        | Do the last two operations above.                                   |
  30 | `buf`    | `brew upgrade --formula`              | Upgrade only formulas (not casks).                                  |
  31
  32 ## Completion
  33
  34 With the release of Homebrew 1.0, they decided to bundle the zsh completion as part of the
  35 brew installation, so we no longer ship it with the brew plugin; now it only has brew
  36 aliases. If you find that brew completion no longer works, make sure you have your Homebrew
  37 installation fully up to date.