Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Expand file tree

/

docs

/
Copy path

Directory actions

More options

More options

Directory actions

More options

More options

Latest commit

 

History

History
History
/

docs

/
Copy path

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
_layouts
_layouts
 
 
assets/img/docs
assets/img/docs
 
 
bin
bin
 
 
governance
governance
 
 
vale-styles/Homebrew
vale-styles/Homebrew
 
 
.mdl_ruleset.rb
.mdl_ruleset.rb
 
 
.mdl_style.rb
.mdl_style.rb
 
 
.mdlrc
.mdlrc
 
 
.rubocop.yml
.rubocop.yml
 
 
.ruby-version
.ruby-version
 
 
AGENTS.md
AGENTS.md
 
 
Acceptable-Casks.md
Acceptable-Casks.md
 
 
Acceptable-Formulae.md
Acceptable-Formulae.md
 
 
Adding-Software-to-Homebrew.md
Adding-Software-to-Homebrew.md
 
 
Analytics.md
Analytics.md
 
 
Autobump.md
Autobump.md
 
 
Bottles.md
Bottles.md
 
 
Brew-Bundle-and-Brewfile.md
Brew-Bundle-and-Brewfile.md
 
 
Brew-Livecheck.md
Brew-Livecheck.md
 
 
BrewTestBot-For-Maintainers.md
BrewTestBot-For-Maintainers.md
 
 
BrewTestBot.md
BrewTestBot.md
 
 
Brewfile
Brewfile
 
 
Building-Against-Non-Homebrew-Dependencies.md
Building-Against-Non-Homebrew-Dependencies.md
 
 
C++-Standard-Libraries.md
C++-Standard-Libraries.md
 
 
CNAME
CNAME
 
 
Cask-Cookbook.md
Cask-Cookbook.md
 
 
Checksum-Requirements.md
Checksum-Requirements.md
 
 
Command-Not-Found.md
Command-Not-Found.md
 
 
Common-Issues-for-Maintainers.md
Common-Issues-for-Maintainers.md
 
 
Common-Issues.md
Common-Issues.md
 
 
Creating-a-Homebrew-Issue.md
Creating-a-Homebrew-Issue.md
 
 
Custom-GCC-and-cross-compilers.md
Custom-GCC-and-cross-compilers.md
 
 
Deprecating-Disabling-and-Removing.md
Deprecating-Disabling-and-Removing.md
 
 
Expense-and-Reimbursement-Policy.md
Expense-and-Reimbursement-Policy.md
 
 
External-Commands.md
External-Commands.md
 
 
FAQ.md
FAQ.md
 
 
Formula-Cookbook.md
Formula-Cookbook.md
 
 
Gemfile
Gemfile
 
 
Gemfile.lock
Gemfile.lock
 
 
Homebrew-Governance-Archives.md
Homebrew-Governance-Archives.md
 
 
Homebrew-Governance.md
Homebrew-Governance.md
 
 
Homebrew-Leadership-Responsibilities.md
Homebrew-Leadership-Responsibilities.md
 
 
Homebrew-Security-and-Supply-Chain.md
Homebrew-Security-and-Supply-Chain.md
 
 
Homebrew-brew-Maintainer-Guide.md
Homebrew-brew-Maintainer-Guide.md
 
 
Homebrew-homebrew-cask-Maintainer-Guide.md
Homebrew-homebrew-cask-Maintainer-Guide.md
 
 
Homebrew-homebrew-core-Maintainer-Guide.md
Homebrew-homebrew-core-Maintainer-Guide.md
 
 
Homebrew-on-Linux.md
Homebrew-on-Linux.md
 
 
How-To-Open-a-Homebrew-Pull-Request.md
How-To-Open-a-Homebrew-Pull-Request.md
 
 
How-To-Organise-the-AGM.md
How-To-Organise-the-AGM.md
 
 
How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md
How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md
 
 
How-to-Create-and-Maintain-a-Tap.md
How-to-Create-and-Maintain-a-Tap.md
 
 
Installation.md
Installation.md
 
 
Interesting-Taps-and-Forks.md
Interesting-Taps-and-Forks.md
 
 
Kickstarter-Supporters.md
Kickstarter-Supporters.md
 
 
Language-Runtimes-and-Packages.md
Language-Runtimes-and-Packages.md
 
 
Language-Specific-Formulae.md
Language-Specific-Formulae.md
 
 
Licence-Guidelines.md
Licence-Guidelines.md
 
 
Linux-CI.md
Linux-CI.md
 
 
MCP-Server.md
MCP-Server.md
 
 
Maintainer-Guidelines.md
Maintainer-Guidelines.md
 
 
Maintainer-Stipends-and-Grants.md
Maintainer-Stipends-and-Grants.md
 
 
Maintainers-Avoiding-Burnout.md
Maintainers-Avoiding-Burnout.md
 
 
Manpage.md
Manpage.md
 
 
Migrating-A-Formula-To-A-Tap.md
Migrating-A-Formula-To-A-Tap.md
 
 
New-Maintainer-Checklist.md
New-Maintainer-Checklist.md
 
 
Package-Acceptance-Policy.md
Package-Acceptance-Policy.md
 
 
Prose-Style-Guidelines.md
Prose-Style-Guidelines.md
 
 
Querying-Brew.md
Querying-Brew.md
 
 
README.md
README.md
 
 
Rakefile
Rakefile
 
 
Releases.md
Releases.md
 
 
Rename-A-Formula.md
Rename-A-Formula.md
 
 
Reproducible-Builds.md
Reproducible-Builds.md
 
 
Responsible-AI-Usage.md
Responsible-AI-Usage.md
 
 
Shell-Completion.md
Shell-Completion.md
 
 
Support-Tiers.md
Support-Tiers.md
 
 
Tap-Trust.md
Tap-Trust.md
 
 
Taps.md
Taps.md
 
 
Tips-and-Tricks.md
Tips-and-Tricks.md
 
 
Troubleshooting.md
Troubleshooting.md
 
 
Typechecking.md
Typechecking.md
 
 
Updating-Software-in-Homebrew.md
Updating-Software-in-Homebrew.md
 
 
Versions.md
Versions.md
 
 
Working-with-Homebrew-as-an-Upstream-Project.md
Working-with-Homebrew-as-an-Upstream-Project.md
 
 
Xcode.md
Xcode.md
 
 
_config.yml
_config.yml
 
 
docs_rubocop_style.yml
docs_rubocop_style.yml
 
 
index.md
index.md
 
 
index.mdl_style.rb
index.mdl_style.rb
 
 
robots.txt
robots.txt
 
 

README.md

Outline
last_review_date 2026-06-08

Homebrew Documentation

These are the source files for the Homebrew documentation site.

A GitHub Action is run to validate each change before the site is deployed to GitHub Pages.

Usage

Open https://docs.brew.sh in your web browser.

To instead generate the site locally, available on http://localhost:4000, run:

cd $(brew --repository)/docs
brew bundle --install exec -- bundle install
bin/jekyll serve
Morty Proxy This is a proxified and sanitized view of the page, visit original site.