diff options
| author | Brian Mitchell <bman4789@gmail.com> | 2018-10-02 01:10:03 -0500 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-02 08:10:03 +0200 |
| commit | ca8c7bad1419b65ba4d64fbb838cad1f592cb539 (patch) | |
| tree | c3987a821c7aa808a5cee98fca5d4387e62bd1ab /plugins/brew/README.md | |
| parent | 40a60d2847ad89fe73b1057ab61f0d6af168da38 (diff) | |
| download | zsh-ca8c7bad1419b65ba4d64fbb838cad1f592cb539.tar.gz zsh-ca8c7bad1419b65ba4d64fbb838cad1f592cb539.tar.bz2 zsh-ca8c7bad1419b65ba4d64fbb838cad1f592cb539.zip | |
brew: add README (#7183)
Diffstat (limited to 'plugins/brew/README.md')
| -rw-r--r-- | plugins/brew/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/brew/README.md b/plugins/brew/README.md new file mode 100644 index 000000000..d50dfc219 --- /dev/null +++ b/plugins/brew/README.md @@ -0,0 +1,19 @@ +# 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: +``` +plugins=(... brew) +``` + +## Aliases + +| Alias | Command | Description | +|--------|----------------------|---------------| +| brewp | `brew pin` | Pin a specified formulae, preventing them from being upgraded when issuing the brew upgrade <formulae> command. | +| brews | `brew list -1` | List installed formulae, one entry per line, or the installed files for a given formulae. | +| brewsp | `brew list --pinned` | Show the versions of pinned formulae, or only the specified (pinned) formulae if formulae are given. | +| bubo | `brew update && brew outdated` | Fetch the newest version of Homebrew and all formulae, then list outdated formulae. | +| bubc | `brew upgrade && brew cleanup` | Upgrade outdated, unpinned brews (with existing install options), then removes stale lock files and outdated downloads for formulae and casks, and removes old versions of installed formulae. | +| bubo | `bubo && bubc` | Updates Homebrew, lists outdated formulae, upgrades oudated and unpinned formulae, and removes stale and outdated downloads and versions. | |