Skip to content

Latest commit

 

History

History
180 lines (128 loc) · 7.6 KB

USAGE.md

File metadata and controls

180 lines (128 loc) · 7.6 KB
Raw

How to Use Homebrew Cask

Frequently Used Commands

Homebrew Cask is implemented as part of Homebrew. All Homebrew Cask commands begin with brew, which works for both casks and formulae. The most frequently-used commands are:

  • install --cask — installs the given cask.
  • uninstall --cask — uninstalls the given cask.
  • reinstall --cask — reinstalls the given cask.
  • list --cask — lists installed casks.

Searching for Casks

To search for casks, use brew search. Let’s see if there’s a cask for Mozilla Firefox:

$ brew search --cask firefox
==> Casks
firefox                      firefox@cn                   firefox@esr
firefox@beta                 firefox@developer-edition    firefox@nightly
Use `brew desc` to list packages with a short description.

Installing Casks

The command brew install --cask accepts one or multiple cask tokens. Let’s try to install Mozilla Firefox:

$ brew install --cask firefox
==> Downloading https://raw.githubusercontent.com/Homebrew/homebrew-cask/ba243ff8f7984a43088e0a1721e872cdd9ae7df0/Casks/f/firefox.rb
######################################################################## 100.0%
==> Downloading https://download-installer.cdn.mozilla.net/pub/firefox/releases/128.0/mac/en-US/Firefox%20128.0.dmg
######################################################################## 100.0%
==> Installing Cask firefox
==> Moving App 'Firefox.app' to '/Applications/Firefox.app'
==> Linking Binary 'firefox.wrapper.sh' to '/opt/homebrew/bin/firefox'
🍺  firefox was successfully installed!

Uninstalling Casks

Easy peasy:

$ brew uninstall --cask firefox

This will both uninstall the cask and remove the applications that were moved to /Applications.

Other Commands

Unless noted, these are run with --cask <cask_token> to apply to Homebrew Cask.

  • info — displays information about the given cask.
  • fetch — downloads remote application files for the given cask to the local cache (with --force, re-downloads even if already cached).
  • --cache — displays the expected path to Homebrew's local cache of application files.
  • doctor — checks for configuration issues (run with no arguments).
  • style — checks style for the given cask using RuboCop.
  • home — opens the homepage of the given cask; or, with no arguments, the Homebrew project page.
  • uninstall --zap — try to remove all files associated with a cask (may include resources shared with other applications).
  • outdated — lists all outdated casks (run with just --cask).
  • upgrade — updates all outdated casks (run with just --cask).

The following commands are for cask authors:

  • audit — verifies installability of casks.
  • cat — dumps the given cask to the standard output.
  • create --cask — creates a cask and opens it in an editor.
  • edit — edits the given cask.

The following aliases and abbreviations are provided for convenience:

  • ls — list
  • -S — search
  • rm, remove — uninstall
  • dr — doctor
  • abv — info
  • homepage — home

Tab Completion

Homebrew comes with bash, zsh and fish tab completion for the brew command. See brew Shell Completion for more information.

Inspecting Installed Casks

List staged files for an installed cask:

$ brew list --cask firefox
==> App
/Applications/Firefox.app (112 files, 360MB)

List all installed casks:

$ brew list --cask
firefox       google-chrome     opera

With --full-name, any external tap names will also be included, e.g.: purple/monkey/dishwasher for the cask dishwasher installed from the tap purple/monkey.

Show details about a specific cask:

$ brew info firefox
==> firefox: 128.0 (auto_updates)
https://www.mozilla.org/firefox/
Not installed
From: https://github.com/Homebrew/homebrew-cask/blob/HEAD/Casks/f/firefox.rb
==> Name
Mozilla Firefox
==> Description
Web browser
==> Languages
af, ar, be, bg, bn, ca, cs, de, en-CA, en-GB, en, eo, es-AR, es-CL, es-ES, fa, ff, fi, fr, gl, gn, gu, he, hi, in, it, ja, ka, ko, mr, my, ne, nl, pa-IN, pl, pt-BR, pt, ru, si, sq, sr, sv, ta, te, th, tl, tr, uk, ur, zh-TW, zh
==> Artifacts
Firefox.app (App)
/opt/homebrew/Caskroom/firefox/128.0/firefox.wrapper.sh -> firefox (Binary)

Updating/Upgrading Casks

Since the Homebrew Cask repository is a Homebrew tap, you’ll pull down the latest casks every time you issue the regular Homebrew command brew update. You can check for outdated casks with brew outdated and install the outdated casks with brew upgrade. Many applications update themselves, so their casks are ignored by brew outdated and brew upgrade. This behaviour can be overridden by adding --greedy to either command.

Updating/Upgrading Homebrew Cask

Homebrew automatically taps and keeps Homebrew Cask updated. brew update is all that is required.

Options

brew accepts a number of options:

  • --version: print version and exit.
  • --debug: output debug information.
  • --no-binaries: skip symlinking executable binaries into /opt/homebrew/bin.
  • --require-sha: abort installation of cask if no checksum is defined.
  • --no-quarantine: disable Apple’s quarantining for the specific app.
  • --language=<iso-language>[,<iso-language> ... ]: changes the language of the cask to be installed. The first matching language is used, otherwise it uses the default language of the cask.

You can also modify the default installation locations used when issuing brew install:

  • --appdir=/my/path changes the path where the applications will be moved. Default is /Applications.
  • --fontdir=/my/path changes the path for fonts. Default is ~/Library/Fonts.

See man brew for the other default installation locations and the flags to change them.

To make these settings persistent, you might want to add the following line to your .profile, .bash_profile or .zprofile:

# Specify your defaults in this environment variable
export HOMEBREW_CASK_OPTS="--appdir=~/Applications --fontdir=/Library/Fonts"

Note that you still can override the environment variable HOMEBREW_CASK_OPTS by explicitly providing options in the command line:

# Will force the Mozilla Firefox app to be moved to /Applications
# even though HOMEBREW_CASK_OPTS specified ~/Applications
brew install --appdir="/Applications" firefox

Other Ways to Specify a Cask

Most brew commands can accept a cask token as an argument. As described above, the token on the command line can take the form of:

  • A simple token, e.g.: firefox.
  • A fully-qualified token which includes the tap, e.g.: homebrew/cask/firefox.

brew also accepts three other forms as arguments:

  • A path to a cask file, e.g.: /opt/homebrew/Library/Taps/homebrew/homebrew-cask/Casks/f/firefox.rb.
  • A curl-retrievable URI to a cask file, e.g.: https://raw.githubusercontent.com/Homebrew/homebrew-cask/HEAD/Casks/f/firefox.rb.
  • A file in the current working directory, e.g.: my-modified-firefox.rb. Note that matching tapped cask tokens will be preferred over this form when there is a conflict. To force the use of a cask file in the current directory, specify a pathname with slashes, e.g.: ./firefox.rb.

The last three forms are intended for users who wish to maintain private casks.

Taps

You can add casks to your existing (or new) taps: just create a directory named Casks inside your tap, put your cask files there, and everything will just work.