brew/manpages/brew.1

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BREW" "1" "January 2021" "Homebrew" "brew"
.
.SH "NAME"
\fBbrew\fR \- The Missing Package Manager for macOS (or Linux)
.
.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\. It can also install software not packaged for your Linux distribution to your home directory without requiring \fBsudo\fR\.
.
.SH "ESSENTIAL COMMANDS"
For the full command list, see the \fICOMMANDS\fR section\.
.
.P
With \fB\-\-verbose\fR or \fB\-\-debug\fR, many commands print extra debugging information\. Note that these options should only appear after a command\.
.
.SS "\fBinstall\fR \fIformula\fR"
Install \fIformula\fR\.
.
.P
\fIformula\fR is usually the name of the formula to install, but it has other syntaxes which are listed in the \fISPECIFYING FORMULAE\fR section\.
.
.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 flanked by slashes, 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 provided, all locally available formulae are listed\.
.
.SH "COMMANDS"
.
.SS "\fBanalytics\fR [\fIsubcommand\fR]"
Control Homebrew\'s anonymous aggregate user behaviour analytics\. Read more at \fIhttps://docs\.brew\.sh/Analytics\fR\.
.
.P
\fBbrew analytics\fR [\fBstate\fR]
    Display the current state of Homebrew\'s analytics\.
.
.P
\fBbrew analytics\fR (\fBon\fR|\fBoff\fR)
    Turn Homebrew\'s analytics on or off respectively\.
.
.P
\fBbrew analytics regenerate\-uuid\fR
    Regenerate the UUID used for Homebrew\'s analytics\.
