brew README

The project's README from github.com/Homebrew/brew. As one markdown file: README.md.

🍺 Homebrew

See Homebrew's homepage at brew.sh for installation instructions, what homebrew does, packages, brew bundle and more.

Homebrew install demo

💸 Donations

Homebrew is a non-profit project run entirely by volunteers, not employees. We need your funds to pay for software, hardware and hosting around continuous integration and future improvements to the project. Every donation will be spent on making Homebrew better for our users.

Please consider a regular donation through GitHub Sponsors, Open Collective or Patreon. Homebrew is fiscally hosted by the Open Source Collective.

📚 Documentation

Read the Homebrew manual with man brew.

Read installation, troubleshooting, contribution including the FAQ on docs.brew.sh.

Read the Homebrew Blog for release notes, project updates and announcements.

📦 Packages

Find formulae, casks, dependencies, versions and package metadata on formulae.brew.sh.

View anonymised install, build and operating system usage data at formulae.brew.sh/analytics. Read how Homebrew uses Anonymous Analytics.

🔧 Get Help

First, please run brew update and run (and read) brew doctor.

Second, read the Troubleshooting Checklist.

If you don't read these it will take us far longer to help you with your problem.

After this, if you still need help, please ask in Homebrew/discussions or follow (and read) the Homebrew/brew new issue chooser.

Follow Homebrew on Mastodon, Bluesky, 𝕏 (Twitter) or subscribe to the newsletter.

🤝 Contributing

We'd love you to join us and >10,000 others by contributing to Homebrew!

First, please read our Contribution Guide and Code of Conduct.

A good starting point for contributing is:

brew tap --force homebrew/core or brew tap --force homebrew/cask (depending on whether you'd rather work on formulae or casks)
perform a strict audit on a package you use e.g. brew audit --strict ffmpeg for FFmpeg
if no warnings, run brew audit --strict to run on all packages and pick one to fix
read through the warnings and fix them until brew audit --strict <package> shows no results
submit a pull request with your fixes

Alternatively, for something more substantial, check out one of the open issues in Homebrew/brew, Homebrew/homebrew-core or Homebrew/homebrew-cask.

If you've had inspiration for a new feature or bug fix: we don't need you to open an issue first, just open a pull request with your implementation and we'll review it.

Good luck!

🔐 Security

Please see our security policy for how to report security issues and what is in scope.

👥 Who We Are

Homebrew's Project Leader is Mike McQuaid.

Homebrew's Lead Maintainers are Bevan Kay, Carlo Cabrera, Issy Long, Justin Krehel, Michael Cho, Mike McQuaid, Nanda H Krishna, Patrick Linnane, Rui Chen, Ruoyu Zhong, Sam Ford and Sean Molenaar.

Homebrew's other Maintainers are Andrew Nesbitt, Anton Melnikov, Bo Anderson, Branch Vincent, Caleb Xu, Daeho Ro, Douglas Eichelberger, Dustin Rodrigues, FX Coudert, Klaus Hipp, Markus Reiter, Michka Popoff, Štefan Baebler, Thierry Moisan and William Woodruff.

Homebrew was originally created by Max Howell.

📜 License

Code is under the BSD 2-clause "Simplified" License. Documentation is under the Creative Commons Attribution license.

💛 Sponsors

Our macOS continuous integration infrastructure is hosted by MacStadium's Orka.

Secure password storage and syncing is provided by 1Password for Teams.

https://brew.sh's DNS is resolving with DNSimple.

Homebrew is generously supported by Joshua Baer, Randy Reddig, Codecademy, b.well, Workbrew, GitHub, SAP and many other users and organisations via GitHub Sponsors.

Searching Database…

50K ·GitHub

What is this?

Homebrew is a free, open-source package manager that lets you install, update and manage command-line tools, libraries and apps on macOS and Linux straight from the terminal.

Is this a GUI app or a command-line tool?

It is entirely a terminal tool — you interact with it only through the brew command, documented in the Homebrew manual accessed via man brew.

How do I install Homebrew?

Follow the installation instructions on Homebrew's homepage at brew.sh, which also explains what Homebrew does and how packages and brew bundle work.

What should I do if something breaks?

Run brew update and then brew doctor and read its output first, then check the Troubleshooting Checklist — the maintainers ask for this before you open an issue or ask for help.

What is brew bundle for?

brew bundle lets you declare a whole set of packages (formulae, casks, taps, etc.) in a single Brewfile and install them all at once, mentioned alongside the main install docs on brew.sh.

Where do I find available packages?

All formulae, casks, dependencies, versions and metadata are listed at formulae.brew.sh, which also publishes anonymised install and usage analytics.

What are similar projects?

homebrew-cask, choco, veet, fpm, zerobrew, bashka, Scoop, miniforge

Which topics is it in?

package, oss, software, ruby, package-manager, installer, homebrew, sysadmin, bsd, utility, command-line, devops

Creator: Homebrew
Size: 126 MB
Stars: 50K
Updated: CommitOct 16 Release7.0.9Oct 08
Age: 10y
Commits · 90 Days