2025-02-03 10:59:02 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								---
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								last_review_date: "1970-01-01"
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								---
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2019-12-11 22:53:27 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								# Taps (Third-Party Repositories)
							 | 
						
					
						
							
								
									
										
										
										
											2017-01-04 16:16:00 -06:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								The `brew tap` command adds more repositories to the list of formulae that Homebrew tracks, updates,
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								and installs from. By default, `tap` assumes that the repositories come from GitHub,
							 | 
						
					
						
							
								
									
										
										
										
											2015-12-06 22:18:16 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								but the command isn't limited to any one location.
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2018-10-05 17:23:22 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								## The `brew tap` command
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* `brew tap` without arguments lists all currently tapped repositories. For
							 | 
						
					
						
							
								
									
										
										
										
											2015-06-14 14:34:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  example:
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2023-09-09 08:49:00 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  ```console
							 | 
						
					
						
							
								
									
										
										
										
											2021-08-06 12:52:36 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  $ brew tap
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  homebrew/cask
							 | 
						
					
						
							
								
									
										
										
										
											2021-08-06 12:52:36 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  homebrew/core
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  petere/postgresql
							 | 
						
					
						
							
								
									
										
										
										
											2021-08-06 12:52:36 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  ```
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2024-04-30 11:10:23 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* `brew tap <user>/<repo>` makes a clone of the repository at
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  `https://github.com/<user>/homebrew-<repo>` into `$(brew --repository)/Library/Taps`.
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  After that, `brew` will be able to work with those formulae as if they were in Homebrew's
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  [homebrew/core](https://github.com/Homebrew/homebrew-core) canonical repository.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  You can install and uninstall them with `brew [un]install`, and the formulae are
							 | 
						
					
						
							
								
									
										
										
										
											2015-06-14 14:34:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  automatically updated when you run `brew update`. (See below for details
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  about how `brew tap` handles the names of repositories.)
							 | 
						
					
						
							
								
									
										
										
										
											2021-08-06 12:52:36 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2024-04-30 11:10:23 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* `brew tap <user>/<repo> <URL>` makes a clone of the repository at _URL_.
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  Unlike the one-argument version, _URL_ is not assumed to be GitHub, and it
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  doesn't have to be HTTP. Any location and any protocol that Git can handle is
							 | 
						
					
						
							
								
									
										
										
										
											2025-05-04 23:49:02 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  fine.
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* `brew tap --repair` migrates tapped formulae from a symlink-based to
							 | 
						
					
						
							
								
									
										
										
										
											2015-06-14 14:34:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  directory-based structure. (This should only need to be run once.)
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2015-06-14 14:34:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* `brew untap user/repo [user/repo user/repo ...]` removes the given taps. The
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								  repositories are deleted and `brew` will no longer be aware of their formulae.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								  `brew untap` can handle multiple removals at once.
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2015-06-14 14:34:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								## Repository naming conventions and assumptions
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								On GitHub, your repository must be named `homebrew-something` to use
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								the one-argument form of `brew tap`. The prefix "homebrew-" is not optional.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								(The two-argument form doesn't have this limitation, but it forces you to
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								give the full URL explicitly.)
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								When you use `brew tap` on the command line, however, you can leave out the
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								"homebrew-" prefix in commands. That is, `brew tap username/foobar` can be used as a shortcut for the long
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								version: `brew tap username/homebrew-foobar`. `brew` will automatically add
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								back the "homebrew-" prefix whenever it's necessary.
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2019-05-09 12:43:51 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								## Formula with duplicate names
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-25 22:53:33 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								If your tap contains a formula that is also present in
							 | 
						
					
						
							
								
									
										
										
										
											2018-10-05 17:23:22 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								[homebrew/core](https://github.com/Homebrew/homebrew-core), that's fine,
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								but you would need to specify its fully qualified name in the form
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								`<user>/<repo>/<formula>` to install your version.
							 | 
						
					
						
							
								
									
										
										
										
											2015-06-14 14:34:31 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								Whenever a `brew install foo` command is issued, `brew` selects which formula
							 | 
						
					
						
							
								
									
										
										
										
											2015-07-27 18:51:53 +08:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								to use by searching in the following order:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-18 17:45:12 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* core formulae
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* other taps
							 | 
						
					
						
							
								
									
										
										
										
											2015-07-27 18:51:53 +08:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								If you need a formula to be installed from a particular tap, you can use fully
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								qualified names to refer to them.
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								If you were to create a tap for an alternative `vim` formula, the behaviour would be:
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-25 22:53:33 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								```sh
							 | 
						
					
						
							
								
									
										
										
										
											2016-04-02 20:22:58 +08:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								brew install vim                     # installs from homebrew/core
							 | 
						
					
						
							
								
									
										
										
										
											2018-10-05 17:23:22 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								brew install username/repo/vim       # installs from your custom repository
							 | 
						
					
						
							
								
									
										
										
										
											2014-10-26 14:54:36 +00:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								```
							 | 
						
					
						
							
								
									
										
										
										
											2015-07-27 18:51:53 +08:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								As a result, we recommend you give new names to customized formulae if you want to make
							 | 
						
					
						
							
								
									
										
										
										
											2019-05-09 12:43:51 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								them easier to install. Note that there is (intentionally) no way of replacing
							 | 
						
					
						
							
								
									
										
										
										
											2021-11-14 12:40:29 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								dependencies of core formulae with those from other taps.
							 |