admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
BrewTestBot 71d788e156
spdx: update license data. 
Autogenerated by [a scheduled GitHub Action](https://github.com/Homebrew/brew/blob/HEAD/.github/workflows/spdx.yml).
2025-06-25 00:18:16 +00:00
..
.bundle
…
aliases
…
api
cask: move some files to strict Sorbet sigil.
2025-06-17 14:56:10 +01:00
bundle
Revert "Make some of the bundle commands Sorbet typed: true"
2025-06-23 13:52:35 +01:00
cask
tab, cask/tab: add more Sorbet types and signatures.
2025-06-24 12:06:55 +01:00
cli
parser: show related env var in switch description
2025-06-03 13:57:42 -04:00
cmake
…
cmd
Merge pull request #20167 from Homebrew/update_report_display_descriptions
2025-06-24 20:26:47 +00:00
completions
…
data
spdx: update license data.
2025-06-25 00:18:16 +00:00
debrew
debrew: set typed: strict
2025-06-17 16:33:58 +01:00
dev-cmd
Merge pull request #20165 from Homebrew/more_tab_types
2025-06-24 20:27:11 +00:00
extend
Merge pull request #20151 from Homebrew/fix-doctor-linux
2025-06-22 10:10:28 +00:00
formula-analytics
build(deps): bump urllib3 in /Library/Homebrew/formula-analytics
2025-06-19 05:26:06 +00:00
language
language/*: fix *_SHEBANG_REGEX anchors
2025-06-23 20:32:55 +08: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
requirements: set typed: strict
2025-06-17 16:34:59 +01:00
rubocops
Switch to using main as the default branch
2025-06-24 11:14:57 +01:00
services
services: try multiple domains when stopping
2025-05-02 06:19:53 +01:00
shims
…
sorbet
Switch to using main as the default branch
2025-06-24 11:14:57 +01:00
standalone
standalone/init: cleanup respond_to? check
2025-05-02 01:40:13 +01:00
startup
…
test
Merge pull request #20167 from Homebrew/update_report_display_descriptions
2025-06-24 20:26:47 +00:00
unpack_strategy
…
utils
utils/github/api: fix Sorbet types.
2025-06-17 14:59:46 +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
…
.ruby-version
Portable Ruby 3.4.4
2025-05-14 17:13:58 -07:00
.simplecov
…
.yardopts
…
abstract_command.rb
…
api_hashable.rb
a*.rb: move to strict Sorbet sigil.
2025-06-17 08:18:33 +01:00
api.rb
a*.rb: move to strict Sorbet sigil.
2025-06-17 08:18:33 +01:00
ast_constants.rb
MacOSVersion: enable strong typing
2025-06-15 09:02:41 -04:00
attestation.rb
…
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
…
brew.sh
Switch to using main as the default branch
2025-06-24 11:14:57 +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
…
completions.rb
…
context.rb
…
cxxstdlib.rb
…
debrew.rb
…
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
…
description_cache_store.rb
…
descriptions.rb
…
development_tools.rb
Fix DevelopmentTools::ld64_version on macOS
2025-06-21 21:13:38 -04:00
diagnostic.rb
Remove redundant xattr doctor check on systems without quarantine support
2025-06-24 03:07:04 +00:00
download_queue.rb
Switch to using main as the default branch
2025-06-24 11:14:57 +01:00
download_strategy.rb
download_strategy: fix cvs checkouts
2025-06-22 14:38:19 -04:00
download_strategy.rbi
…
downloadable.rb
…
env_config.rb
parser: show related env var in switch description
2025-06-03 13:57:42 -04:00
exceptions.rb
…
fetch.rb
…
formula_assertions.rb
…
formula_auditor.rb
Switch to using main as the default branch
2025-06-24 11:14:57 +01:00
formula_cellar_checks.rb
Remove alias generic_* definitions in favour of using super
2025-06-16 08:10:08 +00:00
formula_creator.rb
Fix brew style "Prefer double-quoted strings"
2025-06-22 18:05:47 +03:00
formula_free_port.rb
…
formula_info.rb
…
formula_installer.rb
tab, cask/tab: add more Sorbet types and signatures.
2025-06-24 12:06:55 +01:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
…
formula_support.rb
…
formula_versions.rb
…
formula.rb
tab, cask/tab: add more Sorbet types and signatures.
2025-06-24 12:06:55 +01:00
formulary.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
formulary.rbi
…
Gemfile
…
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
…
github_packages.rb
…
github_releases.rb
…
github_runner_matrix.rb
Switch to using main as the default branch
2025-06-24 11:14:57 +01:00
github_runner.rb
…
global.rb
Add HOMEBREW_MACOS_NEWEST_SUPPORTED env var
2025-06-14 18:45:25 -04:00
hardware.rb
Remove alias generic_* definitions in favour of using super
2025-06-16 08:10:08 +00:00
head_software_spec.rb
…
help.rb
…
help.sh
…
ignorable.rb
…
ignorable.rbi
…
install_renamed.rb
…
install.rb
Remove alias generic_* definitions in favour of using super
2025-06-16 08:10:08 +00:00
installed_dependents.rb
…
items.sh
…
keg_relocate.rb
Remove alias generic_* definitions in favour of using super
2025-06-16 08:10:08 +00:00
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
Remove alias generic_* definitions in favour of using super
2025-06-16 08:10:08 +00:00
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
list.sh
…
livecheck.rb
…
locale.rb
…
lock_file.rb
…
macos_runner_spec.rb
…
macos_version.rb
MacOSVersion: enable strong typing
2025-06-15 09:02:41 -04:00
manpages.rb
…
mcp_server.rb
mcp_server: fix EOF handling.
2025-06-23 16:50:39 +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
Remove alias generic_* definitions in favour of using super
2025-06-16 08:10:08 +00:00
mktemp.rb
…
official_taps.rb
…
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
…
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
…
rubocops.rb
…
sandbox.rb
Remove more monkey-patching in extend/os
2025-06-21 21:34:20 -04:00
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
…
style.rb
…
system_command.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
system_config.rb
a*.rb: move to strict Sorbet sigil.
2025-06-17 08:18:33 +01:00
tab.rb
tab, cask/tab: add more Sorbet types and signatures.
2025-06-24 12:06:55 +01:00
tap_auditor.rb
…
tap_constants.rb
…
tap.rb
tap: rely on new autobump list
2025-06-18 16:16:08 +02: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!