.
.SS "\fBautoremove\fR [\fIoptions\fR]"
Uninstall formulae that were only installed as a dependency of another formula and are now no longer needed\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List what would be uninstalled, but do not actually uninstall anything\.
.
.SS "\fBcasks\fR"
List all locally installable casks including short names\.
.
.SS "\fBcleanup\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae\. If arguments are specified, only do this for the given formulae and casks\. Removes all downloads more than 120 days old\. This can be adjusted with \fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fR\.
.
.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 formulae or casks 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 "\fBcommands\fR [\fIoptions\fR]"
Show lists of built\-in and external commands\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
List only the names of commands without category headers\.
.
.TP
\fB\-\-include\-aliases\fR
Include aliases of internal commands\.
.
.SS "\fBconfig\fR"
Show Homebrew and system configuration info useful for debugging\. If you file a bug report, you will be required to provide this information\.
.
.SS "\fBdeps\fR [\fIoptions\fR] [\fIformula\fR]"
Show dependencies for \fIformula\fR\. Additional options specific to \fIformula\fR may be appended to the command\. When given multiple formula arguments, show the intersection of dependencies for each formula\.
.
.TP
\fB\-n\fR
Sort dependencies in topological order\.
.
.TP
\fB\-\-1\fR
Only show dependencies one level down, instead of recursing\.
.
.TP
\fB\-\-union\fR
Show the union of dependencies for multiple \fIformula\fR, instead of the intersection\.
.
.TP
\fB\-\-full\-name\fR
List dependencies by their full name\.
.
.TP
\fB\-\-include\-build\fR
Include \fB:build\fR dependencies for \fIformula\fR\.
.
.TP
\fB\-\-include\-optional\fR
Include \fB:optional\fR dependencies for \fIformula\fR\.
.
.TP
\fB\-\-include\-test\fR
Include \fB:test\fR dependencies for \fIformula\fR (non\-recursive)\.
.
.TP
\fB\-\-skip\-recommended\fR
Skip \fB:recommended\fR 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, show individual trees for each formula\.
.
.TP
\fB\-\-annotate\fR
Mark any build, test, optional, or recommended dependencies as such in the output\.
.
.TP
\fB\-\-installed\fR
List dependencies for formulae that are currently installed\. If \fIformula\fR is specified, list only its dependencies that are currently installed\.
.
.TP
\fB\-\-all\fR
List dependencies for all available formulae\.
.
.TP
\fB\-\-for\-each\fR
Switch into the mode used by the \fB\-\-all\fR option, but only list dependencies for each provided \fIformula\fR, one formula per line\. This is used for debugging the \fB\-\-installed\fR/\fB\-\-all\fR display mode\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.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 names and descriptions for \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 names for \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 descriptions for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\.
.
.SS "\fBdoctor\fR [\fIoptions\fR]"
Check your system for potential problems\. Will exit 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, which can be run individually if provided as arguments\.
.
.TP
\fB\-D\fR, \fB\-\-audit\-debug\fR
Enable debugging and profiling of audit methods\.
.
.SS "\fBfetch\fR [\fIoptions\fR] \fIformula\fR"
Download a bottle (if available) or source packages for \fIformula\fRe and binaries for \fIcask\fRs\. For files, also print SHA\-256 checksums\.
.
.TP
\fB\-\-HEAD\fR
Fetch HEAD version instead of stable version\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Remove a previously cached version and re\-fetch\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Do a verbose VCS checkout, if the URL represents a VCS\. This is useful for seeing if an existing VCS cache has been updated\.
.
.TP
\fB\-\-retry\fR
Retry if downloading fails or re\-download if the checksum of a previously cached version no longer matches\.
.
.TP
\fB\-\-deps\fR
Also download dependencies for any listed \fIformula\fR\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Download source packages rather than a bottle\.
.
.TP
\fB\-\-build\-bottle\fR
Download source packages (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\.
.
.TP
\fB\-\-[no\-]quarantine\fR
Disable/enable quarantining of downloads (default: enabled)\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBformulae\fR"
List all locally installable formulae including short names\.
.
.SS "\fBgist\-logs\fR [\fIoptions\fR] \fIformula\fR"
Upload logs for a failed build of \fIformula\fR to a new Gist\. Presents an error message if no logs are found\.
.
.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 after 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 its link\.
.
.SS "\fBhome\fR [\fIformula\fR|\fIcask\fR]"
Open a \fIformula\fR or \fIcask\fR\'s homepage in a browser, or open Homebrew\'s own homepage if no argument is provided\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBinfo\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
Display brief statistics for your Homebrew installation\.
.
.P
If a \fIformula\fR or \fIcask\fR is provided, show summary of information about it\.
.
.TP
\fB\-\-analytics\fR
List global Homebrew analytics data or, if specified, installation and build error data for \fIformula\fR (provided neither \fBHOMEBREW_NO_ANALYTICS\fR nor \fBHOMEBREW_NO_GITHUB_API\fR are set)\.
.
.TP
\fB\-\-days\fR
How many days of analytics data to retrieve\. The value for \fIdays\fR must be \fB30\fR, \fB90\fR or \fB365\fR\. The default is \fB30\fR\.
.
.TP
\fB\-\-category\fR
Which type of analytics data to retrieve\. The value for \fIcategory\fR must be \fBinstall\fR, \fBinstall\-on\-request\fR or \fBbuild\-error\fR; \fBcask\-install\fR or \fBos\-version\fR may be specified if \fIformula\fR is not\. The default is \fBinstall\fR\.
.
.TP
\fB\-\-github\fR
Open the GitHub source page for \fIformula\fR in a browser\. To view formula history locally: \fBbrew log \-p\fR \fIformula\fR
.
.TP
\fB\-\-json\fR
Print a JSON representation\. Currently the default value for \fIversion\fR is \fBv1\fR for \fIformula\fR\. For \fIformula\fR and \fIcask\fR use \fBv2\fR\. See the docs for examples of using the JSON output: \fIhttps://docs\.brew\.sh/Querying\-Brew\fR
.
.TP
\fB\-\-installed\fR
Print JSON of formulae that are currently installed\.
.
.TP
\fB\-\-all\fR
Print JSON of all available formulae\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Show more verbose analytics data for \fIformula\fR\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR"
Install a \fIformula\fR or \fIcask\fR\. Additional options specific to a \fIformula\fR may be appended to the command\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the installed formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Install formulae without checking for previously installed keg\-only or non\-migrated versions\. When installing casks, overwrite existing files (binaries and symlinks are excluded, unless originally from the same cask)\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print the verification and postinstall steps\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as 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
An unsupported Homebrew development flag to skip installing any dependencies of any kind\. If the dependencies are not already present, the formula will have issues\. If you\'re not developing Homebrew, consider adjusting your PATH rather than using this flag\.
.
.TP
\fB\-\-only\-dependencies\fR
Install the dependencies with specified options but do not install the formula itself\.
.
.TP
\fB\-\-cc\fR
Attempt to compile using the specified \fIcompiler\fR, which should be the name of the compiler\'s executable, e\.g\. \fBgcc\-7\fR for GCC 7\. In order to use LLVM\'s clang, specify \fBllvm_clang\fR\. To use the Apple\-provided clang, specify \fBclang\fR\. This option 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 option\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \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 \fIformula\fR\.
.
.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 only be checked for updates when a new stable or development version has been released\.
.
.TP
\fB\-\-keep\-tmp\fR
Retain the temporary files created during installation\.
.
.TP
\fB\-\-build\-bottle\fR
Prepare the formula for eventual bottling during installation, skipping any post\-install steps\.
.
.TP
\fB\-\-bottle\-arch\fR
Optimise bottles for the specified 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\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.TP
\fB\-\-[no\-]binaries\fR
Disable/enable linking of helper executables (default: enabled)\.
.
.TP
\fB\-\-require\-sha\fR
Require all casks to have a checksum\.
.
.TP
\fB\-\-[no\-]quarantine\fR
Disable/enable quarantining of downloads (default: enabled)\.
.
.TP
\fB\-\-skip\-cask\-deps\fR
Skip installing cask dependencies\.
.
.SS "\fBleaves\fR"
List installed formulae that are not dependencies of another installed formula\.
.
.SS "\fBlink\fR, \fBln\fR [\fIoptions\fR] \fIformula\fR"
Symlink all of \fIformula\fR\'s installed files into Homebrew\'s prefix\. This is done automatically when you install formulae but can be useful for DIY installations\.
.
.TP
\fB\-\-overwrite\fR
Delete files that already exist in the prefix while linking\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
List files which would be linked or deleted by \fBbrew link \-\-overwrite\fR without actually linking or deleting any files\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Allow keg\-only formulae to be linked\.
.
.SS "\fBlist\fR, \fBls\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
List all installed formulae and casks\.
.
.P
If \fIformula\fR is provided, summarise the paths within its current keg\. If \fIcask\fR is provided, list its artifacts\.
.
.TP
\fB\-\-formula\fR
List only formulae, or treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
List only casks, or treat all named arguments as casks\.
.
.TP
\fB\-\-full\-name\fR
Print formulae with fully\-qualified names\. Unless \fB\-\-full\-name\fR, \fB\-\-versions\fR or \fB\-\-pinned\fR are passed, other options (i\.e\. \fB\-1\fR, \fB\-l\fR, \fB\-r\fR and \fB\-t\fR) are passed to \fBls\fR(1) which produces the actual output\.
.
.TP
\fB\-\-versions\fR
Show the version number for installed formulae, or only the specified formulae if \fIformula\fR are provided\.
.
.TP
\fB\-\-multiple\fR
Only show formulae with multiple versions installed\.
.
.TP
\fB\-\-pinned\fR
List only pinned formulae, or only the specified (pinned) formulae if \fIformula\fR are provided\. 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 formulae in long format\.
.
.TP
\fB\-r\fR
Reverse the order of the formulae sort to list the oldest entries first\.
.
.TP
\fB\-t\fR
Sort formulae by time modified, listing most recently modified first\.
.
.SS "\fBlog\fR [\fIoptions\fR] [\fIformula\fR]"
Show the \fBgit log\fR for \fIformula\fR, or show the log for the Homebrew repository if no formula is provided\.
.
.TP
\fB\-p\fR, \fB\-\-patch\fR
Also print patch from commit\.
.
.TP
\fB\-\-stat\fR
Also print diffstat from commit\.
.
.TP
\fB\-\-oneline\fR
Print only one line per commit\.
.
.TP
\fB\-1\fR
Print only one commit\.
.
.TP
\fB\-n\fR, \fB\-\-max\-count\fR
Print only a specified number of commits\.
.
.SS "\fBmigrate\fR [\fIoptions\fR] \fIformula\fR"
Migrate renamed packages to new names, where \fIformula\fR are old names of packages\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Treat installed \fIformula\fR and provided \fIformula\fR as if they are from the same taps and migrate them anyway\.
.
.SS "\fBmissing\fR [\fIoptions\fR] [\fIformula\fR]"
Check the given \fIformula\fR kegs for missing dependencies\. If no \fIformula\fR are provided, check all kegs\. Will exit with a non\-zero status if any kegs are found to be missing dependencies\.
.
.TP
\fB\-\-hide\fR
Act as if none of the specified \fIhidden\fR are installed\. \fIhidden\fR should be a comma\-separated list of formulae\.
.
.SS "\fBoptions\fR [\fIoptions\fR] [\fIformula\fR]"
Show install options specific to \fIformula\fR\.
.
.TP
\fB\-\-compact\fR
Show all options on a single line separated by spaces\.
.
.TP
\fB\-\-installed\fR
Show options for formulae that are currently installed\.
.
.TP
\fB\-\-all\fR
Show options for all available formulae\.
.
.TP
\fB\-\-command\fR
Show options for the specified \fIcommand\fR\.
.
.SS "\fBoutdated\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
List installed casks and formulae that have an updated version available\. By default, version information is displayed in interactive shells, and suppressed otherwise\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
List only the names of outdated kegs (takes precedence over \fB\-\-verbose\fR)\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Include detailed version information\.
.
.TP
\fB\-\-formula\fR
List only outdated formulae\.
.
.TP
\fB\-\-cask\fR
List only outdated casks\.
.
.TP
\fB\-\-json\fR
Print output in JSON format\. There are two versions: v1 and v2\. v1 is deprecated and is currently the default if no version is specified\. v2 prints outdated formulae and casks\.
.
.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 only be checked for updates when a new stable or development version has been released\.
.
.TP
\fB\-\-greedy\fR
Print outdated casks with \fBauto_updates\fR or \fBversion :latest\fR\.
.
.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 items from the specified \fItap\fR, or from all installed taps if none is provided\. This can be useful for debugging issues across all items when making significant changes to \fBformula\.rb\fR, testing the performance of loading all items or checking if any current formulae/casks 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 (if no \fB<tap>\fR is passed)\.
.
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR"
Uninstall and then reinstall a \fIformula\fR or \fIcask\fR using the same options it was originally installed with, plus any appended options specific to a \fIformula\fR\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the reinstalled formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Install without checking for previously installed keg\-only or non\-migrated versions\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print the verification and postinstall steps\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
.
.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\-\-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
Retain the temporary files created during installation\.
.
.TP
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.TP
\fB\-\-[no\-]binaries\fR
Disable/enable linking of helper executables (default: enabled)\.
.
.TP
\fB\-\-require\-sha\fR
Require all casks to have a checksum\.
.
.TP
\fB\-\-[no\-]quarantine\fR
Disable/enable quarantining of downloads (default: enabled)\.
.
.TP
\fB\-\-skip\-cask\-deps\fR
Skip installing cask dependencies\.
.
.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 flanked by slashes, 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 provided, list all locally available formulae (including tapped ones)\. No online search is performed\.
.
.TP
\fB\-\-formula\fR
Without \fItext\fR, list all locally available formulae (no online search is performed)\. With \fItext\fR, search online and locally for formulae\.
.
.TP
\fB\-\-cask\fR
Without \fItext\fR, list all locally available casks (including tapped ones, no online search is performed)\. With \fItext\fR, search online and locally for casks\.
.
.TP
\fB\-\-desc\fR
Search for formulae with a description matching \fItext\fR and casks with a name matching \fItext\fR\.
.
.TP
\fB\-\-pull\-request\fR
Search for GitHub pull requests containing \fItext\fR\.
.
.TP
\fB\-\-open\fR
Search for only open GitHub pull requests
.
.TP
\fB\-\-closed\fR
Search for only closed GitHub pull requests
.
.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 "\fBshellenv\fR"
Print export statements\. When run in a shell, this installation of Homebrew will be added to your \fBPATH\fR, \fBMANPATH\fR, and \fBINFOPATH\fR\.
.
.P
The variables \fBHOMEBREW_PREFIX\fR, \fBHOMEBREW_CELLAR\fR and \fBHOMEBREW_REPOSITORY\fR are also exported to avoid querying them multiple times\. Consider adding evaluation of this command\'s output to your dotfiles (e\.g\. \fB~/\.profile\fR, \fB~/\.bash_profile\fR, or \fB~/\.zprofile\fR) with: \fBeval $(brew shellenv)\fR
.
.SS "\fBtap\fR [\fIoptions\fR] [\fIuser\fR\fB/\fR\fIrepo\fR] [\fIURL\fR]"
Tap a formula repository\.
.
.P
If no arguments are provided, list all installed taps\.
.
.P
With \fIURL\fR unspecified, tap 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, tap a formula repository from anywhere, using any transport protocol that \fBgit\fR(1) 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
Convert a shallow clone to a full clone without untapping\. Taps are only cloned as shallow clones if \fB\-\-shallow\fR was originally passed\.
.
.TP
\fB\-\-shallow\fR
Fetch tap as a shallow clone rather than a full clone\. Useful for continuous integration\.
.
.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\.
.
.SS "\fBtap\-info\fR [\fIoptions\fR] [\fItap\fR]"
Show detailed information about one or more \fItap\fRs\.
.
.P
If no \fItap\fR names are provided, display brief statistics for all installed taps\.
.
.TP
\fB\-\-installed\fR
Show information on each installed tap\.
.
.TP
\fB\-\-json\fR
Print a JSON representation of \fItap\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 "\fBuninstall\fR, \fBrm\fR, \fBremove\fR [\fIoptions\fR] \fIformula\fR|\fIcask\fR"
Uninstall a \fIformula\fR or \fIcask\fR\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Delete all installed versions of \fIformula\fR\. Uninstall even if \fIcask\fR is not installed, overwrite existing files and ignore errors when removing files\.
.
.TP
\fB\-\-zap\fR
Remove all files associated with a \fIcask\fR\. \fIMay remove files which are shared between applications\.\fR
.
.TP
\fB\-\-ignore\-dependencies\fR
Don\'t fail uninstall, even if \fIformula\fR is a dependency of any installed formulae\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBunlink\fR [\fIoptions\fR] \fIformula\fR"
Remove symlinks for \fIformula\fR from Homebrew\'s 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 files which would be unlinked without actually unlinking or deleting any files\.
.
.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 formula 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
Use \fBgit merge\fR to apply updates (rather than \fBgit rebase\fR)\.
.
.TP
\fB\-\-preinstall\fR
Run on auto\-updates (e\.g\. before \fBbrew install\fR)\. Skips some slower steps\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Always do a slower, full update check (even if unnecessary)\.
.
.SS "\fBupdate\-reset\fR [\fIrepository\fR]"
Fetch and reset Homebrew and all tap repositories (or any specified \fIrepository\fR) using \fBgit\fR(1) to their latest \fBorigin/master\fR\.
.
.P
\fINote:\fR this will destroy all your uncommitted or committed changes\.
.
.SS "\fBupgrade\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally installed with, plus any appended brew formula options\. If \fIcask\fR or \fIformula\fR are specified, upgrade only the given \fIcask\fR or \fIformula\fR kegs (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will then be run for the upgraded formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Install formulae without checking for previously installed keg\-only or non\-migrated versions\. When installing casks, overwrite existing files (binaries and symlinks are excluded, unless originally from the same cask)\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print the verification and postinstall steps\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Show what would be upgraded, but do not actually upgrade anything\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\. If no named arguments are specified, upgrade only outdated formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
.
.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\-\-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 only be checked for updates when a new stable or development version has been released\.
.
.TP
\fB\-\-ignore\-pinned\fR
Set a successful exit status even if pinned formulae are not upgraded\.
.
.TP
\fB\-\-keep\-tmp\fR
Retain the temporary files created during installation\.
.
.TP
\fB\-\-display\-times\fR
Print install times for each formula at the end of the run\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\. If no named arguments are specified, upgrade only outdated casks\.
.
.TP
\fB\-\-[no\-]binaries\fR
Disable/enable linking of helper executables (default: enabled)\.
.
.TP
\fB\-\-require\-sha\fR
Require all casks to have a checksum\.
.
.TP
\fB\-\-[no\-]quarantine\fR
Disable/enable quarantining of downloads (default: enabled)\.
.
.TP
\fB\-\-skip\-cask\-deps\fR
Skip installing cask dependencies\.
.
.TP
\fB\-\-greedy\fR
Also include casks with \fBauto_updates true\fR or \fBversion :latest\fR\.
.
.SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR"
Show formulae and casks that specify \fIformula\fR as a dependency (i\.e\. show dependents of \fIformula\fR)\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\. By default, \fBuses\fR shows all formulae and casks that specify \fIformula\fR as a required or recommended dependency for their stable builds\.
.
.TP
\fB\-\-recursive\fR
Resolve more than one level of dependencies\.
.
.TP
\fB\-\-installed\fR
Only list formulae and casks that are currently installed\.
.
.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\-\-formula\fR
Include only formulae\.
.
.TP
\fB\-\-cask\fR
Include only casks\.
.
.SS "\fB\-\-cache\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\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\.
.
.TP
\fB\-\-formula\fR
Only show cache files for formulae\.
.
.TP
\fB\-\-cask\fR
Only show cache files for casks\.
.
.SS "\fB\-\-caskroom\fR [\fIcask\fR]"
Display Homebrew\'s Caskroom path\.
.
.P
If \fIcask\fR is provided, display the location in the Caskroom where \fIcask\fR would be installed, without any sort of versioned directory as the last path\.
.
.SS "\fB\-\-cellar\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] [\fIformula\fR]"
Summarise Homebrew\'s 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
Generate plain output even when piped\.
.
.SS "\fB\-\-prefix\fR [\fIformula\fR]"
Display Homebrew\'s install path\. \fIDefault:\fR
.
.IP "\(bu" 4
macOS Intel: \fB/usr/local\fR
.
.IP "\(bu" 4
macOS ARM: \fB/opt/homebrew\fR
.
.IP "\(bu" 4
Linux: \fB/home/linuxbrew/\.linuxbrew\fR
.
.IP "" 0
.
.P
If \fIformula\fR is provided, display the location in the Cellar where \fIformula\fR is or would be installed\.
.
.TP
\fB\-\-unbrewed\fR
List files in Homebrew\'s prefix not installed by Homebrew\.
.
.SS "\fB\-\-repository\fR, \fB\-\-repo\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 numbers of Homebrew, Homebrew/homebrew\-core and Homebrew/homebrew\-cask (if tapped) to standard output\.
.
.SH "DEVELOPER COMMANDS"
.
.SS "\fBaudit\fR [\fIoptions\fR] [\fIformula\fR|\fIcask\fR]"
Check \fIformula\fR for Homebrew coding style violations\. This should be run before submitting a new formula or cask\. If no \fIformula\fR|\fIcask\fR are provided, check all locally available formulae and casks and skip style checks\. Will exit with a non\-zero status if any errors are found\.
.
.TP
\fB\-\-strict\fR
Run additional, stricter style checks\.
.
.TP
\fB\-\-git\fR
Run additional, slower style checks that navigate the Git repository\.
.
.TP
\fB\-\-online\fR
Run additional, slower style checks that require a network connection\.
.
.TP
\fB\-\-new\fR
Run various additional style checks to determine if a new formula or cask is eligible for Homebrew\. This should be used when creating new formula and implies \fB\-\-strict\fR and \fB\-\-online\fR\.
.
.TP
\fB\-\-tap\fR
Check the formulae within the given tap, specified as \fIuser\fR\fB/\fR\fIrepo\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 the file or formula name being audited, to make output easy to grep\.
.
.TP
\fB\-\-skip\-style\fR
Skip running non\-RuboCop style checks\. Useful if you plan on running \fBbrew style\fR separately\. Enabled by default unless a formula is specified by name\.
.
.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\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.TP
\fB\-\-[no\-]appcast\fR
Audit the appcast
.
.TP
\fB\-\-token\-conflicts\fR
Audit for token conflicts
.
.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\-\-force\-core\-tap\fR
Build a bottle even if \fIformula\fR is not in \fBhomebrew/core\fR 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 value 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 the path to a JSON file generated with \fBbrew bottle \-\-json\fR \fIformula\fR\.
.
.TP
\fB\-\-write\fR
Write 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\fR [\fIoptions\fR] [\fIformula\fR]"
Display out\-of\-date brew formulae and the latest version available\. Also displays whether a pull request has been opened with the URL\.
.
.TP
\fB\-\-limit\fR
Limit number of package results returned\.
.
.SS "\fBbump\-cask\-pr\fR [\fIoptions\fR] \fIcask\fR"
Create a pull request to update \fIcask\fR with a new version\.
.
.P
A best effort to determine the \fISHA\-256\fR will be made if the value is not supplied by the user\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Print what would be done rather than doing it\.
.
.TP
\fB\-\-write\fR
Make the expected file modifications without taking any Git actions\.
.
.TP
\fB\-\-commit\fR
When passed with \fB\-\-write\fR, generate a new commit after writing changes to the cask file\.
.
.TP
\fB\-\-no\-audit\fR
Don\'t run \fBbrew audit\fR before opening the PR\.
.
.TP
\fB\-\-online\fR
Run \fBbrew audit \-\-online\fR before opening the PR\.
.
.TP
\fB\-\-no\-style\fR
Don\'t run \fBbrew style \-\-fix\fR before opening the PR\.
.
.TP
\fB\-\-no\-browse\fR
Print the pull request URL instead of opening in a browser\.
.
.TP
\fB\-\-no\-fork\fR
Don\'t try to fork the repository\.
.
.TP
\fB\-\-version\fR
Specify the new \fIversion\fR for the cask\.
.
.TP
\fB\-\-message\fR
Append \fImessage\fR to the default pull request message\.
.
.TP
\fB\-\-url\fR
Specify the \fIURL\fR for the new download\.
.
.TP
\fB\-\-sha256\fR
Specify the \fISHA\-256\fR checksum of the new download\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Ignore duplicate open PRs\.
.
.SS "\fBbump\-formula\-pr\fR [\fIoptions\fR] [\fIformula\fR]"
Create a pull request to update \fIformula\fR 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 should also be specified\. A best effort to determine the \fIrevision\fR will be made if the value is not supplied by the user\.
.
.P
If a \fIversion\fR is specified, a best effort to determine the \fIURL\fR and \fISHA\-256\fR or the \fItag\fR and \fIrevision\fR will be made if both values are not supplied by the user\.
.
.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 formula already uses\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Print what would be done rather than doing it\.
.
.TP
\fB\-\-write\fR
Make the expected file modifications without taking any Git actions\.
.
.TP
\fB\-\-commit\fR
When passed with \fB\-\-write\fR, generate a new commit after writing changes to the formula file\.
.
.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\-\-online\fR
Run \fBbrew audit \-\-online\fR before opening the PR\.
.
.TP
\fB\-\-no\-browse\fR
Print the pull request URL instead of opening in a browser\.
.
.TP
\fB\-\-no\-fork\fR
Don\'t try to fork the repository\.
.
.TP
\fB\-\-mirror\fR
Use the specified \fIURL\fR as a mirror URL\. If \fIURL\fR is a comma\-separated list of URLs, multiple mirrors will be added\.
.
.TP
\fB\-\-version\fR
Use the specified \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 \fImessage\fR to the default pull request 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 commit \fIrevision\fR corresponding to the specified git \fItag\fR or specified \fIversion\fR\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Ignore duplicate open PRs\. Remove all mirrors if \fB\-\-mirror\fR was not specified\.
.
.SS "\fBbump\-revision\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
Create a commit to increment the revision of \fIformula\fR\. If no revision is present, "revision 1" will be added\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Print what would be done rather than doing it\.
.
.TP
\fB\-\-message\fR
Append \fImessage\fR to the default commit message\.
.
.SS "\fBbump\-unversioned\-casks\fR [\fIoptions\fR] [\fIcask\fR|\fItap\fR]"
Check all casks with unversioned URLs in a given \fItap\fR for updates\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Do everything except caching state and opening pull requests\.
.
.TP
\fB\-\-limit\fR
Maximum runtime in minutes\.
.
.TP
\fB\-\-state\-file\fR
File for caching state\.
.
.SS "\fBcat\fR \fIformula\fR|\fIcask\fR"
Display the source of a \fIformula\fR or \fIcask\fR\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.SS "\fBcommand\fR \fIcmd\fR"
Display the path to the file being used when invoking \fBbrew\fR \fIcmd\fR\.
.
.SS "\fBcreate\fR [\fIoptions\fR] \fIURL\fR"
Generate a formula or, with \fB\-\-cask\fR, a cask 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: \fIhttps://rubydoc\.brew\.sh/Formula\fR
.
.TP
\fB\-\-autotools\fR
Create a basic template for an Autotools\-style build\.
.
.TP
\fB\-\-cask\fR
Create a basic template for a cask\.
.
.TP
\fB\-\-cmake\fR
Create a basic template for a CMake\-style build\.
.
.TP
\fB\-\-crystal\fR
Create a basic template for a Crystal build\.
.
.TP
\fB\-\-go\fR
Create a basic template for a Go build\.
.
.TP
\fB\-\-meson\fR
Create a basic template for a Meson\-style build\.
.
.TP
\fB\-\-node\fR
Create a basic template for a Node build\.
.
.TP
\fB\-\-perl\fR
Create a basic template for a Perl build\.
.
.TP
\fB\-\-python\fR
Create a basic template for a Python build\.
.
.TP
\fB\-\-ruby\fR
Create a basic template for a Ruby build\.
.
.TP
\fB\-\-rust\fR
Create a basic template for a Rust build\.
.
.TP
\fB\-\-no\-fetch\fR
Homebrew will not download \fIURL\fR to the cache and will thus not add its 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
Explicitly set the \fIname\fR of the new formula or cask\.
.
.TP
\fB\-\-set\-version\fR
Explicitly set the \fIversion\fR of the new formula or cask\.
.
.TP
\fB\-\-set\-license\fR
Explicitly set the \fIlicense\fR of the new formula\.
.
.TP
\fB\-\-tap\fR
Generate the new formula within the given tap, specified as \fIuser\fR\fB/\fR\fIrepo\fR\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Ignore errors for disallowed formula names and names that shadow aliases\.
.
.SS "\fBdispatch\-build\-bottle\fR [\fIoptions\fR] \fIformula\fR [\fIformula\fR \.\.\.]"
Build bottles for these formulae with GitHub Actions\.
.
.TP
\fB\-\-tap\fR
Target tap repository (default: \fBhomebrew/core\fR)\.
.
.TP
\fB\-\-issue\fR
If specified, post a comment to this issue number if the job fails\.
.
.TP
\fB\-\-macos\fR
Version of macOS the bottle should be built for\.
.
.TP
\fB\-\-workflow\fR
Dispatch specified workflow (default: \fBdispatch\-build\-bottle\.yml\fR)\.
.
.TP
\fB\-\-upload\fR
Upload built bottles to Bintray\.
.
.SS "\fBedit\fR [\fIformula\fR|\fIcask\fR]"
Open a \fIformula\fR or \fIcask\fR in the editor set by \fBEDITOR\fR or \fBHOMEBREW_EDITOR\fR, or open the Homebrew repository for editing if no formula is provided\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.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\. To extract a formula from a tap that is not \fBhomebrew/core\fR use its fully\-qualified form of \fIuser\fR\fB/\fR\fIrepo\fR\fB/\fR\fIformula\fR\.
.
.TP
\fB\-\-version\fR
Extract the specified \fIversion\fR of \fIformula\fR instead of the most recent\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Overwrite the destination formula if it already exists\.
.
.SS "\fBformula\fR \fIformula\fR"
Display the path where \fIformula\fR is located\.
.
.SS "\fBinstall\-bundler\-gems\fR"
Install Homebrew\'s Bundler gems\.
.
.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 from the given \fIformula\fR kegs\. If no \fIformula\fR are provided, check all kegs\. Raises an error if run on uninstalled formulae\.
.
.TP
\fB\-\-test\fR
Show 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 "\fBlivecheck\fR [\fIformulae\fR|\fIcasks\fR]"
Check for newer versions of formulae and/or casks from upstream\.
.
.P
If no formula or cask argument is passed, the list of formulae and casks to check is taken from \fBHOMEBREW_LIVECHECK_WATCHLIST\fR or \fB~/\.brew_livecheck_watchlist\fR\.
.
.TP
\fB\-\-full\-name\fR
Print formulae/casks with fully\-qualified names\.
.
.TP
\fB\-\-tap\fR
Check formulae/casks within the given tap, specified as \fIuser\fR\fB/\fR\fIrepo\fR\.
.
.TP
\fB\-\-all\fR
Check all available formulae/casks\.
.
.TP
\fB\-\-installed\fR
Check formulae/casks that are currently installed\.
.
.TP
\fB\-\-newer\-only\fR
Show the latest version only if it\'s newer than the formula/cask\.
.
.TP
\fB\-\-json\fR
Output information in JSON format\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Suppress warnings, don\'t print a progress bar for JSON output\.
.
.TP
\fB\-\-formula\fR
Only check formulae\.
.
.TP
\fB\-\-cask\fR
Only check casks\.
.
.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 to notify CI 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 "\fBmirror\fR \fIformula\fR"
Reupload the stable URL of a formula to Bintray for use as a mirror\.
.
.TP
\fB\-\-bintray\-org\fR
Upload to the specified Bintray organisation (default: \fBhomebrew\fR)\.
.
.TP
\fB\-\-bintray\-repo\fR
Upload to the specified Bintray repository (default: \fBmirror\fR)\.
.
.TP
\fB\-\-no\-publish\fR
Upload to Bintray, but don\'t publish\.
.
.SS "\fBpr\-automerge\fR [\fIoptions\fR]"
Find pull requests that can be automatically merged using \fBbrew pr\-publish\fR\.
.
.TP
\fB\-\-tap\fR
Target tap repository (default: \fBhomebrew/core\fR)\.
.
.TP
\fB\-\-with\-label\fR
Pull requests must have this label\.
.
.TP
\fB\-\-without\-labels\fR
Pull requests must not have these labels (default: \fBdo not merge\fR, \fBnew formula\fR, \fBautomerge\-skip\fR, \fBlinux\-only\fR)\.
.
.TP
\fB\-\-without\-approval\fR
Pull requests do not require approval to be merged\.
.
.TP
\fB\-\-publish\fR
Run \fBbrew pr\-publish\fR on matching pull requests\.
.
.TP
\fB\-\-autosquash\fR
Instruct \fBbrew pr\-publish\fR to automatically reformat and reword commits in the pull request to our preferred format\.
.
.TP
\fB\-\-ignore\-failures\fR
Include pull requests that have failing status checks\.
.
.SS "\fBpr\-publish\fR [\fIoptions\fR] \fIpull_request\fR [\fIpull_request\fR \.\.\.]"
Publish bottles for a pull request with GitHub Actions\. Requires write access to the repository\.
.
.TP
\fB\-\-autosquash\fR
If supported on the target tap, automatically reformat and reword commits in the pull request to our preferred format\.
.
.TP
\fB\-\-message\fR
Message to include when autosquashing revision bumps, deletions, and rebuilds\.
.
.TP
\fB\-\-tap\fR
Target tap repository (default: \fBhomebrew/core\fR)\.
.
.TP
\fB\-\-workflow\fR
Target workflow filename (default: \fBpublish\-commit\-bottles\.yml\fR)\.
.
.SS "\fBpr\-pull\fR [\fIoptions\fR] \fIpull_request\fR [\fIpull_request\fR \.\.\.]"
Download and publish bottles, and apply the bottle commit from a pull request with artifacts generated by GitHub Actions\. Requires write access to the repository\.
.
.TP
\fB\-\-no\-publish\fR
Download the bottles, apply the bottle commit and upload the bottles to Bintray, but don\'t publish them\.
.
.TP
\fB\-\-no\-upload\fR
Download the bottles and apply the bottle commit, but don\'t upload to Bintray or GitHub Releases\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Print what would be done rather than doing it\.
.
.TP
\fB\-\-clean\fR
Do not amend the commits from pull requests\.
.
.TP
\fB\-\-keep\-old\fR
If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL\.
.
.TP
\fB\-\-autosquash\fR
Automatically reformat and reword commits in the pull request to our preferred format\.
.
.TP
\fB\-\-branch\-okay\fR
Do not warn if pulling to a branch besides the repository default (useful for testing)\.
.
.TP
\fB\-\-resolve\fR
When a patch fails to apply, leave in progress and allow user to resolve, instead of aborting\.
.
.TP
\fB\-\-warn\-on\-upload\-failure\fR
Warn instead of raising an error if the bottle upload fails\. Useful for repairing bottle uploads that previously failed\.
.
.TP
\fB\-\-message\fR
Message to include when autosquashing revision bumps, deletions, and rebuilds\.
.
.TP
\fB\-\-artifact\fR
Download artifacts with the specified name (default: \fBbottles\fR)\.
.
.TP
\fB\-\-bintray\-org\fR
Upload to the specified Bintray organisation (default: \fBhomebrew\fR)\.
.
.TP
\fB\-\-tap\fR
Target tap repository (default: \fBhomebrew/core\fR)\.
.
.TP
\fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.TP
\fB\-\-bintray\-mirror\fR
Use the specified Bintray repository to automatically mirror stable URLs defined in the formulae (default: \fBmirror\fR)\.
.
.TP
\fB\-\-workflows\fR
Retrieve artifacts from the specified workflow (default: \fBtests\.yml\fR)\. Can be a comma\-separated list to include multiple workflows\.
.
.TP
\fB\-\-ignore\-missing\-artifacts\fR
Comma\-separated list of workflows which can be ignored if they have not been run\.
.
.SS "\fBpr\-upload\fR [\fIoptions\fR]"
Apply the bottle commit and publish bottles to Bintray or GitHub Releases\.
.
.TP
\fB\-\-no\-publish\fR
Apply the bottle commit and upload the bottles, but don\'t publish them\.
.
.TP
\fB\-\-keep\-old\fR
If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL\.
.
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
Print what would be done rather than doing it\.
.
.TP
\fB\-\-no\-commit\fR
Do not generate a new commit before uploading\.
.
.TP
\fB\-\-warn\-on\-upload\-failure\fR
Warn instead of raising an error if the bottle upload fails\. Useful for repairing bottle uploads that previously failed\.
.
.TP
\fB\-\-bintray\-org\fR
Upload to the specified Bintray organisation (default: \fBhomebrew\fR)\.
.
.TP
\fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.SS "\fBprof\fR [\fIcommand\fR]"
Run Homebrew with a Ruby profiler, e\.g\. \fBbrew prof readall\fR\.
.
.TP
\fB\-\-stackprof\fR
Use \fBstackprof\fR instead of \fBruby\-prof\fR (the default)\.
.
.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\.
.
.P
If \fB\-\-markdown\fR and a \fIprevious_tag\fR are passed, an extra line containing a link to the Homebrew blog will be adding to the output\. Additionally, a warning will be shown if the latest minor release was less than one month ago\.
.
.TP
\fB\-\-markdown\fR
Print as a Markdown list\.
.
.SS "\fBrubocop\fR"
Installs, configures and runs Homebrew\'s \fBrubocop\fR\.
.
.SS "\fBruby\fR (\fB\-e\fR \fItext\fR|\fIfile\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\-r\fR
Load a library using \fBrequire\fR\.
.
.TP
\fB\-e\fR
Execute the given text string as a script\.
.
.SS "\fBsh\fR [\fIoptions\fR] [\fIfile\fR]"
Homebrew build environment that uses years\-battle\-hardened build logic to help your \fB\./configure && make && make install\fR and 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 build systems would not find otherwise\.
.
.TP
\fB\-\-env\fR
Use the standard \fBPATH\fR instead of superenv\'s when \fBstd\fR is passed\.
.
.TP
\fB\-c\fR, \fB\-\-cmd\fR
Execute commands in a non\-interactive shell\.
.
.SS "\fBsponsors\fR"
Print a Markdown summary of Homebrew\'s GitHub Sponsors, suitable for pasting into a README\.
.
.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\-\-reset\-cache\fR
Reset the RuboCop cache\.
.
.TP
\fB\-\-formula\fR
Treat all named arguments as formulae\.
.
.TP
\fB\-\-cask\fR
Treat all named arguments as casks\.
.
.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 "\fBtap\-new\fR [\fIoptions\fR] \fIuser\fR\fB/\fR\fIrepo\fR"
Generate the template files for a new tap\.
.
.TP
\fB\-\-no\-git\fR
Don\'t initialize a Git repository for the tap\.
.
.TP
\fB\-\-pull\-label\fR
Label name for pull requests ready to be pulled (default: \fBpr\-pull\fR)\.
.
.TP
\fB\-\-branch\fR
Initialize Git repository with the specified branch name (default: \fBmain\fR)\.
.
.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\-\-HEAD\fR
Test the head version of a formula\.
.
.TP
\fB\-\-keep\-tmp\fR
Retain the temporary files created for the test\.
.
.TP
\fB\-\-retry\fR
Retry if a testing fails\.
.
.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\-\-byebug\fR
Enable debugging using byebug\.
.
.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 specified \fIvalue\fR instead of a random seed\.
.
.SS "\fBtypecheck\fR"
Check for typechecking errors using Sorbet\.
.
.TP
\fB\-\-fix\fR
Automatically fix type errors\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Silence all non\-critical errors\.
.
.TP
\fB\-\-update\fR
Update RBI files\.
.
.TP
\fB\-\-suggest\-typed\fR
Try upgrading \fBtyped\fR sigils\.
.
.TP
\fB\-\-fail\-if\-not\-changed\fR
Return a failing status code if all gems are up to date and gem definitions do not need a tapioca update\.
.
.TP
\fB\-\-dir\fR
Typecheck all files in a specific directory\.
.
.TP
\fB\-\-file\fR
Typecheck a single file\.
.
.TP
\fB\-\-ignore\fR
Ignores input files that contain the given string in their paths (relative to the input path passed to Sorbet)\.
.
.SS "\fBunbottled\fR [\fIformula\fR]"
Outputs the unbottled dependents of formulae\.
.
.TP
\fB\-\-tag\fR
Use the specified bottle tag (e\.g\. big_sur) instead of the current OS\.
.
.TP
\fB\-\-dependents\fR
Don\'t get analytics data and sort by number of dependents instead\.
.
.TP
\fB\-\-total\fR
Output the number of unbottled and total formulae\.
.
.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\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
Overwrite the destination directory if it already exists\.
.
.SS "\fBupdate\-license\-data\fR [\fIoptions\fR]"
Update SPDX license data in the Homebrew repository\.
.
.TP
\fB\-\-fail\-if\-not\-changed\fR
Return a failing status code if current license data\'s version is the same as the upstream\. This can be used to notify CI when the SPDX license data is out of date\.
.
.SS "\fBupdate\-python\-resources\fR [\fIoptions\fR] \fIformula\fR"
Update versions for PyPI resource blocks in \fIformula\fR\.
.
.TP
\fB\-p\fR, \fB\-\-print\-only\fR
Print the updated resource blocks instead of changing \fIformula\fR\.
.
.TP
\fB\-s\fR, \fB\-\-silent\fR
Suppress any output\.
.
.TP
\fB\-\-ignore\-non\-pypi\-packages\fR
Don\'t fail if \fIformula\fR is not a PyPI package\.
.
.TP
\fB\-\-version\fR
Use the specified \fIversion\fR when finding resources for \fIformula\fR\. If no version is specified, the current version for \fIformula\fR will be used\.
.
.TP
\fB\-\-package\-name\fR
Use the specified \fIpackage\-name\fR when finding resources for \fIformula\fR\. If no package name is specified, it will be inferred from the formula\'s stable URL\.
.
.TP
\fB\-\-extra\-packages\fR
Include these additional packages when finding resources\.
.
.TP
\fB\-\-exclude\-packages\fR
Exclude these packages when finding resources\.
.
.SS "\fBupdate\-test\fR [\fIoptions\fR]"
Run a test of \fBbrew update\fR with a new repository clone\. If no options 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 the specified \fIcommit\fR as the start commit\.
.
.TP
\fB\-\-before\fR
Use the commit at the specified \fIdate\fR as the start commit\.
.
.SS "\fBvendor\-gems\fR"
Install and commit Homebrew\'s vendored gems\.
.
.TP
\fB\-\-update\fR
Update all vendored Gems to the latest version\.
.
.SH "GLOBAL CASK OPTIONS"
These options are applicable to the \fBinstall\fR, \fBreinstall\fR, and \fBupgrade\fR subcommands with the \fB\-\-cask\fR flag\.
.
.TP
\fB\-\-appdir\fR
Target location for Applications (default: \fB/Applications\fR)\.
.
.TP
\fB\-\-colorpickerdir\fR
Target location for Color Pickers (default: \fB~/Library/ColorPickers\fR)\.
.
.TP
\fB\-\-prefpanedir\fR
Target location for Preference Panes (default: \fB~/Library/PreferencePanes\fR)\.
.
.TP
\fB\-\-qlplugindir\fR
Target location for QuickLook Plugins (default: \fB~/Library/QuickLook\fR)\.
.
.TP
\fB\-\-mdimporterdir\fR
Target location for Spotlight Plugins (default: \fB~/Library/Spotlight\fR)\.
.
.TP
\fB\-\-dictionarydir\fR
Target location for Dictionaries (default: \fB~/Library/Dictionaries\fR)\.
.
.TP
\fB\-\-fontdir\fR
Target location for Fonts (default: \fB~/Library/Fonts\fR)\.
.
.TP
\fB\-\-servicedir\fR
Target location for Services (default: \fB~/Library/Services\fR)\.
.
.TP
\fB\-\-input\-methoddir\fR
Target location for Input Methods (default: \fB~/Library/Input Methods\fR)\.
.
.TP
\fB\-\-internet\-plugindir\fR
Target location for Internet Plugins (default: \fB~/Library/Internet Plug\-Ins\fR)\.
.
.TP
\fB\-\-audio\-unit\-plugindir\fR
Target location for Audio Unit Plugins (default: \fB~/Library/Audio/Plug\-Ins/Components\fR)\.
.
.TP
\fB\-\-vst\-plugindir\fR
Target location for VST Plugins (default: \fB~/Library/Audio/Plug\-Ins/VST\fR)\.
.
.TP
\fB\-\-vst3\-plugindir\fR
Target location for VST3 Plugins (default: \fB~/Library/Audio/Plug\-Ins/VST3\fR)\.
.
.TP
\fB\-\-screen\-saverdir\fR
Target location for Screen Savers (default: \fB~/Library/Screen Savers\fR)\.
.
.TP
\fB\-\-language\fR
Comma\-separated list of language codes to prefer for cask installation\. The first matching language is used, otherwise it reverts to the cask\'s default language\. The default value is the language of your system\.
.
.SH "GLOBAL OPTIONS"
These options are applicable across multiple subcommands\.
.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Display any debugging information\.
.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Make some output more quiet\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Make some output more verbose\.
.
.TP
\fB\-h\fR, \fB\-\-help\fR
Show this message\.
.
.SH "OFFICIAL EXTERNAL COMMANDS"
.
.SS "\fBbundle\fR [\fIsubcommand\fR]"
Bundler for non\-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store and Whalebrew\.
.
.P
\fBbrew bundle\fR [\fBinstall\fR]
    Install and upgrade (by default) all dependencies from the \fBBrewfile\fR\.
.
.P
You can specify the \fBBrewfile\fR location using \fB\-\-file\fR or by setting the \fBHOMEBREW_BUNDLE_FILE\fR environment variable\.
.
.P
You can skip the installation of dependencies by adding space\-separated values to one or more of the following environment variables: \fBHOMEBREW_BUNDLE_BREW_SKIP\fR, \fBHOMEBREW_BUNDLE_CASK_SKIP\fR, \fBHOMEBREW_BUNDLE_MAS_SKIP\fR, \fBHOMEBREW_BUNDLE_WHALEBREW_SKIP\fR, \fBHOMEBREW_BUNDLE_TAP_SKIP\fR\.
.
.P
\fBbrew bundle\fR will output a \fBBrewfile\.lock\.json\fR in the same directory as the \fBBrewfile\fR if all dependencies are installed successfully\. This contains dependency and system status information which can be useful in debugging \fBbrew bundle\fR failures and replicating a "last known good build" state\. You can opt\-out of this behaviour by setting the \fBHOMEBREW_BUNDLE_NO_LOCK\fR environment variable or passing the \fB\-\-no\-lock\fR option\. You may wish to check this file into the same version control system as your \fBBrewfile\fR (or ensure your version control system ignores it if you\'d prefer to rely on debugging information from a local machine)\.
.
.P
\fBbrew bundle dump\fR
    Write all installed casks/formulae/images/taps into a \fBBrewfile\fR in the current directory\.
.
.P
\fBbrew bundle cleanup\fR
    Uninstall all dependencies not listed from the \fBBrewfile\fR\.
.
.P
This workflow is useful for maintainers or testers who regularly install lots of formulae\.
.
.P
\fBbrew bundle check\fR
    Check if all dependencies are installed from the \fBBrewfile\fR\.
.
.P
This provides a successful exit code if everything is up\-to\-date, making it useful for scripting\.
.
.P
\fBbrew bundle list\fR
    List all dependencies present in the \fBBrewfile\fR\.
.
.P
By default, only Homebrew dependencies are listed\.
.
.P
\fBbrew bundle exec\fR \fIcommand\fR
    Run an external command in an isolated build environment based on the \fBBrewfile\fR dependencies\.
.
.P
This sanitized build environment ignores unrequested dependencies, which makes sure that things you didn\'t specify in your \fBBrewfile\fR won\'t get picked up by commands like \fBbundle install\fR, \fBnpm install\fR, etc\. It will also add compiler flags which will help find keg\-only dependencies like \fBopenssl\fR, \fBicu4c\fR, etc\.
.
.TP
\fB\-\-file\fR
Read the \fBBrewfile\fR from this location\. Use \fB\-\-file=\-\fR to pipe to stdin/stdout\.
.
.TP
\fB\-\-global\fR
Read the \fBBrewfile\fR from \fB~/\.Brewfile\fR\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
\fBinstall\fR prints output from commands as they are run\. \fBcheck\fR lists all missing dependencies\.
.
.TP
\fB\-\-no\-upgrade\fR
\fBinstall\fR won\'t run \fBbrew upgrade\fR on outdated dependencies\. Note they may still be upgraded by \fBbrew install\fR if needed\.
.
.TP
\fB\-f\fR, \fB\-\-force\fR
\fBdump\fR overwrites an existing \fBBrewfile\fR\. \fBcleanup\fR actually performs its cleanup operations\.
.
.TP
\fB\-\-cleanup\fR
\fBinstall\fR performs cleanup operation, same as running \fBcleanup \-\-force\fR\.
.
.TP
\fB\-\-no\-lock\fR
\fBinstall\fR won\'t output a \fBBrewfile\.lock\.json\fR\.
.
.TP
\fB\-\-all\fR
\fBlist\fR all dependencies\.
.
.TP
\fB\-\-formula\fR
\fBlist\fR Homebrew dependencies\.
.
.TP
\fB\-\-cask\fR
\fBlist\fR Homebrew Cask dependencies\.
.
.TP
\fB\-\-tap\fR
\fBlist\fR tap dependencies\.
.
.TP
\fB\-\-mas\fR
\fBlist\fR Mac App Store dependencies\.
.
.TP
\fB\-\-whalebrew\fR
\fBlist\fR Whalebrew dependencies\.
.
.TP
\fB\-\-describe\fR
\fBdump\fR adds a description comment above each line, unless the dependency does not have a description\.
.
.TP
\fB\-\-no\-restart\fR
\fBdump\fR does not add \fBrestart_service\fR to formula lines\.
.
.TP
\fB\-\-zap\fR
\fBcleanup\fR casks using the \fBzap\fR command instead of \fBuninstall\fR\.
.
.SS "\fBservices\fR [\fIsubcommand\fR]"
Manage background services with macOS\' \fBlaunchctl\fR(1) daemon manager\.
.
.P
If \fBsudo\fR is passed, operate on \fB/Library/LaunchDaemons\fR (started at boot)\. Otherwise, operate on \fB~/Library/LaunchAgents\fR (started at login)\.
.
.P
[\fBsudo\fR] \fBbrew services\fR [\fBlist\fR]
    List all managed services for the current user (or root)\.
.
.P
[\fBsudo\fR] \fBbrew services run\fR (\fIformula\fR|\fB\-\-all\fR)
    Run the service \fIformula\fR without registering to launch at login (or boot)\.
.
.P
[\fBsudo\fR] \fBbrew services start\fR (\fIformula\fR|\fB\-\-all\fR)
    Start the service \fIformula\fR immediately and register it to launch at login (or boot)\.
.
.P
[\fBsudo\fR] \fBbrew services stop\fR (\fIformula\fR|\fB\-\-all\fR)
    Stop the service \fIformula\fR immediately and unregister it from launching at login (or boot)\.
.
.P
[\fBsudo\fR] \fBbrew services restart\fR (\fIformula\fR|\fB\-\-all\fR)
    Stop (if necessary) and start the service \fIformula\fR immediately and register it to launch at login (or boot)\.
.
.P
[\fBsudo\fR] \fBbrew services cleanup\fR
    Remove all unused services\.
.
.TP
\fB\-\-all\fR
Run \fIsubcommand\fR on all services\.
.
.SS "\fBtest\-bot\fR [\fIoptions\fR] [\fIformula\fR]"
Tests the full lifecycle of a Homebrew change to a tap (Git repository)\. For example, for a GitHub Actions pull request that changes a formula \fBbrew test\-bot\fR will ensure the system is cleaned and set up to test the formula, install the formula, run various tests and checks on it, bottle (package) the binaries and test formulae that depend on it to ensure they aren\'t broken by these changes\.
.
.P
Only supports GitHub Actions as a CI provider\. This is because Homebrew uses GitHub Actions and it\'s freely available for public and private use with macOS and Linux workers\.
.
.TP
\fB\-\-dry\-run\fR
Print what would be done rather than doing it\.
.
.TP
\fB\-\-cleanup\fR
Clean all state from the Homebrew directory\. Use with care!
.
.TP
\fB\-\-skip\-setup\fR
Don\'t check if the local system is set up correctly\.
.
.TP
\fB\-\-build\-from\-source\fR
Build from source rather than building bottles\.
.
.TP
\fB\-\-keep\-old\fR
Run \fBbrew bottle \-\-keep\-old\fR to build new bottles for a single platform\.
.
.TP
\fB\-\-skip\-relocation\fR
Run \fBbrew bottle \-\-skip\-relocation\fR to build new bottles that don\'t require relocation\.
.
.TP
\fB\-\-local\fR
Ask Homebrew to write verbose logs under \fB\./logs/\fR and set \fB$HOME\fR to \fB\./home/\fR
.
.TP
\fB\-\-tap\fR
Use the Git repository of the given tap\. Defaults to the core tap for syntax checking\.
.
.TP
\fB\-\-fail\-fast\fR
Immediately exit on a failing step\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print test step output in real time\. Has the side effect of passing output as raw bytes instead of re\-encoding in UTF\-8\.
.
.TP
\fB\-\-test\-default\-formula\fR
Use a default testing formula when not building a tap and no other formulae are specified\.
.
.TP
\fB\-\-bintray\-org\fR
Upload bottles to the given Bintray organisation\.
.
.TP
\fB\-\-root\-url\fR
Use the specified \fIURL\fR as the root of the bottle\'s URL instead of Homebrew\'s default\.
.
.TP
\fB\-\-git\-name\fR
Set the Git author/committer names to the given name\.
.
.TP
\fB\-\-git\-email\fR
Set the Git author/committer email to the given email\.
.
.TP
\fB\-\-ci\-upload\fR
Use the Homebrew CI bottle upload options\.
.
.TP
\fB\-\-publish\fR
Publish the uploaded bottles\.
.
.TP
\fB\-\-skip\-recursive\-dependents\fR
Only test the direct dependents\.
.
.TP
\fB\-\-only\-cleanup\-before\fR
Only run the pre\-cleanup step\. Needs \fB\-\-cleanup\fR\.
.
.TP
\fB\-\-only\-setup\fR
Only run the local system setup check step\.
.
.TP
\fB\-\-only\-tap\-syntax\fR
Only run the tap syntax check step\.
.
.TP
\fB\-\-only\-formulae\fR
Only run the formulae steps\.
.
.TP
\fB\-\-only\-cleanup\-after\fR
Only run the post\-cleanup step\. Needs \fB\-\-cleanup\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
Homebrew can install formulae from a local path\. It can point to either a formula file or a bottle\. Prefix relative paths with \fB\./\fR to prevent them being interpreted as a formula or tap name\.
.
.SH "SPECIFYING CASKS"
Many Homebrew Cask commands accept one or more \fIcask\fR arguments\. These can be specified the same way as the \fIformula\fR arguments described in \fBSPECIFYING FORMULAE\fR above\.
.
.SH "ENVIRONMENT"
Note that environment variables must have a value set to be detected\. For example, run \fBexport HOMEBREW_NO_INSECURE_REDIRECT=1\fR rather than just \fBexport HOMEBREW_NO_INSECURE_REDIRECT\fR\.
.
.TP
\fBHOMEBREW_ARCH\fR
.
.br
Linux only: Pass this value to a type name representing the compiler\'s \fB\-march\fR option\.
.
.IP
\fIDefault:\fR \fBnative\fR\.
.
.TP
\fBHOMEBREW_ARTIFACT_DOMAIN\fR
.
.br
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
.
.br
Automatically check for updates once per this seconds interval\.
.
.IP
\fIDefault:\fR \fB300\fR\.
.
.TP
\fBHOMEBREW_BAT\fR
.
.br
If set, use \fBbat\fR for the \fBbrew cat\fR command\.
.
.TP
\fBHOMEBREW_BAT_CONFIG_PATH\fR
.
.br
Use this as the \fBbat\fR configuration file\.
.
.IP
\fIDefault:\fR \fB$HOME/\.bat/config\fR\.
.
.TP
\fBHOMEBREW_BINTRAY_KEY\fR
.
.br
Use this API key when accessing the Bintray API (where bottles are stored)\.
.
.TP
\fBHOMEBREW_BINTRAY_USER\fR
.
.br
Use this username when accessing the Bintray API (where bottles are stored)\.
.
.TP
\fBHOMEBREW_BOTTLE_DOMAIN\fR
.
.br
Use this URL as the download mirror for bottles\. For example, \fBHOMEBREW_BOTTLE_DOMAIN=http://localhost:8080\fR will cause all bottles to download from the prefix \fBhttp://localhost:8080/\fR\.
.
.IP
\fIDefault:\fR macOS: \fBhttps://homebrew\.bintray\.com/\fR, Linux: \fBhttps://linuxbrew\.bintray\.com/\fR\.
.
.TP
\fBHOMEBREW_BREW_GIT_REMOTE\fR
.
.br
Use this URL as the Homebrew/brew \fBgit\fR(1) remote\.
.
.IP
\fIDefault:\fR \fBhttps://github\.com/Homebrew/brew\fR\.
.
.TP
\fBHOMEBREW_BROWSER\fR
.
.br
Use this as the browser when opening project homepages\.
.
.IP
\fIDefault:\fR \fB$BROWSER\fR or the OS\'s default browser\.
.
.TP
\fBHOMEBREW_CACHE\fR
.
.br
Use this directory as the download cache\.
.
.IP
\fIDefault:\fR macOS: \fB$HOME/Library/Caches/Homebrew\fR, Linux: \fB$XDG_CACHE_HOME/Homebrew\fR or \fB$HOME/\.cache/Homebrew\fR\.
.
.TP
\fBHOMEBREW_CASK_OPTS\fR
.
.br
Append these options to all \fBcask\fR commands\. All \fB\-\-*dir\fR options, \fB\-\-language\fR, \fB\-\-require\-sha\fR, \fB\-\-no\-quarantine\fR and \fB\-\-no\-binaries\fR are supported\. For example, you might add something like the following to your \fB~/\.profile\fR, \fB~/\.bash_profile\fR, or \fB~/\.zshenv\fR:
.
.IP
\fBexport HOMEBREW_CASK_OPTS="\-\-appdir=~/Applications \-\-fontdir=/Library/Fonts"\fR
.
.TP
\fBHOMEBREW_CLEANUP_PERIODIC_FULL_DAYS\fR
.
.br
If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will cleanup all formulae when this number of days has passed\.
.
.IP
\fIDefault:\fR \fB30\fR\.
.
.TP
\fBHOMEBREW_CLEANUP_MAX_AGE_DAYS\fR
.
.br
Cleanup all cached files older than this many days\.
.
.IP
\fIDefault:\fR \fB120\fR\.
.
.TP
\fBHOMEBREW_COLOR\fR
.
.br
If set, force colour output on non\-TTY outputs\.
.
.TP
\fBHOMEBREW_CORE_GIT_REMOTE\fR
.
.br
Use this URL as the Homebrew/homebrew\-core \fBgit\fR(1) remote\.
.
.IP
\fIDefault:\fR macOS: \fBhttps://github\.com/Homebrew/homebrew\-core\fR, Linux: \fBhttps://github\.com/Homebrew/linuxbrew\-core\fR\.
.
.TP
\fBHOMEBREW_CURLRC\fR
.
.br
If set, do not pass \fB\-\-disable\fR when invoking \fBcurl\fR(1), which disables the use of \fBcurlrc\fR\.
.
.TP
\fBHOMEBREW_CURL_RETRIES\fR
.
.br
Pass the given retry count to \fB\-\-retry\fR when invoking \fBcurl\fR(1)\.
.
.IP
\fIDefault:\fR \fB3\fR\.
.
.TP
\fBHOMEBREW_CURL_VERBOSE\fR
.
.br
If set, pass \fB\-\-verbose\fR when invoking \fBcurl\fR(1)\.
.
.TP
\fBHOMEBREW_DEVELOPER\fR
.
.br
If set, tweak behaviour to be more relevant for Homebrew developers (active or budding) by e\.g\. turning warnings into errors\.
.
.TP
\fBHOMEBREW_DISABLE_LOAD_FORMULA\fR
.
.br
If set, refuse to load formulae\. This is useful when formulae are not trusted (such as in pull requests)\.
.
.TP
\fBHOMEBREW_DISPLAY\fR
.
.br
Use this X11 display when opening a page in a browser, for example with \fBbrew home\fR\. Primarily useful on Linux\.
.
.IP
\fIDefault:\fR \fB$DISPLAY\fR\.
.
.TP
\fBHOMEBREW_DISPLAY_INSTALL_TIMES\fR
.
.br
If set, print install times for each formula at the end of the run\.
.
.TP
\fBHOMEBREW_EDITOR\fR
.
.br
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\. Visual Studio Code can handle this correctly in project mode, but many editors will do strange things in this case\.
.
.IP
\fIDefault:\fR \fB$EDITOR\fR or \fB$VISUAL\fR\.
.
.TP
\fBHOMEBREW_FAIL_LOG_LINES\fR
.
.br
Output this many lines of output on formula \fBsystem\fR failures\.
.
.IP
\fIDefault:\fR \fB15\fR\.
.
.TP
\fBHOMEBREW_FORBIDDEN_LICENSES\fR
.
.br
A space\-separated list of licenses\. Homebrew will refuse to install a formula if it or any of its dependencies has a license on this list\.
.
.TP
\fBHOMEBREW_FORCE_BREWED_CURL\fR
.
.br
If set, always use a Homebrew\-installed \fBcurl\fR(1) rather than the system version\. Automatically set if the system version of \fBcurl\fR is too old\.
.
.TP
\fBHOMEBREW_FORCE_BREWED_GIT\fR
.
.br
If set, always use a Homebrew\-installed \fBgit\fR(1) rather than the system version\. Automatically set if the system version of \fBgit\fR is too old\.
.
.TP
\fBHOMEBREW_FORCE_HOMEBREW_ON_LINUX\fR
.
.br
If set, running Homebrew on Linux will use URLs for macOS\. This is useful when merging pull requests for macOS while on Linux\.
.
.TP
\fBHOMEBREW_FORCE_VENDOR_RUBY\fR
.
.br
If set, always use Homebrew\'s vendored, relocatable Ruby version even if the system version of Ruby is new enough\.
.
.TP
\fBHOMEBREW_GITHUB_API_TOKEN\fR
.
.br
Use this personal access token for the GitHub API, 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://docs\.github\.com/en/rest/overview/resources\-in\-the\-rest\-api#rate\-limiting\fR
.
.IP
\fINote:\fR Homebrew doesn\'t require permissions for any of the scopes, but some developer commands may require additional permissions\.
.
.TP
\fBHOMEBREW_GIT_EMAIL\fR
.
.br
Set the Git author and committer email to this value\.
.
.TP
\fBHOMEBREW_GIT_NAME\fR
.
.br
Set the Git author and committer name to this value\.
.
.TP
\fBHOMEBREW_INSTALL_BADGE\fR
.
.br
Print this text before the installation summary of each successful build\.
.
.IP
\fIDefault:\fR The "Beer Mug" emoji\.
.
.TP
\fBHOMEBREW_LIVECHECK_WATCHLIST\fR
.
.br
Consult this file for the list of formulae to check by default when no formula argument is passed to \fBbrew livecheck\fR\.
.
.IP
\fIDefault:\fR \fB$HOME/\.brew_livecheck_watchlist\fR\.
.
.TP
\fBHOMEBREW_LOGS\fR
.
.br
Use this directory to store log files\.
.
.IP
\fIDefault:\fR macOS: \fB$HOME/Library/Logs/Homebrew\fR, Linux: \fB$XDG_CACHE_HOME/Homebrew/Logs\fR or \fB$HOME/\.cache/Homebrew/Logs\fR\.
.
.TP
\fBHOMEBREW_MAKE_JOBS\fR
.
.br
Use this value 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
.
.br
If set, do not send analytics\. For more information, see: \fIhttps://docs\.brew\.sh/Analytics\fR
.
.TP
\fBHOMEBREW_NO_AUTO_UPDATE\fR
.
.br
If set, do not automatically update before running \fBbrew install\fR, \fBbrew upgrade\fR or \fBbrew tap\fR\.
.
.TP
\fBHOMEBREW_NO_BOTTLE_SOURCE_FALLBACK\fR
.
.br
If set, fail on the failure of installation from a bottle rather than falling back to building from source\.
.
.TP
\fBHOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK\fR
.
.br
If set, do not check for broken dependents after installing, upgrading or reinstalling formulae\.
.
.TP
\fBHOMEBREW_NO_COLOR\fR
.
.br
If set, do not print text with colour added\.
.
.IP
\fIDefault:\fR \fB$NO_COLOR\fR\.
.
.TP
\fBHOMEBREW_NO_COMPAT\fR
.
.br
If set, disable all use of legacy compatibility code\.
.
.TP
\fBHOMEBREW_NO_EMOJI\fR
.
.br
If set, do not print \fBHOMEBREW_INSTALL_BADGE\fR on a successful build\.
.
.IP
\fINote:\fR Will only try to print emoji on OS X Lion or newer\.
.
.TP
\fBHOMEBREW_NO_GITHUB_API\fR
.
.br
If set, do not use the GitHub API, e\.g\. for searches or fetching relevant issues after a failed install\.
.
.TP
\fBHOMEBREW_NO_INSECURE_REDIRECT\fR
.
.br
If set, forbid redirects from secure HTTPS to insecure HTTP\.
.
.IP
\fINote:\fR While ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME\-hosted formulae to fail to download\.
.
.TP
\fBHOMEBREW_NO_INSTALL_CLEANUP\fR
.
.br
If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS days\.
.
.TP
\fBHOMEBREW_PRY\fR
.
.br
If set, use Pry for the \fBbrew irb\fR command\.
.
.TP
\fBHOMEBREW_SKIP_OR_LATER_BOTTLES\fR
.
.br
If set along with \fBHOMEBREW_DEVELOPER\fR, do not use bottles from older versions of macOS\. This is useful in development on new macOS versions\.
.
.TP
\fBHOMEBREW_SORBET_RUNTIME\fR
.
.br
If set, enable runtime typechecking using Sorbet\.
.
.TP
\fBHOMEBREW_SVN\fR
.
.br
Use this as the \fBsvn\fR(1) binary\.
.
.IP
\fIDefault:\fR A Homebrew\-built Subversion (if installed), or the system\-provided binary\.
.
.TP
\fBHOMEBREW_TEMP\fR
.
.br
Use this path as the temporary directory for building packages\. Changing this may be needed if your system temporary directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist\. This issue typically occurs when using FileVault or custom SSD configurations\.
.
.IP
\fIDefault:\fR macOS: \fB/private/tmp\fR, Linux: \fB/tmp\fR\.
.
.TP
\fBHOMEBREW_UPDATE_REPORT_ONLY_INSTALLED\fR
.
.br
If set, \fBbrew update\fR only lists updates to installed software\.
.
.TP
\fBHOMEBREW_UPDATE_TO_TAG\fR
.
.br
If set, always use the latest stable tag (even if developer commands have been run)\.
.
.TP
\fBHOMEBREW_VERBOSE\fR
.
.br
If set, always assume \fB\-\-verbose\fR when running commands\.
.
.TP
\fBHOMEBREW_DEBUG\fR
.
.br
If set, always assume \fB\-\-debug\fR when running commands\.
.
.TP
\fBHOMEBREW_VERBOSE_USING_DOTS\fR
.
.br
If set, verbose output will print a \fB\.\fR no more than once a minute\. This can be useful to avoid long\-running Homebrew commands being killed due to no output\.
.
.TP
\fBall_proxy\fR
.
.br
Use this SOCKS5 proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
.
.TP
\fBftp_proxy\fR
.
.br
Use this FTP proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
.
.TP
\fBhttp_proxy\fR
.
.br
Use this HTTP proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
.
.TP
\fBhttps_proxy\fR
.
.br
Use this HTTPS proxy for \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
.
.TP
\fBno_proxy\fR
.
.br
A comma\-separated list of hostnames and domain names excluded from proxying by \fBcurl\fR(1), \fBgit\fR(1) and \fBsvn\fR(1) when downloading through Homebrew\.
.
.TP
\fBSUDO_ASKPASS\fR
.
.br
If set, pass the \fB\-A\fR option when calling \fBsudo\fR(8)\.
.
.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
Homebrew API: \fIhttps://rubydoc\.brew\.sh\fR
.
.P
\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, Sean Molenaar 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 maintainers are Michka Popoff, Shaun Jackman, Dawid Dziurla, Issy Long and Maxim Belkin\.
.
.P
Homebrew\'s other current maintainers are Claudia Pellegrino, Zach Auten, Rui Chen, Vitor Galvao, Caleb Xu, Gautham Goli, Steven Peters, Bo Anderson, William Woodruff, Igor Kapkov, Sam Ford, Alexander Bayandin, Izaak Beekman, Eric Knibbe, Viktor Szakats, Thierry Moisan, Steven Peters, Tom Schoonjans, Issy Long, CoreCode, Randall, Rylan Polster, SeekingMeaning, William Ma and Dustin Rodrigues\.
.
.P
Former maintainers with significant contributions include Jan Viljanen, 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, Chongyu Zhu and Homebrew\'s creator: Max Howell\.
.
.SH "BUGS"
See our issues on GitHub:
.
.TP
\fBHomebrew/brew\fR
.
.br
\fIhttps://github\.com/Homebrew/brew/issues\fR
.
.TP
\fBHomebrew/homebrew\-core\fR
.
.br
\fIhttps://github\.com/Homebrew/homebrew\-core/issues\fR
.
.TP
\fBHomebrew/homebrew\-cask\fR
.
.br
\fIhttps://github\.com/Homebrew/homebrew\-cask/issues\fR