brew/manpages/brew.1

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BREW" "1" "March 2019" "Homebrew" "brew"
.
.SH "NAME"
\fBbrew\fR \- The missing package manager for macOS
.
.SH "SYNOPSIS"
\fBbrew\fR \fB\-\-version\fR
.
.br
\fBbrew\fR \fIcommand\fR [\fB\-\-verbose\fR|\fB\-v\fR] [\fIoptions\fR] [\fIformula\fR] \.\.\.
.
.SH "DESCRIPTION"
Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn\'t include with macOS\.
.
.SH "ESSENTIAL COMMANDS"
For the full command list, see the \fICOMMANDS\fR section\.
.
.P
With \fB\-\-verbose\fR or \fB\-v\fR, many commands print extra debugging information\. Note that these flags should only appear after a command\.
.
.SS "\fBinstall\fR \fIformula\fR:"
Install \fIformula\fR\.
.
.SS "\fBuninstall\fR \fIformula\fR:"
Uninstall \fIformula\fR\.
.
.SS "\fBlist\fR:"
List all installed formulae\.
.
.SS "\fBsearch\fR (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR):"
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\. If no search term is given, all locally available formulae are listed\.
.
.SH "COMMANDS"
.
.SS "\fBanalytics\fR (\fBon\fR|\fBoff\fR) [\fBstate\fR] [\fBregenerate\-uuid\fR]"
If \fBon\fR|\fBoff\fR is passed, turn Homebrew\'s analytics on or off respectively\.
.
.P
If \fBstate\fR is passed, display anonymous user behaviour analytics state\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
.
.P
If \fBregenerate\-uuid\fR is passed, regenerate UUID used in Homebrew\'s analytics\.
.
.SS "\fBcat\fR \fIformula\fR"
Display the source of \fIformula\fR\.
.
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
Remove stale lock files and outdated downloads for formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the specified formulae and casks\.
.
.TP
\fB\-\-prune\fR
Remove all cache files older than specified \fIdays\fR\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Show what would be removed, but do not actually remove anything\.
.
.TP
\fB\-s\fR
Scrub the cache, including downloads for even the latest versions\. Note downloads for any installed formula or cask will still not be deleted\. If you want to delete those too: \fBrm \-rf "$(brew \-\-cache)"\fR
.
.TP
\fB\-\-prune\-prefix\fR
Only prune the symlinks and directories from the prefix and remove no other files\.
.
.SS "\fBcommand\fR \fIcmd\fR"
Display the path to the file which is used when invoking \fBbrew\fR \fIcmd\fR\.
.
.SS "\fBcommands\fR [\fIoptions\fR]"
Show a list of built\-in and external commands\.
.
.TP
\fB\-\-include\-aliases\fR
Include the aliases of internal commands\.
.
.SS "\fBconfig\fR"
Show Homebrew and system configuration useful for debugging\. If you file a bug report, you will likely be asked for this information if you do not provide it\.
.
.SS "\fBdeps\fR [\fIoptions\fR] \fIformula\fR"
Show dependencies for \fIformula\fR\. When given multiple formula arguments, show the intersection of dependencies for \fIformula\fR\.
.
.TP
\fB\-\-1\fR
Only show dependencies one level down, instead of recursing\.
.
.TP
\fB\-n\fR
Show dependencies in topological order\.
.
.TP
\fB\-\-union\fR
Show the union of dependencies for \fIformula\fR, instead of the intersection\.
.
.TP
\fB\-\-full\-name\fR
List dependencies by their full name\.
.
.TP
\fB\-\-installed\fR
Only list those dependencies that are currently installed\.
.
.TP
\fB\-\-all\fR
List all the dependencies for all available formulae\.
.
.TP
\fB\-\-include\-build\fR
Show \fB:build\fR type dependencies for \fIformula\fR\.
.
.TP
\fB\-\-include\-optional\fR
Show \fB:optional\fR dependencies for \fIformula\fR\.
.
.TP
\fB\-\-include\-test\fR
Show \fB:test\fR dependencies for \fIformula\fR (non\-recursive)\.
.
.TP
\fB\-\-skip\-recommended\fR
Skip \fB:recommended\fR type dependencies for \fIformula\fR\.
.
.TP
\fB\-\-include\-requirements\fR
Include requirements in addition to dependencies for \fIformula\fR\.
.
.TP
\fB\-\-tree\fR
Show dependencies as a tree\. When given multiple formula arguments output individual trees for every formula\.
.
.TP
\fB\-\-annotate\fR
Mark any build, test, optional, or recommended dependencies as such in the output\.
.
.TP
\fB\-\-for\-each\fR
Switch into the mode used by \fBdeps \-\-all\fR, but only list dependencies for specified formula one specified formula per line\. This is used for debugging the \fB\-\-installed\fR/\fB\-\-all\fR display mode\.
.
.SS "\fBdesc\fR [\fIoptions\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR|\fIformula\fR)"
Display \fIformula\fR\'s name and one\-line description\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\.
.
.TP
\fB\-s\fR, \fB\-\-search\fR
Search both name and description for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.TP
\fB\-n\fR, \fB\-\-name\fR
Search just the names for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.TP
\fB\-d\fR, \fB\-\-description\fR
Search just the descriptions for provided \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.SS "\fBdiy\fR [\fIoptions\fR]"
Automatically determine the installation prefix for non\-Homebrew software\. Using the output from this command, you can install your own software into the Cellar and then link it into Homebrew\'s prefix with \fBbrew link\fR\.
.
.TP
\fB\-\-name\fR
Explicitly set the provided \fIname\fR of the package being installed\.
.
.TP
\fB\-\-version\fR
Explicitly set the provided \fIversion\fR of the package being installed\.
.
.SS "\fBdoctor\fR [\fIoptions\fR]"
Check your system for potential problems\. Doctor exits with a non\-zero status if any potential problems are found\. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue\. If everything you use Homebrew for is working fine: please don\'t worry or file an issue; just ignore this\.
.
.TP
\fB\-\-list\-checks\fR
List all audit methods\.
.
.TP
\fB\-D\fR, \fB\-\-audit\-debug\fR
Enable debugging and profiling of audit methods\.
.
.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR"
Download the source packages for the given \fIformula\fR\. For tarballs, also print SHA\-256 checksums\.
.
.TP
\fB\-\-HEAD\fR
Fetch HEAD version instead of stable version\.
.
.TP
\fB\-\-devel\fR
Fetch development version instead of stable version\.
.
.TP
\fB\-\-retry\fR
Retry if a download fails or re\-download if the checksum of a previously cached version no longer matches\.
.
.TP
\fB\-\-deps\fR
Download dependencies for any listed \fIformula\fR\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Download the source for rather than a bottle\.
.
.TP
\fB\-\-build\-bottle\fR
Download the source (for eventual bottling) rather than a bottle\.
.
.TP
\fB\-\-force\-bottle\fR
Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation\.
.
.SS "\fBgist\-logs\fR [\fIoptions\fR] \fIformula\fR"
Upload logs for a failed build of \fIformula\fR to a new Gist\.
.
.P
\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\.
.
.P
If no logs are found, an error message is presented\.
.
.TP
\fB\-\-with\-hostname\fR
Include the hostname in the Gist\.
.
.TP
\fB\-n\fR, \fB\-\-new\-issue\fR
Automatically create a new issue in the appropriate GitHub repository as well as creating the Gist\.
.
.TP
\fB\-p\fR, \fB\-\-private\fR
The Gist will be marked private and will not appear in listings but will be accessible with the link\.
.
.SS "\fBhome\fR [\fIformula\fR]"
Open \fIformula\fR\'s homepage in a browser\. If no formula is provided, open Homebrew\'s own homepage in a browser\.
.
.SS "\fBinfo\fR [\fIformula\fR]"
Display brief statistics for your Homebrew installation\.
.
.TP
\fB\-\-analytics\fR
Display Homebrew analytics data (provided neither \fBHOMEBREW_NO_ANALYTICS\fR or \fBHOMEBREW_NO_GITHUB_API\fR are set)\.
.
.TP
\fB\-\-days\fR
The value for \fBdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\.
.
.TP
\fB\-\-category\fR
The value for \fBcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR, \fBbuild\-error\fR or \fBos\-version\fR\. The default is \fBinstall\fR\.
.
.TP
\fB\-\-github\fR
Open a browser to the GitHub History page for provided \fIformula\fR\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR
.
.TP
\fB\-\-json\fR
Print a JSON representation of \fIformula\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.TP
\fB\-\-all\fR
Get information on all formulae\.
.
.TP
\fB\-\-installed\fR
Get information on all installed formulae\.
.
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR"
Install \fIformula\fR\.
.
.P
\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the installed formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-\-env\fR
If \fBstd\fR is passed, use the standard build environment instead of superenv\.If \fBsuper\fR is passed, use superenv even if the formula specifies the standard build environment\.
.
.TP
\fB\-\-ignore\-dependencies\fR
Skip installing any dependencies of any kind\. If they are not already present, the formula will probably fail to install\.
.
.TP
\fB\-\-only\-dependencies\fR
Install the dependencies with specified options but do not install the specified formula\.
.
.TP
\fB\-\-cc\fR
Attempt to compile using provided \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-7\fR for GCC 7\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew or bundled with macOS\. Please do not file issues if you encounter errors while using this flag\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.
.
.TP
\fB\-\-force\-bottle\fR
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\.
.
.TP
\fB\-\-include\-test\fR
Install testing dependencies required to run \fBbrew test\fR\.
.
.TP
\fB\-\-devel\fR
If \fIformula\fR defines it, install the development version\.
.
.TP
\fB\-\-HEAD\fR
If \fIformula\fR defines it, install the HEAD version, aka\. master, trunk, unstable\.
.
.TP
\fB\-\-fetch\-HEAD\fR
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or development version has been released\.
.
.TP
\fB\-\-keep\-tmp\fR
Don\'t delete the temporary files created during installation\.
.
.TP
\fB\-\-build\-bottle\fR
Prepare the formula for eventual bottling during installation\.
.
.TP
\fB\-\-bottle\-arch\fR
Optimise bottles for the given architecture rather than the oldest architecture supported by the version of macOS the bottles are built on\.
.
.TP
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
.
.TP
\fB\-i\fR, \fB\-\-interactive\fR
Download and patch \fIformula\fR, then open a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew package\.
.
.TP
\fB\-g\fR, \fB\-\-git\fR
Create a Git repository, useful for creating patches to the software\.
.
.SS "\fBleaves\fR"
Show installed formulae that are not dependencies of another installed formula\.
.
.SS "\fBln\fR, \fBlink\fR [\fIoptions\fR] \fIformula\fR"
Symlink all of \fIformula\fR\'s installed files into the Homebrew prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
.
.TP
\fB\-\-overwrite\fR
Delete files already existing in the prefix while linking\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List all files which would be linked or deleted by \fBbrew link \-\-overwrite\fR, but will not actually link or delete any files\.
.
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR]"
List all installed formulae\.
.
.TP
\fB\-\-full\-name\fR
Print formulae with fully\-qualified names\. If \fB\-\-full\-name\fR is not passed, other options (i\.e\. \fB\-1\fR, \fB\-l\fR, \fB\-t\fR and \fB\-r\fR) are passed to \fBls\fR which produces the actual output\.
.
.TP
\fB\-\-unbrewed\fR
List all files in the Homebrew prefix not installed by Homebrew\.
.
.TP
\fB\-\-versions\fR
Show the version number for installed formulae, or only the specified formulae if \fIformula\fR are given\.
.
.TP
\fB\-\-multiple\fR
Only show formulae with multiple versions installed\.
.
.TP
\fB\-\-pinned\fR
Show the versions of pinned formulae, or only the specified (pinned) formulae if \fIformula\fR are given\. See also \fBpin\fR, \fBunpin\fR\.
.
.TP
\fB\-1\fR
Force output to be one entry per line\. This is the default when output is not to a terminal\.
.
.TP
\fB\-l\fR
List in long format\. If the output is to a terminal, a total sum for all the file sizes is output on a line before the long listing\.
.
.TP
\fB\-r\fR
Reverse the order of the sort to get the oldest entries first\.
.
.TP
\fB\-t\fR
Sort by time modified (most recently modified first)\.
.
.SS "\fBlog\fR [\fIoptions\fR] \fIformula\fR"
Show the \fBgit log\fR for the given \fIformula\fR\.
.
.TP
\fB\-p\fR, \fB\-\-patch\fR
Also output patch from commit\.
.
.TP
\fB\-\-stat\fR
Also output diffstat from commit\.
.
.TP
\fB\-\-oneline\fR
Output only one line per commit\.
.
.TP
\fB\-1\fR, \fB\-\-max\-count\fR
Output only one commit\.
.
.SS "\fBmigrate\fR [\fIoptions\fR] \fIformula\fR"
Migrate renamed packages to new name, where \fIformula\fR are old names of packages\.
.
.SS "\fBmissing\fR [\fIoptions\fR] [\fIformule\fR]"
Check the given \fIformula\fR for missing dependencies\. If no \fIformula\fR are given, check all installed brews\.
.
.P
\fBmissing\fR exits with a non\-zero status if any formulae are missing dependencies\.
.
.TP
\fB\-\-hide\fR
Act as if none of the provided \fIhidden\fR are installed\. \fIhidden\fR should be comma\-separated list of formulae\.
.
.SS "\fBoptions\fR [\fIoptions\fR] \fIformula\fR"
Display install options specific to \fIformula\fR
.
.TP
\fB\-\-compact\fR
Show all options on a single line separated by spaces\.
.
.TP
\fB\-\-all\fR
Show options for all formulae\.
.
.TP
\fB\-\-installed\fR
Show options for all installed formulae\.
.
.SS "\fBoutdated\fR [\fIoptions\fR]"
Show formulae that have an updated version available\.
.
.P
By default, version information is displayed in interactive shells, and suppressed otherwise\.
.
.TP
\fB\-\-json\fR
Print output in JSON format\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.TP
\fB\-\-fetch\-HEAD\fR
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or development version has been released\.
.
.SS "\fBpin\fR \fIformula\fR"
Pin the specified \fIformula\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR \fIformula\fR command\. See also \fBunpin\fR\.
.
.SS "\fBpostinstall\fR \fIformula\fR"
Rerun the post\-install steps for \fIformula\fR\.
.
.SS "\fBreadall\fR [\fIoptions\fR] [\fItap\fR]"
Import all formulae from specified \fItap\fR (defaults to all installed taps)\. This can be useful for debugging issues across all formulae when making significant changes to \fBformula\.rb\fR, testing the performance of loading all formulae or to determine if any current formulae have Ruby issues\.
.
.TP
\fB\-\-aliases\fR
Verify any alias symlinks in each tap\.
.
.TP
\fB\-\-syntax\fR
Syntax\-check all of Homebrew\'s Ruby files\.
.
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR"
Uninstall and then install \fIformula\fR (with existing and any appended install options)\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the reinstalled formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
.
.TP
\fB\-\-force\-bottle\fR
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\.
.
.TP
\fB\-\-keep\-tmp\fR
Don\'t delete the temporary files created during installation\.
.
.TP
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
.
.SS "\fBsearch\fR [\fIoptions\fR] [\fItext\fR|\fB/\fR\fItext\fR\fB/\fR]"
Perform a substring search of cask tokens and formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to \fBhomebrew/core\fR and \fBhomebrew/cask\fR\.
.
.P
If no \fItext\fR is passed, display all locally available formulae (including tapped ones)\. No online search is performed\.
.
.TP
\fB\-\-casks\fR
Display all locally available casks (including tapped ones)\. No online search is performed\.
.
.TP
\fB\-\-desc\fR
search formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\.
.
.TP
\fB\-\-macports\fR
Search for \fItext\fR in the given package manager\'s list\.
.
.TP
\fB\-\-fink\fR
Search for \fItext\fR in the given package manager\'s list\.
.
.TP
\fB\-\-opensuse\fR
Search for \fItext\fR in the given package manager\'s list\.
.
.TP
\fB\-\-fedora\fR
Search for \fItext\fR in the given package manager\'s list\.
.
.TP
\fB\-\-debian\fR
Search for \fItext\fR in the given package manager\'s list\.
.
.TP
\fB\-\-ubuntu\fR
Search for \fItext\fR in the given package manager\'s list\.
.
.SS "\fBsh\fR [\fIoptions\fR]"
Start a Homebrew build environment shell\. Uses our years\-battle\-hardened Homebrew build logic to help your \fB\./configure && make && make install\fR or even your \fBgem install\fR succeed\. Especially handy if you run Homebrew in an Xcode\-only configuration since it adds tools like \fBmake\fR to your \fBPATH\fR which otherwise build systems would not find\.
.
.TP
\fB\-\-env\fR
Use the standard \fBPATH\fR instead of superenv\'s, when \fIstd\fR is passed
.
.SS "\fBshellenv\fR"
Prints export statements \- run them in a shell and this installation of Homebrew will be included into your \fBPATH\fR, \fBMANPATH\fR and \fBINFOPATH\fR\.
.
.P
\fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to save multiple queries of those variables\.
.
.P
Consider adding evaluating the output in your dotfiles (e\.g\. \fB~/\.profile\fR) with \fBeval $(brew shellenv)\fR
.
.SS "\fBstyle\fR [\fIoptions\fR] [\fIfile\fR|\fItap\fR|\fIformula\fR]"
Check formulae or files for conformance to Homebrew style guidelines\.
.
.P
Lists of \fIfile\fR, \fItap\fR and \fIformula\fR may not be combined\. If none are provided, \fBstyle\fR will run style checks on the whole Homebrew library, including core code and all formulae\.
.
.TP
\fB\-\-fix\fR
Fix style violations automatically using RuboCop\'s auto\-correct feature\.
.
.TP
\fB\-\-display\-cop\-names\fR
Include the RuboCop cop name for each violation in the output\.
.
.TP
\fB\-\-only\-cops\fR
Specify a comma\-separated \fIcops\fR list to check for violations of only the listed RuboCop cops\.
.
.TP
\fB\-\-except\-cops\fR
Specify a comma\-separated \fIcops\fR list to skip checking for violations of the listed RuboCop cops\.
.
.SS "\fBswitch\fR \fIformula\fR \fIversion\fR"
Symlink all of the specific \fIversion\fR of \fIformula\fR\'s install to Homebrew prefix\.
.
.SS "\fBtap\fR [\fIoptions\fR] \fIuser\fR\fB/\fR\fIrepo\fR [\fIURL\fR]"
Tap a formula repository\.
.
.P
List all installed taps when no arguments are passed\.
.
.P
With \fIURL\fR unspecified, taps a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBbrew tap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fBhttps://github\.com/\fR\fIuser\fR\fB/homebrew\-\fR\fIrepo\fR\.
.
.P
With \fIURL\fR specified, taps a formula repository from anywhere, using any transport protocol that \fBgit\fR handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\., SSH, GIT, HTTP, FTP(S), RSYNC\.
.
.TP
\fB\-\-full\fR
Use a full clone when tapping a repository\. By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR)\. To convert a shallow copy to a full copy, you can retap passing \fB\-\-full\fR without first untapping\.
.
.TP
\fB\-\-force\-auto\-update\fR
Auto\-update tap even if it is not hosted on GitHub\. By default, only taps hosted on GitHub are auto\-updated (for performance reasons)\.
.
.TP
\fB\-\-repair\fR
Migrate tapped formulae from symlink\-based to directory\-based structure\.
.
.TP
\fB\-\-list\-pinned\fR
List all pinned taps\.
.
.TP
\fB\-q\fR, \fB\-\-quieter\fR
Suppress any warnings\.
.
.SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR]"
Display detailed information about one or more provided \fItap\fR\. Display a brief summary of all installed taps if no \fItap\fR are passed\.
.
.TP
\fB\-\-installed\fR
Display information on all installed taps\.
.
.TP
\fB\-\-json\fR
Print a JSON representation of \fItaps\fR\. Currently the default and only accepted value for \fIversion\fR is \fBv1\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.SS "\fBtap\-pin\fR \fItap\fR"
Pin \fItap\fR, prioritising its formulae over core when formula names are supplied by the user\. See also \fBtap\-unpin\fR\.
.
.SS "\fBtap\-unpin\fR \fItap\fR"
Unpin \fItap\fR so its formulae are no longer prioritised\. See also \fBtap\-pin\fR\.
.
.SS "\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fIoptions\fR] \fIformula\fR"
Uninstall \fIformula\fR\.
.
.TP
\fB\-\-ignore\-dependencies\fR
Don\'t fail uninstall, even if \fIformula\fR is a dependency of any installed formulae\.
.
.SS "\fBunlink\fR [\fIoptions\fR] \fIformula\fR"
Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink\fR \fIformula\fR \fB&&\fR \fIcommands\fR \fB&& brew link\fR \fIformula\fR
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List all files which would be unlinked, but will not actually unlink or delete any files\.
.
.SS "\fBunpack\fR [\fIoptions\fR] \fIformula\fR"
Unpack the source files for \fIformula\fR into subdirectories of the current working directory\.
.
.TP
\fB\-\-destdir\fR
Create subdirectories in the directory named by \fIpath\fR instead\.
.
.TP
\fB\-\-patch\fR
Patches for \fIformula\fR will be applied to the unpacked source\.
.
.TP
\fB\-g\fR, \fB\-\-git\fR
Initialise a Git repository in the unpacked source\. This is useful for creating patches for the software\.
.
.SS "\fBunpin\fR \fIformula\fR"
Unpin \fIformula\fR, allowing them to be upgraded by \fBbrew upgrade\fR \fIformula\fR\. See also \fBpin\fR\.
.
.SS "\fBuntap\fR \fItap\fR"
Remove a tapped repository\.
.
.SS "\fBupdate\fR [\fIoptions\fR]"
Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1) and perform any necessary migrations\.
.
.TP
\fB\-\-merge\fR
\fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\.
.
.TP
\fB\-\-force\fR
Always do a slower, full update check (even if unnecessary)\.
.
.SS "\fBupdate\-reset\fR [\fIrepository\fR]"
Fetches and resets Homebrew and all tap repositories (or any specified \fBrepository\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\. Note this will destroy all your uncommitted or committed changes\.
.
.SS "\fBupgrade\fR [\fIoptions\fR] \fIformula\fR"
Upgrade outdated, unpinned brews (with existing and any appended install options)\.
.
.P
If \fIformula\fR are given, upgrade only the specified brews (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the upgraded formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
.
.TP
\fB\-\-force\-bottle\fR
Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation\.
.
.TP
\fB\-\-fetch\-HEAD\fR
Fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or development version has been released\.
.
.TP
\fB\-\-ignore\-pinned\fR
Set a 0 exit code even if pinned formulae are not upgraded\.
.
.TP
\fB\-\-keep\-tmp\fR
Don\'t delete the temporary files created during installation\.
.
.TP
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
.
.SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR"
Show the formulae that specify \fIformula\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\.
.
.P
By default, \fBuses\fR shows all formulae that specify \fIformula\fR as a required or recommended dependency\.
.
.P
By default, \fBuses\fR shows usage of \fIformula\fR by stable builds\.
.
.TP
\fB\-\-recursive\fR
Resolve more than one level of dependencies\.
.
.TP
\fB\-\-installed\fR
Only list installed formulae\.
.
.TP
\fB\-\-include\-build\fR
Include all formulae that specify \fIformula\fR as \fB:build\fR type dependency\.
.
.TP
\fB\-\-include\-test\fR
Include all formulae that specify \fIformula\fR as \fB:test\fR type dependency\.
.
.TP
\fB\-\-include\-optional\fR
Include all formulae that specify \fIformula\fR as \fB:optional\fR type dependency\.
.
.TP
\fB\-\-skip\-recommended\fR
Skip all formulae that specify \fIformula\fR as \fB:recommended\fR type dependency\.
.
.TP
\fB\-\-devel\fR
Show usage of \fIformula\fR by development build\.
.
.TP
\fB\-\-HEAD\fR
Show usage of \fIformula\fR by HEAD build\.
.
.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR]"
Display Homebrew\'s download cache\. See also \fBHOMEBREW_CACHE\fR\.
.
.P
If \fIformula\fR is provided, display the file or directory used to cache \fIformula\fR\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Show the cache file used when building from source\.
.
.TP
\fB\-\-force\-bottle\fR
Show the cache file used when pouring a bottle\.
.
.SS "\fB\-\-cache\fR [\fIformula\fR]"
Display Homebrew\'s Cellar path\. \fIDefault:\fR \fB$(brew \-\-prefix)/Cellar\fR, or if that directory doesn\'t exist, \fB$(brew \-\-repository)/Cellar\fR\.
.
.P
If \fIformula\fR is provided, display the location in the cellar where \fIformula\fR would be installed, without any sort of versioned directory as the last path\.
.
.SS "\fB\-\-env\fR [\fIoptions\fR]"
Show a summary of the Homebrew build environment as a plain list\.
.
.P
If the command\'s output is sent through a pipe and no shell is specified, the list is formatted for export to \fBbash\fR(1) unless \fB\-\-plain\fR is passed\.
.
.TP
\fB\-\-shell\fR
Generate a list of environment variables for the specified shell, or \fB\-\-shell=auto\fR to detect the current shell\.
.
.TP
\fB\-\-plain\fR
Plain output even when piped\.
.
.SS "\fB\-\-prefix\fR [\fIformula\fR]"
Display Homebrew\'s install path\. \fIDefault:\fR \fB/usr/local\fR on macOS and \fB/home/linuxbrew/\.linuxbrew\fR on Linux\.
.
.P
If \fIformula\fR is provided, display the location in the cellar where \fIformula\fR is or would be installed\.
.
.SS "\fB\-\-repository\fR [\fIuser\fR\fB/\fR\fIrepo\fR]"
Display where Homebrew\'s \fB\.git\fR directory is located\.
.
.P
If \fIuser\fR\fB/\fR\fIrepo\fR are provided, display where tap \fIuser\fR\fB/\fR\fIrepo\fR\'s directory is located\.
.
.SS "\fB\-\-version\fR"
Print the version number of Homebrew, Homebrew/homebrew\-core and Homebrew/homebrew\-cask (if tapped) to standard output and exit\.
.
.SH "DEVELOPER COMMANDS"
.
.SS "\fBaudit\fR [\fIoptions\fR] \fIformula\fR"
Check \fIformula\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. Will exit with a non\-zero status if any errors are found, which can be useful for implementing pre\-commit hooks\. If no \fIformula\fR are provided, all of them are checked\.
.
.TP
\fB\-\-strict\fR
Run additional style checks, including RuboCop style checks\.
.
.TP
\fB\-\-online\fR
Run additional slower style checks that require a network connection\.
.
.TP
\fB\-\-new\-formula\fR
Run various additional style checks to determine if a new formula is eligible for Homebrew\. This should be used when creating new formula and implies \fB\-\-strict\fR and \fB\-\-online\fR\.
.
.TP
\fB\-\-fix\fR
Fix style violations automatically using RuboCop\'s auto\-correct feature\.
.
.TP
\fB\-\-display\-cop\-names\fR
Include the RuboCop cop name for each violation in the output\.
.
.TP
\fB\-\-display\-filename\fR
Prefix every line of output with name of the file or formula being audited, to make output easy to grep\.
.
.TP
\fB\-D\fR, \fB\-\-audit\-debug\fR
Enable debugging and profiling of audit methods\.
.
.TP
\fB\-\-only\fR
Specify a comma\-separated \fImethod\fR list to only run the methods named \fBaudit_\fR\fImethod\fR\.
.
.TP
\fB\-\-except\fR
Specify a comma\-separated \fImethod\fR list to skip running the methods named \fBaudit_\fR\fImethod\fR\.
.
.TP
\fB\-\-only\-cops\fR
Specify a comma\-separated \fIcops\fR list to check for violations of only the listed RuboCop cops\.
.
.TP
\fB\-\-except\-cops\fR
Specify a comma\-separated \fIcops\fR list to skip checking for violations of the listed RuboCop cops\.
.
.SS "\fBbottle\fR [\fIoptions\fR] \fIformula\fR"
Generate a bottle (binary package) from a formula that was installed with \fB\-\-build\-bottle\fR\. If the formula specifies a rebuild version, it will be incremented in the generated DSL\. Passing \fB\-\-keep\-old\fR will attempt to keep it at its original value, while \fB\-\-no\-rebuild\fR will remove it\.
.
.TP
\fB\-\-skip\-relocation\fR
Do not check if the bottle can be marked as relocatable\.
.
.TP
\fB\-\-or\-later\fR
Append \fB_or_later\fR to the bottle tag\.
.
.TP
\fB\-\-force\-core\-tap\fR
Build a bottle even if \fIformula\fR is not in homebrew/core or any installed taps\.
.
.TP
\fB\-\-no\-rebuild\fR
If the formula specifies a rebuild version, remove it from the generated DSL\.
.
.TP
\fB\-\-keep\-old\fR
If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL\.
.
.TP
\fB\-\-json\fR
Write bottle information to a JSON file, which can be used as the argument for \fB\-\-merge\fR\.
.
.TP
\fB\-\-merge\fR
Generate an updated bottle block for a formula and optionally merge it into the formula file\. Instead of a formula name, requires a JSON file generated with \fBbrew bottle \-\-json\fR \fIformula\fR\.
.
.TP
\fB\-\-write\fR
Write the changes to the formula file\. A new commit will be generated unless \fB\-\-no\-commit\fR is passed\.
.
.TP
\fB\-\-no\-commit\fR
When passed with \fB\-\-write\fR, a new commit will not generated after writing changes to the formula file\.
.
.TP
\fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.SS "\fBbump\-formula\-pr\fR [\fIoptions\fR] [\fIformula\fR]"
Create a pull request to update a formula with a new URL or a new tag\.
.
.P
If a \fIURL\fR is specified, the \fISHA\-256\fR checksum of the new download should also be specified\. A best effort to determine the \fISHA\-256\fR and \fIformula\fR name will be made if either or both values are not supplied by the user\.
.
.P
If a \fItag\fR is specified, the Git commit \fIrevision\fR corresponding to that tag must also be specified\.
.
.P
\fINote:\fR this command cannot be used to transition a formula from a URL\-and\-SHA\-256 style specification into a tag\-and\-revision style specification, nor vice versa\. It must use whichever style specification the preexisting formula already uses\.
.
.TP
\fB\-\-devel\fR
Bump the development rather than stable version\. The development spec must already exist\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Print what would be done rather than doing it\.
.
.TP
\fB\-\-write\fR
When passed along with \fB\-\-dry\-run\fR, perform a not\-so\-dry run by making the expected file modifications but not taking any Git actions\.
.
.TP
\fB\-\-no\-audit\fR
Don\'t run \fBbrew audit\fR before opening the PR\.
.
.TP
\fB\-\-strict\fR
Run \fBbrew audit \-\-strict\fR before opening the PR\.
.
.TP
\fB\-\-no\-browse\fR
Print the pull request URL instead of opening in a browser\.
.
.TP
\fB\-\-mirror\fR
Use the provided \fIURL\fR as a mirror URL\.
.
.TP
\fB\-\-version\fR
Use the provided \fIversion\fR to override the value parsed from the URL or tag\. Note that \fB\-\-version=0\fR can be used to delete an existing version override from a formula if it has become redundant\.
.
.TP
\fB\-\-message\fR
Append the provided \fImessage\fR to the default PR message\.
.
.TP
\fB\-\-url\fR
Specify the \fIURL\fR for the new download\. If a \fIURL\fR is specified, the \fISHA\-256\fR checksum of the new download should also be specified\.
.
.TP
\fB\-\-sha256\fR
Specify the \fISHA\-256\fR checksum of the new download\.
.
.TP
\fB\-\-tag\fR
Specify the new git commit \fItag\fR for the formula\.
.
.TP
\fB\-\-revision\fR
Specify the new git commit \fIrevision\fR corresponding to a specified \fItag\fR\.
.
.SS "\fBcreate\fR [\fIoptions\fR] \fIURL\fR"
Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API, see: \fIhttp://www\.rubydoc\.info/github/Homebrew/brew/master/Formula\fR
.
.TP
\fB\-\-autotools\fR
Create a basic template for an Autotools\-style build\.
.
.TP
\fB\-\-cmake\fR
Create a basic template for a CMake\-style build\.
.
.TP
\fB\-\-meson\fR
Create a basic template for a Meson\-style build\.
.
.TP
\fB\-\-no\-fetch\fR
Homebrew will not download \fIURL\fR to the cache and will thus not add the SHA\-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage)\.
.
.TP
\fB\-\-HEAD\fR
Indicate that \fIURL\fR points to the package\'s repository rather than a file\.
.
.TP
\fB\-\-set\-name\fR
Set the name of the new formula to the provided \fIname\fR\.
.
.TP
\fB\-\-set\-version\fR
Set the version of the new formula to the provided \fIversion\fR\.
.
.TP
\fB\-\-tap\fR
Generate the new formula in the provided tap, specified as \fIuser\fR\fB/\fR\fIrepo\fR\.
.
.SS "\fBedit\fR [\fIformula\fR]"
Open a formula in the editor set by \fBEDITOR\fR or \fBHOMEBREW_EDITOR\fR, or open the Homebrew repository for editing if no \fIformula\fR is provided\.
.
.SS "\fBextract\fR [\fIoptions\fR] \fIformula\fR \fItap\fR"
Look through repository history to find the most recent version of \fIformula\fR and create a copy in \fItap\fR\fB/Formula/\fR\fIformula\fR\fB@\fR\fIversion\fR\fB\.rb\fR\. If the tap is not installed yet, attempt to install/clone the tap before continuing\.
.
.TP
\fB\-\-version\fR
Extract the provided \fIversion\fR of \fIformula\fR instead of the most recent\.
.
.SS "\fBformula\fR \fIformula\fR"
Display the path where a formula is located\.
.
.SS "\fBirb\fR [\fIoptions\fR]"
Enter the interactive Homebrew Ruby shell\.
.
.TP
\fB\-\-examples\fR
Show several examples\.
.
.TP
\fB\-\-pry\fR
Use Pry instead of IRB\. Implied if \fBHOMEBREW_PRY\fR is set\.
.
.SS "\fBlinkage\fR [\fIoptions\fR] [\fIformula\fR]"
Check the library links for kegs of installed formulae\. Raises an error if run on uninstalled formulae\.
.
.TP
\fB\-\-test\fR
Display only missing libraries and exit with a non\-zero status if any missing libraries are found\.
.
.TP
\fB\-\-reverse\fR
For every library that a keg references, print its dylib path followed by the binaries that link to it\.
.
.TP
\fB\-\-cached\fR
Print the cached linkage values stored in \fBHOMEBREW_CACHE\fR, set by a previous \fBbrew linkage\fR run\.
.
.SS "\fBman\fR [\fIoptions\fR]"
Generate Homebrew\'s manpages\.
.
.TP
\fB\-\-fail\-if\-changed\fR
Return a failing status code if changes are detected in the manpage outputs\. This can be used for CI to be notified when the manpages are out of date\. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date)\.
.
.TP
\fB\-\-link\fR
This is now done automatically by \fBbrew update\fR\.
.
.SS "\fBprof\fR \fIcommand\fR"
Run Homebrew with the Ruby profiler e\.g\. \fBbrew prof readall\fR\.
.
.SS "\fBpull\fR [\fIoptions\fR] \fIpatch\fR"
Get a patch from a GitHub commit or pull request and apply it to Homebrew\. Optionally, publish updated bottles for the formulae changed by the patch\.
.
.P
Each \fIpatch\fR may be the number of a PR in homebrew/core, the URL of a PR on GitHub, the URL of a commit on GitHub or a "https://jenkins\.brew\.sh/job/\.\.\." testing job URL\.
.
.TP
\fB\-\-bottle\fR
Handle bottles, pulling the bottle\-update commit and publishing files on Bintray\.
.
.TP
\fB\-\-bump\fR
For one\-formula PRs, automatically reword commit message to our preferred format\.
.
.TP
\fB\-\-clean\fR
Do not rewrite or otherwise modify the commits found in the pulled PR\.
.
.TP
\fB\-\-ignore\-whitespace\fR
Silently ignore whitespace discrepancies when applying diffs\.
.
.TP
\fB\-\-resolve\fR
When a patch fails to apply, leave in progress and allow user to resolve, instead of aborting\.
.
.TP
\fB\-\-branch\-okay\fR
Do not warn if pulling to a branch besides master (useful for testing)\.
.
.TP
\fB\-\-no\-pbcopy\fR
Do not copy anything to the system clipboard\.
.
.TP
\fB\-\-no\-publish\fR
Do not publish bottles to Bintray\.
.
.TP
\fB\-\-warn\-on\-publish\-failure\fR
Do not exit if there\'s a failure publishing bottles on Bintray\.
.
.TP
\fB\-\-bintray\-org\fR
Publish bottles at the provided Bintray \fIorganisation\fR\.
.
.TP
\fB\-\-test\-bot\-user\fR
Pull the bottle block commit from the provided \fIuser\fR on GitHub\.
.
.SS "\fBrelease\-notes\fR [\fIoptions\fR] [\fIprevious_tag\fR] [\fIend_ref\fR]"
Print the merged pull requests on Homebrew/brew between two Git refs\. If no \fIprevious_tag\fR is provided it defaults to the latest tag\. If no \fIend_ref\fR is provided it defaults to \fBorigin/master\fR\.
.
.TP
\fB\-\-markdown\fR
Print as a Markdown list\.
.
.SS "\fBruby\fR [\fB\-e\fR]:"
Run a Ruby instance with Homebrew\'s libraries loaded e\.g\. \fBbrew ruby \-e "puts :gcc\.f\.deps"\fR or \fBbrew ruby script\.rb\fR
.
.TP
\fB\-e\fR
Execute the provided string argument as a script\.
.
.SS "\fBtap\-new\fR \fIuser\fR\fB/\fR\fIrepo\fR"
Generate the template files for a new tap\.
.
.SS "\fBtest\fR [\fIoptions\fR] \fIformula\fR"
Run the test method provided by an installed formula\. There is no standard output or return code, but generally it should notify the user if something is wrong with the installed formula\.
.
.P
\fIExample:\fR \fBbrew install jruby && brew test jruby\fR
.
.TP
\fB\-\-devel\fR
Test the development version of a formula\.
.
.TP
\fB\-\-HEAD\fR
Test the head version of a formula\.
.
.TP
\fB\-\-keep\-tmp\fR
Keep the temporary files created for the test\.
.
.SS "\fBtests\fR [\fIoptions\fR]"
Run Homebrew\'s unit and integration tests\.
.
.TP
\fB\-\-coverage\fR
Generate code coverage reports\.
.
.TP
\fB\-\-generic\fR
Run only OS\-agnostic tests\.
.
.TP
\fB\-\-no\-compat\fR
Do not load the compatibility layer when running tests\.
.
.TP
\fB\-\-online\fR
Include tests that use the GitHub API and tests that use any of the taps for official external commands\.
.
.TP
\fB\-\-only\fR
Run only \fItest_script\fR\fB_spec\.rb\fR\. Appending \fB:\fR\fIline_number\fR will start at a specific line\.
.
.TP
\fB\-\-seed\fR
Randomise tests with the provided \fIvalue\fR instead of a random seed\.
.
.SS "\fBupdate\-test\fR [\fIoptions\fR]"
Run a test of \fBbrew update\fR with a new repository clone\. If no arguments are passed, use \fBorigin/master\fR as the start commit\.
.
.TP
\fB\-\-to\-tag\fR
Set \fBHOMEBREW_UPDATE_TO_TAG\fR to test updating between tags\.
.
.TP
\fB\-\-keep\-tmp\fR
Retain the temporary directory containing the new repository clone\.
.
.TP
\fB\-\-commit\fR
Use provided \fIcommit\fR as the start commit\.
.
.TP
\fB\-\-before\fR
Use the commit at provided \fIdate\fR as the start commit\.
.
.SS "\fBvendor\-gems\fR"
Install and commit Homebrew\'s vendored gems\.
.
.SH "GLOBAL OPTIONS"
These options are applicable across all sub\-commands\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Suppress any warnings\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Override warnings and enable potentially unsafe operations\.
.
.SH "OFFICIAL EXTERNAL COMMANDS"
.
.SS "\fBbundle\fR \fIsubcommand\fR:"
Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask and the Mac App Store\. See \fBbrew bundle \-\-help\fR\.
.
.P
\fBHomebrew/homebrew\-bundle\fR
    \fIhttps://github\.com/Homebrew/homebrew\-bundle\fR
