Index

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

• brew manual page (command documentation, also available with man brew)

• Homebrew Blog (news on major updates)

• Installation

• Support Tiers

• Troubleshooting

• FAQ (Frequently Asked Questions)

• Common Issues

• brew Shell Completion

• Command Not Found

• Homebrew on Linux

• Homebrew Bundle, brew bundle and Brewfile

• Homebrew MCP Server

• Bottles (binary packages)

• Taps (third-party repositories)

• Trusting Taps

• Homebrew Security and Supply Chain

• Interesting Taps and Forks

• Tips and Tricks

• Anonymous Analytics

• Querying brew

• C++ Standard Libraries

• Custom GCC and Cross-Compilers

• External Commands

• Language Runtimes and Packages

• Building Software with Homebrew Keg-Only Dependencies

• Creating a Homebrew Issue

• Updating Software in Homebrew

• Adding Software to Homebrew

Contributors

• How to Open a Pull Request (and get it merged)

• Responsible AI Usage

• Working with Homebrew as an Upstream Project

• Formula Cookbook

• Cask Cookbook

• Acceptable Formulae

• Acceptable Casks

• Package Acceptance Policy

• Licence Guidelines

• Checksum Requirements

• Formulae Versions

• Deprecating, Disabling and Removing

• Language-Specific Formulae

• 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

• Reproducible Builds

• Ruby API Documentation (e.g. for Formula, Cask etc.)

Maintainers

• New Maintainer Checklist

• Maintainers: Avoiding Burnout

• Maintainer Guidelines

• Homebrew/brew Maintainer Guide

• Homebrew/homebrew-core Maintainer Guide

• Homebrew/homebrew-cask Maintainer Guide

• BrewTestBot for Maintainers

• Common Issues for Maintainers

• Releases

• Linux CI

• Xcode

Governance

• Homebrew Governance
• Homebrew Leadership Responsibilities
• Homebrew Governance Archives
• Homebrew's Expense and Reimbursement Policy
• How To Organise the Homebrew AGM
• Homebrew's Maintainer Stipends and Grants

Project history

• Kickstarter Supporters