<% # To make changes to this man page: # # - For changes to a specific command (appears in the `COMMANDS` section): # - Edit the top comment in `Library/Homebrew/cmd/.{rb,sh}`. # - Make sure to use the line prefix `#:` for the comments to be recognized as # documentation. If in doubt, compare with already documented commands. # - For other changes: Edit this file. # # When done, regenerate the man page and its HTML version by running `brew man`. %> brew(1) -- The Missing Package Manager for macOS ================================================ ## SYNOPSIS `brew` `--version`
`brew` [`--verbose`|`-v`] [] [] ... ## DESCRIPTION Homebrew is the easiest and most flexible way to install the UNIX tools Apple didn't include with macOS. ## ESSENTIAL COMMANDS For the full command list, see the [COMMANDS](#commands) section. With `--verbose` or `--debug`, many commands print extra debugging information. Note that these options should only appear after a command. ### `install` : Install . is usually the name of the formula to install, but it has other syntaxes which are listed in the [SPECIFYING FORMULAE](#specifying-formulae) section. ### `uninstall` : Uninstall . ### `list`: List all installed formulae. ### `search` (|`/``/`): Perform a substring search of cask tokens and formula names for . If is flanked by slashes, it is interpreted as a regular expression. The search for is extended online to `homebrew/core` and `homebrew/cask`. If no search term is provided, all locally available formulae are listed. ## COMMANDS <%= commands %> ## DEVELOPER COMMANDS <%= developer_commands %> ## GLOBAL OPTIONS <%= global_options %> ## OFFICIAL EXTERNAL COMMANDS <%= official_external_commands %> ## CUSTOM EXTERNAL COMMANDS Homebrew, like `git`(1), supports external commands. These are executable scripts that reside somewhere in the `PATH`, named `brew-` or `brew-``.rb`, which can be invoked like `brew` . This allows you to create your own commands without modifying Homebrew's internals. Instructions for creating your own commands can be found in the docs: ## SPECIFYING FORMULAE Many Homebrew commands accept one or more arguments. These arguments can take several different forms: * The name of a formula: e.g. `git`, `node`, `wget`. * The fully-qualified name of a tapped formula: Sometimes a formula from a tapped repository may conflict with one in `homebrew/core`. You can still access these formulae by using a special syntax, e.g. `homebrew/dupes/vim` or `homebrew/versions/node4`. * An arbitrary file: Homebrew can install formulae from a local path. It can point to either a formula file or a bottle. ## SPECIFYING CASKS Many Homebrew Cask commands accept one or more arguments. These can be specified the same way as the arguments described in `SPECIFYING FORMULAE` above. ## ENVIRONMENT Note that environment variables must have a value set to be detected. For example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. <%= environment_variables %> ## USING HOMEBREW BEHIND A PROXY Set the `http_proxy`, `https_proxy`, `all_proxy`, `ftp_proxy` and/or `no_proxy` environment variables documented above. For example, to use an unauthenticated HTTP or SOCKS5 proxy: export http_proxy=http://$HOST:$PORT export all_proxy=socks5://$HOST:$PORT And for an authenticated HTTP proxy: export http_proxy=http://$USER:$PASSWORD@$HOST:$PORT ## SEE ALSO Homebrew Documentation: Homebrew API: `git`(1), `git-log`(1) ## AUTHORS <%= lead.concat("\n") %> <%= plc.concat("\n") %> <%= tsc.concat("\n") %> <%= linux.concat("\n") %> <%= maintainers.concat("\n") %> <%= alumni.concat("\n") %> ## BUGS See our issues on GitHub: * **Homebrew/brew**: * **Homebrew/homebrew-core**: * **Homebrew/homebrew-cask**: