admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid e9f55a8f71
tests: default to API mode enabled. 
While we're here, also add `brew tests --no-parallel` which I relied
on during testing.

Pretty much anywhere we rely on a stubbed formula on disk to work: we
need to disable the API.
2025-06-10 15:53:27 +01:00
..
.bundle
…
aliases
aliases: fix missing require with Ruby 3.4
2025-04-16 17:03:40 +01:00
api
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
bundle
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
cask
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
cli
parser: show related env var in switch description
2025-06-03 13:57:42 -04:00
cmake
…
cmd
cmd/vendor-install: fix exit code handling for curl
2025-06-09 19:59:41 +01:00
completions
…
data
…
debrew
…
dev-cmd
tests: default to API mode enabled.
2025-06-10 15:53:27 +01:00
extend
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
formula-analytics
Merge pull request #19980 from Homebrew/dependabot/pip/Library/Homebrew/formula-analytics/setuptools-80.8.0
2025-05-20 21:06:45 +00:00
language
Homebrew 4.5 deprecations/disables/removals
2025-04-22 17:15:23 +01:00
livecheck
Bitbucket: update generated urls
2025-05-19 12:13:49 -04:00
manpages
parser: show related env var in switch description
2025-06-03 13:57:42 -04:00
os
Preliminary macOS 26 (Tahoe) support
2025-06-09 21:41:49 +01:00
requirements
cask/audit: skip audit_rosetta on Intel-only casks & OSes
2025-05-21 10:14:08 -04:00
rubocops
rubocops/cask/url: put keyword parameters on a new line
2025-06-05 10:53:34 -04:00
services
services: try multiple domains when stopping
2025-05-02 06:19:53 +01:00
shims
compilers: add gcc-15
2025-04-23 10:09:45 +02:00
sorbet
tests: default to API mode enabled.
2025-06-10 15:53:27 +01:00
standalone
standalone/init: cleanup respond_to? check
2025-05-02 01:40:13 +01:00
startup
Enable Bootsnap by default
2025-03-31 17:55:07 +01:00
test
tests: default to API mode enabled.
2025-06-10 15:53:27 +01:00
unpack_strategy
…
utils
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
vendor
Merge pull request #19981 from Homebrew/dependabot/bundler/Library/Homebrew/ruby-lsp-0.23.21
2025-05-20 21:07:21 +00:00
version
…
yard
…
.rspec_parallel
…
.rubocop.yml
Homebrew 4.5 deprecations/disables/removals
2025-04-22 17:15:23 +01:00
.ruby-version
Portable Ruby 3.4.4
2025-05-14 17:13:58 -07:00
.simplecov
…
.yardopts
…
abstract_command.rb
…
api_hashable.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
api.rb
Refactor OnSystem and SimulateSystem bottle tag handling
2025-06-03 11:57:17 -04:00
ast_constants.rb
no_autobump!: rename no_autobump_msg field to no_autobump_message
2025-04-29 18:04:59 +02:00
attestation.rb
Link to Support Tiers in diagnostic/error messages
2025-04-01 11:35:27 +01:00
autobump_constants.rb
autobump_constants: add :requires_manual_review reason
2025-05-27 21:48:58 +02:00
bottle_specification.rb
…
bottle.rb
…
brew_irbrc
…
brew.rb
Link to Support Tiers in diagnostic/error messages
2025-04-01 11:35:27 +01:00
brew.sh
Add brew mcp-server: a MCP server for Homebrew.
2025-06-03 15:22:33 +01:00
build_environment.rb
…
build_options.rb
…
build.rb
…
bump_version_parser.rb
…
bundle_version.rb
…
bundle.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
cachable.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
cache_store.rb
…
cask_dependent.rb
…
cask.rb
…
caveats.rb
Improve completions (and elisp) output in caveats
2025-06-06 17:09:28 +01:00
checksum.rb
…
cleaner.rb
…
cleanup.rb
…
command_path.sh
…
commands.rb
…
compilers.rb
compilers: add gcc-15
2025-04-23 10:09:45 +02:00
completions.rb
fix: prevent Zsh crashes related to autocompletion
2025-04-22 22:02:38 +02:00
context.rb
…
cxxstdlib.rb
…
debrew.rb
debrew: migrate away from mutex_m
2025-04-15 23:02:00 +01:00
dependable.rb
…
dependencies_helpers.rb
…
dependencies_helpers.rbi
…
dependencies.rb
…
dependencies.rbi
…
dependency_collector.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
dependency.rb
…
deprecate_disable.rb
deprecate!/disable!: remove non-typed replacement field
2025-04-21 21:13:25 +02:00
description_cache_store.rb
…
descriptions.rb
…
development_tools.rb
brew style --fix
2025-05-05 14:35:08 -07:00
diagnostic.rb
Link to Support Tiers in diagnostic/error messages
2025-04-01 11:35:27 +01:00
download_queue.rb
…
download_strategy.rb
Merge pull request #19885 from fidelity-contributions/github-16669
2025-05-20 13:35:11 +00:00
download_strategy.rbi
…
downloadable.rb
Cleanup Downloadable variables and types
2025-04-23 03:30:15 +01:00
env_config.rb
parser: show related env var in switch description
2025-06-03 13:57:42 -04:00
exceptions.rb
Link to Support Tiers in diagnostic/error messages
2025-04-01 11:35:27 +01:00
fetch.rb
…
formula_assertions.rb
…
formula_auditor.rb
audits: quote and reword problem description text
2025-05-30 23:49:26 -04:00
formula_cellar_checks.rb
formula_cellar_checks: add no_cpuid_allowlist
2025-04-12 12:40:38 -04:00
formula_creator.rb
formula_creator: tweak variable name
2025-05-30 14:55:50 +01:00
formula_free_port.rb
…
formula_info.rb
…
formula_installer.rb
tests: default to API mode enabled.
2025-06-10 15:53:27 +01:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
…
formula_support.rb
…
formula_versions.rb
…
formula.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
formulary.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
formulary.rbi
…
Gemfile
Portable Ruby 3.4.3
2025-04-22 11:50:08 -07:00
Gemfile.lock
Merge pull request #19981 from Homebrew/dependabot/bundler/Library/Homebrew/ruby-lsp-0.23.21
2025-05-20 21:07:21 +00:00
git_repository.rb
Homebrew 4.5 deprecations/disables/removals
2025-04-22 17:15:23 +01:00
github_packages.rb
…
github_releases.rb
…
github_runner_matrix.rb
github_runner_matrix: emulate plaform when sending compatible? requests
2025-05-01 23:25:23 +02:00
github_runner.rb
…
global.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
hardware.rb
…
head_software_spec.rb
Bump some files to Sorbet typed: strict
2025-04-27 22:45:44 +01:00
help.rb
…
help.sh
…
ignorable.rb
…
ignorable.rbi
…
install_renamed.rb
…
install.rb
applying brew tests, typecheck, style
2025-05-07 12:29:32 -04:00
installed_dependents.rb
…
items.sh
…
keg_relocate.rb
…
keg.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
keg.rbi
…
lazy_object.rb
lazy_object: fix __getobj__ signature
2025-05-02 01:26:58 +01:00
linkage_cache_store.rb
…
linkage_checker.rb
…
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
list.sh
…
livecheck.rb
Make os available in cask livecheck blocks
2025-04-04 09:17:32 -04:00
locale.rb
…
lock_file.rb
…
macos_runner_spec.rb
…
macos_version.rb
Preliminary macOS 26 (Tahoe) support
2025-06-09 21:41:49 +01:00
manpages.rb
…
mcp_server.rb
Add brew mcp-server: a MCP server for Homebrew.
2025-06-03 15:22:33 +01:00
messages.rb
Improve completions (and elisp) output in caveats
2025-06-06 17:09:28 +01:00
metafiles.rb
…
migrator.rb
…
missing_formula.rb
…
mktemp.rb
mktemp: drop include FileUtils
2025-04-16 16:22:36 +01:00
official_taps.rb
official_taps: deprecate homebrew-linux-fonts.
2025-04-28 08:36:04 +01:00
on_system.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
on_system.rbi
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
options.rb
…
options.rbi
…
os.rb
Link to Support Tiers in diagnostic/error messages
2025-04-01 11:35:27 +01:00
patch.rb
…
PATH.rb
…
pkg_version.rb
…
pkg_version.rbi
…
postinstall.rb
…
pour_bottle_check.rb
…
readall.rb
…
readline_nonblock.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
README.md
…
reinstall.rb
…
requirement.rb
…
requirements.rb
…
resource_auditor.rb
audits: quote and reword problem description text
2025-05-30 23:49:26 -04:00
resource.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
retryable_download.rb
Cleanup Downloadable variables and types
2025-04-23 03:30:15 +01:00
rubocops.rb
…
sandbox.rb
…
sbom.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
search.rb
…
service.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
settings.rb
…
shell_command.rb
…
simulate_system.rb
Refactor OnSystem and SimulateSystem bottle tag handling
2025-06-03 11:57:17 -04:00
software_spec.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
source_location.rb
…
standalone.rb
…
startup.rb
Enable Bootsnap by default
2025-03-31 17:55:07 +01:00
style.rb
…
system_command.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
system_config.rb
…
tab.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
tap_auditor.rb
tap_auditor: do not audit autobump.txt in official taps
2025-04-29 22:38:14 +02:00
tap_constants.rb
…
tap.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
tap.sh
…
test_runner_formula.rb
…
test.rb
…
uninstall.rb
uninstall: style suggestions
2025-05-21 17:54:21 +02:00
unlink.rb
…
unpack_strategy.rb
…
unversioned_cask_checker.rb
…
upgrade.rb
…
url.rb
…
utils.rb
…
version.rb
Phase out using cgi library
2025-05-13 01:33:14 +01:00
warnings.rb
…

README.md

Homebrew Ruby API

This is the API for Homebrew.

The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private.

You may also find the Formula Cookbook and Ruby Style Guide helpful in creating formulae.

Good luck!