.
.SS "\fBcask\fR \fIsubcommand\fR:"
Install macOS applications distributed as binaries\. See brew\-cask(1)\.
.
.P
\fBHomebrew/homebrew\-cask\fR
    \fIhttps://github\.com/Homebrew/homebrew\-cask\fR
.
.SS "\fBservices\fR \fIsubcommand\fR:"
Manage background services with macOS\' \fBlaunchctl\fR(1) daemon manager\. See \fBbrew services \-\-help\fR\.
.
.P
\fBHomebrew/homebrew\-services\fR
    \fIhttps://github\.com/Homebrew/homebrew\-services\fR
.
.SH "CUSTOM EXTERNAL COMMANDS"
Homebrew, like \fBgit\fR(1), supports external commands\. These are executable scripts that reside somewhere in the \fBPATH\fR, named \fBbrew\-\fR\fIcmdname\fR or \fBbrew\-\fR\fIcmdname\fR\fB\.rb\fR, which can be invoked like \fBbrew\fR \fIcmdname\fR\. This allows you to create your own commands without modifying Homebrew\'s internals\.
.
.P
Instructions for creating your own commands can be found in the docs: \fIhttps://docs\.brew\.sh/External\-Commands\fR
.
.SH "SPECIFYING FORMULAE"
Many Homebrew commands accept one or more \fIformula\fR arguments\. These arguments can take several different forms:
.
.TP
The name of a formula
e\.g\. \fBgit\fR, \fBnode\fR, \fBwget\fR\.
.
.TP
The fully\-qualified name of a tapped formula
Sometimes a formula from a tapped repository may conflict with one in \fBhomebrew/core\fR\. You can still access these formulae by using a special syntax, e\.g\. \fBhomebrew/dupes/vim\fR or \fBhomebrew/versions/node4\fR\.
.
.TP
An arbitrary file or URL
Homebrew can install formulae via URL, e\.g\. \fBhttps://raw\.githubusercontent\.com/Homebrew/homebrew\-core/master/Formula/git\.rb\fR, or from a local path\. It could point to either a formula file or a bottle\. In the case of a URL, the downloaded file will be cached for later use\.
.
.SH "ENVIRONMENT"
Note that environment variables must have a value set to be detected\. For example, \fBexport HOMEBREW_NO_INSECURE_REDIRECT=1\fR rather than just \fBexport HOMEBREW_NO_INSECURE_REDIRECT\fR\.
.
.TP
\fBHOMEBREW_ARTIFACT_DOMAIN\fR
If set, instructs Homebrew to prefix all download URLs, including those for bottles, with this variable\. For example, \fBHOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080\fR will cause a formula with the URL \fBhttps://example\.com/foo\.tar\.gz\fR to instead download from \fBhttp://localhost:8080/example\.com/foo\.tar\.gz\fR\.
.
.TP
\fBHOMEBREW_AUTO_UPDATE_SECS\fR
If set, Homebrew will only check for autoupdates once per this seconds interval\.
.
.IP
\fIDefault:\fR \fB60\fR\.
.
.TP
\fBHOMEBREW_AWS_ACCESS_KEY_ID\fR, \fBHOMEBREW_AWS_SECRET_ACCESS_KEY\fR
When using the \fBS3\fR download strategy, Homebrew will look in these variables for access credentials (see \fIhttps://docs\.aws\.amazon\.com/cli/latest/userguide/cli\-chap\-getting\-started\.html#cli\-environment\fR to retrieve these access credentials from AWS)\. If they are not set, the \fBS3\fR download strategy will download with a public (unsigned) URL\.
.
.TP
\fBHOMEBREW_BOTTLE_DOMAIN\fR
By default, Homebrew uses \fBhttps://homebrew\.bintray\.com/\fR as its download mirror for bottles\. If set, instructs Homebrew to instead use the specified URL\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fR will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fR\.
.
.TP
\fBHOMEBREW_BROWSER\fR
If set, Homebrew uses this setting as the browser when opening project homepages, instead of the OS default browser\.
.
.TP
\fBHOMEBREW_CACHE\fR
If set, instructs Homebrew to use the specified directory as the download cache\.
.
.IP
\fIDefault:\fR \fB~/Library/Caches/Homebrew\fR\.
.
.TP
\fBHOMEBREW_CURLRC\fR
If set, Homebrew will not pass \fB\-q\fR when invoking \fBcurl\fR(1) (which disables the use of \fBcurlrc\fR)\.
.
.TP
\fBHOMEBREW_CURL_VERBOSE\fR
If set, Homebrew will pass \fB\-\-verbose\fR when invoking \fBcurl\fR(1)\.
.
.TP
\fBHOMEBREW_DEBUG\fR
If set, any commands that can emit debugging information will do so\.
.
.TP
\fBHOMEBREW_DEVELOPER\fR
If set, Homebrew will tweak behaviour to be more relevant for Homebrew developers (active or budding), e\.g\. turning warnings into errors\.
.
.TP
\fBHOMEBREW_DISPLAY\fR
If set, Homebrew will use this X11 display when opening a page in a browser, for example with \fBbrew home\fR\. Primarily useful on Linux\.
.
.IP
\fIDefault:\fR the value of the user\'s \fBDISPLAY\fR environment variable\.
.
.TP
\fBHOMEBREW_EDITOR\fR
If set, Homebrew will use this editor when editing a single formula, or several formulae in the same directory\.
.
.IP
\fINote:\fR \fBbrew edit\fR will open all of Homebrew as discontinuous files and directories\. TextMate can handle this correctly in project mode, but many editors will do strange things in this case\.
.
.TP
\fBHOMEBREW_FORCE_BREWED_CURL\fR
If set, Homebrew will always use a Homebrew\-installed \fBcurl\fR rather than the system version\. Automatically set if the system version of \fBcurl\fR is too old\.
.
.TP
\fBHOMEBREW_FORCE_VENDOR_RUBY\fR
If set, Homebrew will always use its vendored, relocatable Ruby version even if the system version of Ruby is new enough\.
.
.TP
\fBHOMEBREW_FORCE_BREWED_GIT\fR
If set, Homebrew will always use a Homebrew\-installed \fBgit\fR rather than the system version\. Automatically set if the system version of \fBgit\fR is too old\.
.
.TP
\fBHOMEBREW_GITHUB_API_TOKEN\fR
A personal access token for the GitHub API, used by Homebrew for features such as \fBbrew search\fR\. You can create one at \fIhttps://github\.com/settings/tokens\fR\. If set, GitHub will allow you a greater number of API requests\. For more information, see: \fIhttps://developer\.github\.com/v3/#rate\-limiting\fR
.
.IP
\fINote:\fR Homebrew doesn\'t require permissions for any of the scopes\.
.
.TP
\fBHOMEBREW_INSTALL_BADGE\fR
Text printed before the installation summary of each successful build\.
.
.IP
\fIDefault:\fR the beer emoji\.
.
.TP
\fBHOMEBREW_LOGS\fR
If set, Homebrew will use the specified directory to store log files\.
.
.TP
\fBHOMEBREW_MAKE_JOBS\fR
If set, instructs Homebrew to use the value of \fBHOMEBREW_MAKE_JOBS\fR as the number of parallel jobs to run when building with \fBmake\fR(1)\.
.
.IP
\fIDefault:\fR the number of available CPU cores\.
.
.TP
\fBHOMEBREW_NO_ANALYTICS\fR
If set, Homebrew will not send analytics\. See: \fIhttps://docs\.brew\.sh/Analytics\fR
.
.TP
\fBHOMEBREW_NO_AUTO_UPDATE\fR
If set, Homebrew will not auto\-update before running \fBbrew install\fR, \fBbrew upgrade\fR or \fBbrew tap\fR\.
.
.TP
\fBHOMEBREW_NO_BOTTLE_SOURCE_FALLBACK\fR
If set, Homebrew will fail on the failure of installation from a bottle rather than falling back to building from source\.
.
.TP
\fBHOMEBREW_NO_COLOR\fR
If set, Homebrew will not print text with colour added\.
.
.TP
\fBHOMEBREW_NO_EMOJI\fR
If set, Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\.
.
.IP
\fINote:\fR Homebrew will only try to print emoji on OS X Lion or newer\.
.
.TP
\fBHOMEBREW_NO_INSECURE_REDIRECT\fR
If set, Homebrew will not permit redirects from secure HTTPS to insecure HTTP\.
.
.IP
While ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME based formulae to fail to download\.
.
.TP
\fBHOMEBREW_NO_GITHUB_API\fR
If set, Homebrew will not use the GitHub API, e\.g\. for searches or fetching relevant issues on a failed install\.
.
.TP
\fBHOMEBREW_NO_INSTALL_CLEANUP\fR
If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will never automatically cleanup the installed/upgraded/reinstalled formulae or all formulae every 30 days\.
.
.TP
\fBHOMEBREW_PRY\fR
If set, Homebrew will use Pry for the \fBbrew irb\fR command\.
.
.TP
\fBHOMEBREW_SVN\fR
When exporting from Subversion, Homebrew will use \fBHOMEBREW_SVN\fR if set, a Homebrew\-built Subversion if installed, or the system\-provided binary\.
.
.IP
Set this to force Homebrew to use a particular \fBsvn\fR binary\.
.
.TP
\fBHOMEBREW_TEMP\fR
If set, instructs Homebrew to use \fBHOMEBREW_TEMP\fR as the temporary directory for building packages\. This may be needed if your system temp directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist\.
.
.IP
This issue typically occurs when using FileVault or custom SSD configurations\.
.
.TP
\fBHOMEBREW_UPDATE_TO_TAG\fR
If set, instructs Homebrew to always use the latest stable tag (even if developer commands have been run)\.
.
.TP
\fBHOMEBREW_VERBOSE\fR
If set, Homebrew always assumes \fB\-\-verbose\fR when running commands\.
.
.TP
\fBhttp_proxy\fR
Sets the HTTP proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
.
.TP
\fBhttps_proxy\fR
Sets the HTTPS proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
.
.TP
\fBall_proxy\fR
Sets the SOCKS5 proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
.
.TP
\fBftp_proxy\fR
Sets the FTP proxy to be used by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
.
.TP
\fBno_proxy\fR
Sets the comma\-separated list of hostnames and domain names that should be excluded from proxying by \fBcurl\fR, \fBgit\fR and \fBsvn\fR when downloading through Homebrew\.
.
.SH "USING HOMEBREW BEHIND A PROXY"
Set the \fBhttp_proxy\fR, \fBhttps_proxy\fR, \fBall_proxy\fR, \fBftp_proxy\fR and/or \fBno_proxy\fR environment variables documented above\.
.
.P
For example, to use an unauthenticated HTTP or SOCKS5 proxy:
.
.IP "" 4
.
.nf

export http_proxy=http://$HOST:$PORT

export all_proxy=socks5://$HOST:$PORT
.
.fi
.
.IP "" 0
.
.P
And for an authenticated HTTP proxy:
.
.IP "" 4
.
.nf

export http_proxy=http://$USER:$PASSWORD@$HOST:$PORT
.
.fi
.
.IP "" 0
.
.SH "SEE ALSO"
Homebrew Documentation: \fIhttps://docs\.brew\.sh\fR
.
.P
\fBbrew\-cask\fR(1), \fBgit\fR(1), \fBgit\-log\fR(1)
.
.SH "AUTHORS"
Homebrew\'s Project Leader is Mike McQuaid\.
.
.P
Homebrew\'s Project Leadership Committee is Misty De Meo, Shaun Jackman, Jonathan Chang, Mike McQuaid and Markus Reiter\.
.
.P
Homebrew\'s Technical Steering Committee is Michka Popoff, FX Coudert, Markus Reiter, Misty De Meo and Mike McQuaid\.
.
.P
Homebrew/brew\'s Linux support (and Linuxbrew) maintainers are Michka Popoff and Shaun Jackman\.
.
.P
Homebrew\'s other current maintainers are Claudia Pellegrino, Chongyu Zhu, Vitor Galvao, Gautham Goli, Steven Peters, William Woodruff, Igor Kapkov, Izaak Beekman, Sean Molenaar, Jan Viljanen, Jason Tedor, Eric Knibbe, Viktor Szakats, Thierry Moisan, Steven Peters and Tom Schoonjans\.
.
.P
Former maintainers with significant contributions include JCount, commitay, Dominyk Tiller, Tim Smith, Baptiste Fontaine, Xu Cheng, Martin Afanasjew, Brett Koonce, Charlie Sharpsteen, Jack Nagel, Adam Vandenberg, Andrew Janke, Alex Dunn, neutric, Tomasz Pajor, Uladzislau Shablinski, Alyssa Ross, ilovezfs and Homebrew\'s creator: Max Howell\.
.
.SH "BUGS"
See our issues on GitHub:
.
.TP
\fBHomebrew/brew\fR
\fIhttps://github\.com/Homebrew/brew/issues\fR
.
.TP
\fBHomebrew/homebrew\-core\fR
\fIhttps://github\.com/Homebrew/homebrew\-core/issues\fR