Skip to content

Latest commit

 

History

History
221 lines (147 loc) · 7.14 KB

brew-cask.1.md

File metadata and controls

221 lines (147 loc) · 7.14 KB
Raw

homebrew-cask(1) -- A friendly binary installer for OS X

SYNOPSIS

brew cask command [options] [ ...]

DESCRIPTION

Homebrew-cask is a tool for installing precompiled OS X binaries (such as Applications) from the command line. The user is never required to use the graphical user interface.

ALPHA-QUALITY SOFTWARE

Homebrew-cask works robustly enough that we welcome new users, but the project is still in early development. That means command names, option names, and other aspects of this manual are still subject to change.

FREQUENTLY USED COMMANDS

  • install : Install .

  • uninstall : Uninstall .

  • search | //: Perform a substring search of Cask names for . If the text is delimited by slashes, it is interpreted as a Ruby regular expression.

    The Cask names returned by search are suitable as arguments for most other commands, such as install or uninstall.

COMMANDS

  • audit []: Check for installability. If no are given on the command line, all Casks are audited.

  • alfred: Modify Alfred's search scope to include the Caskroom directory where Applications are stored.

  • cat : Dump the given Cask definition file to the standard output.

  • checklinks: Check for bad Cask links.

  • cleanup [--outdated]: Clean up cached downloads and tracker symlinks. With --outdated, only clean up cached downloads older than 10 days old.

  • create : Generate a Cask definition file for the Cask named and open a template for it in your favorite editor.

  • doctor or dr: Check for configuration issues. Can be useful to upload as a gist for developers along with a bug report.

  • edit : Open the given Cask definition file for editing.

  • fetch [--force]: Fetch remote resources for the given Cask to the local cache. With --force, force re-download even if the resources are already cached.

  • home or homepage: Open the project page http://caskroom.io in a browser.

  • info or abv : Display information about .

  • install [--force] : Install .

    is usually the name of a Cask as returned by brew cask search, but see [OTHER WAYS TO SPECIFY A CASK][] for variations.

  • list or ls [-1 | -l] []: Without any arguments, list all installed Casks. With -1, always format the output in a single column. With -l, give a more detailed listing.

    If are given, list the installed files for .

  • uninstall or rm or remove : Uninstall .

  • search or -S: Display all Casks available for install.

  • search or -S | //: Perform a substring search of Cask names for . If the text is delimited by slashes, it is interpreted as a Ruby regular expression.

  • update: For convenience, brew cask update is a synonym for brew update.

OPTIONS

Some of these options (such as --prefpanedir) may be subject to removal in a future version.

  • --force: Force an install to proceed even when a previously-existing install is detected.

  • --caskroom=<path>: Location of the Caskroom, where all binaries are stored. The default value is: /opt/homebrew-cask/Caskroom.

  • --verbose: Give additional feedback during installation.

  • --appdir=<path>: Target location for Application links. The default value is ~/Applications.

  • --colorpickerdir=<path>: Target location for Color Picker links. The default value is ~/Library/Color Pickers.

  • --prefpanedir=<path>: Target location for Preference Pane links. The default value is ~/Library/Preference Panes.

  • --qlplugindir=<path>: Target location for QuickLook Plugin links. The default value is ~/Library/QuickLook.

  • --fontdir=<path>: Target location for Font links. The default value is ~/Library/Fonts.

  • --widgetdir=<path>: Target location for Dashboard Widget links. The default value is ~/Library/Widgets.

  • --servicedir=<path>: Target location for Service links. The default value is ~/Library/Services.

  • --input_methoddir=<path>: Target location for Input Method links. The default value is ~/Library/Input Methods.

  • --internet_plugindir=<path>: Target location for Internet Plugin links. The default value is ~/Library/Internet Plug-Ins.

  • --screen_saverdir=<path>: Target location for Screen Saver links. The default value is ~/Library/Screen Savers.

  • --no-binaries: Do not link "helper" executables to /usr/local/bin.

  • --binarydir=<path>: Target location for "helper" executable links. The default value is /usr/local/bin.

  • --debug: Output debugging information of use to Cask authors and developers.

INTERACTION WITH HOMEBREW

Homebrew-cask is implemented as a external command for Homebrew. That means this project is entirely built upon the Homebrew infrastructure. For example, upgrades to the Homebrew-cask tool are received through Homebrew: brew update && brew upgrade brew-cask && brew cleanup && brew cask cleanup

And updates to individual Cask definitions are received whenever you issue the Homebrew command: brew update

OTHER WAYS TO SPECIFY A CASK

Most homebrew-cask commands can accept a Cask name as an argument. As described above, a Cask name on the command line can take the form of:

  • A Cask name as returned by brew cask search, eg google-chrome

Homebrew-cask also accepts three other forms for Cask names:

  • A fully-qualified Cask name which includes the Tap name, eg caskroom/fonts/font-symbola

  • A fully-qualified pathname to a Cask file, eg /usr/local/Cellar/brew-cask/0.25.0/Casks/google-chrome.rb

  • A curl-retrievable URI to a Cask file, eg https://raw.github.com/caskroom/homebrew-cask/f54bbfaae0f2fa7210484f46313a459cb8a14d2f/Casks/google-chrome.rb

ENVIRONMENT

Homebrew-cask respects many of the environment variables used by the parent command brew. Please refer to the brew(1) man page for more information.

Environment variables specific to homebrew-cask:

  • HOMEBREW_CASK_OPTS: This variable may contain any arguments normally used as options on the command-line. Example: --appdir=/some/path/bar.

SEE ALSO

The homebrew-cask home page: http://caskroom.io.

The homebrew-cask GitHub page: https://github.com/caskroom/homebrew-cask.

Alfred.app: http://www.alfredapp.com

brew(1), curl(1)

AUTHORS

Paul Hinze and Contributors.

Man page format based on brew.1.md from Homebrew.

BUGS

We still have bugs -- and we are busy fixing them! If you have a problem, don't be shy about reporting it on our GitHub issues page.

When reporting bugs, remember that homebrew-cask is an independent project from Homebrew. Do your best to direct bug reports to the appropriate project. If your command-line started with brew cask, bring the bug to us first!