Caveats Subcommand for Homebrew

What is it?

It's an external command for Homebrew that provides caveat descriptions for Homebrew formulae and casks.

This repository is an active fork of the original rafaelgarrido/homebrew-caveats, which is unmaintained. See rafaelgarrido/homebrew-caveats#10 for the rational behind this fork.

Most notably, this fork greatly simplifies the installation process for this subcommand.

Installation

Run the following command:

brew tap superatomic/caveats

Usage

To see caveats for a formula:

$ brew caveats redis
==> redis
To start redis now and restart at login:
  brew services start redis
Or, if you don't want/need a background service you can just run:
  /usr/local/opt/redis/bin/redis-server /usr/local/etc/redis.conf

This also works for casks:

$ brew caveats macfuse
==> macfuse
macfuse requires a kernel extension to work.
If the installation fails, retry after you enable it in:
  System Settings → Privacy & Security

For more information, refer to vendor documentation or this Apple Technical Note:
  https://developer.apple.com/library/content/technotes/tn2459/_index.html