Start with installation,
man brew,
troubleshooting and
FAQ (Frequently Asked Questions) guides if you are new to Homebrew.
Documentation is grouped below by audience: users, contributors, maintainers and those interested in Homebrew’s governance.
Users
brewmanual page (command documentation, also available withman brew)- Homebrew Blog (news on major updates)
- Installation
- Support Tiers
- Troubleshooting
- FAQ (Frequently Asked Questions)
- Common Issues
brewShell Completion- Command Not Found
- Homebrew on Linux
- Homebrew Bundle,
brew bundleandBrewfile - Bottles (binary packages)
- Taps (third-party repositories)
- Trusting Taps
- Interesting Taps and Forks
- Tips and Tricks
- Querying
brew - C++ Standard Libraries
- MD5 and SHA-1 Deprecation
- Custom GCC and Cross Compilers
- External Commands
- Ruby Gems, Python Eggs and Perl Modules
- Java
- Python
- How to Build Software Outside Homebrew with Homebrew
keg_onlyDependencies - Creating a Homebrew Issue
- Updating Software in Homebrew
- Kickstarter Supporters
Contributors
- How to Open a Pull Request (and get it merged)
- Working with Homebrew as an Upstream Project
- Formula Cookbook
- Cask Cookbook
- Acceptable Formulae
- Acceptable Casks
- License Guidelines
- Formulae Versions
- Deprecating, Disabling and Removing
- Node for Formula Authors
- Python for Formula Authors
brew livecheck- Autobump
- Migrating a Formula to a Tap
- Renaming a Formula
- Building Against Non-Homebrew Dependencies
- How to Create and Maintain a Tap
- BrewTestBot
- Prose Style Guidelines
- Type Checking with Sorbet
- Ruby API Documentation (e.g. for
Formula,Casketc.)
Maintainers
- New Maintainer Checklist
- Maintainer Guidelines
- Homebrew/brew Maintainer Guide
- Homebrew/homebrew-core Maintainer Guide
- BrewTestBot for Maintainers
- Common Issues for Maintainers
- Linux CI