admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid e4e6185272
Merge pull request #20524 from Homebrew/fetch_api_files_refactoring 
Refactor Homebrew::API.fetch_api_files! to not take arguments.
2025-08-20 15:26:44 +00:00
..
.bundle
…
aliases
Add docs for brew alias command
2025-07-15 13:34:49 -04:00
api
api/formula: use correct method for allowing source path loads
2025-08-19 03:59:08 +01:00
bundle
More Sorbet typed: strict files
2025-08-19 13:03:08 +01:00
cask
Fix conflicts_with stanza odeprecated method call issue
2025-08-19 17:07:37 +01:00
cli
Use API helper methods
2025-08-12 17:04:15 -04:00
cmake
…
cmd
cmd/update-report: rework
2025-08-19 14:27:05 +08:00
completions
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
data
Revert "spdx: update license data."
2025-08-08 16:01:13 +08:00
debrew
debrew: set typed: strict
2025-06-17 16:33:58 +01:00
dev-cmd
Merge pull request #20524 from Homebrew/fetch_api_files_refactoring
2025-08-20 15:26:44 +00:00
extend
**/diagnostic.rb: add Sorbet strict sigil.
2025-08-19 09:10:24 +01:00
formula-analytics
.python-version: bump to 3.13
2025-08-13 10:12:39 -07:00
language
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
livecheck
cask: replace unsigned deprecation reason with fails_gatekeeper_check
2025-08-18 18:04:57 +10:00
manpages
Update cask definition
2025-08-05 11:12:01 +01:00
os
Improve quarantine support error messages with specific CLT guidance
2025-08-13 14:30:05 +01:00
requirements
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
rubocops
Implement SHA256 architecture audit as RuboCop rule
2025-08-19 14:45:01 +01:00
services
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
shims
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
sorbet
Enable loading stubbed formulae
2025-08-19 02:47:07 -04:00
standalone
…
startup
output: express environment variables consistently
2025-08-04 09:50:06 -04:00
test
Fix conflicts_with stanza odeprecated method call issue
2025-08-19 17:07:37 +01:00
unpack_strategy
…
utils
utils/wrapper.sh: fix source calls
2025-08-19 12:21:03 +08:00
vendor
brew vendor-gems: commit updates.
2025-08-15 09:58:56 +00:00
version
brew style --fix
2025-08-13 12:23:12 -07:00
yard
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
.rspec_parallel
…
.rubocop.yml
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
.ruby-version
Portable Ruby 3.4.5
2025-07-16 08:58:14 -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
Refactor Homebrew::API.fetch_api_files! to not take arguments.
2025-08-20 08:51:11 +01:00
ast_constants.rb
MacOSVersion: enable strong typing
2025-06-15 09:02:41 -04:00
attestation.rb
attestation: improve debug message.
2025-07-25 15:45:20 +00:00
autobump_constants.rb
autobump_constants: improve reason descriptions
2025-08-07 14:32:56 +02:00
bottle_specification.rb
Add more Sorbet types
2025-08-15 19:21:28 +01:00
bottle.rb
Improve Download Queue output
2025-08-04 15:51:02 +01:00
brew_irbrc
…
brew.rb
Refactor Homebrew::API.fetch_api_files! to not take arguments.
2025-08-20 08:51:11 +01:00
brew.sh
Merge remote-tracking branch 'origin/main' into stricter-brew-wrappers
2025-08-18 18:41:19 +08:00
build_environment.rb
…
build_options.rb
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
build.rb
Fix more HOMEBREW_FORBID_PACKAGES_FROM_PATHS issues
2025-08-14 19:35:11 +01:00
bump_version_parser.rb
…
bundle_version.rb
…
bundle.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +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
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
checksum.rb
…
cleaner.rb
…
cleanup.rb
Add more Sorbet types
2025-08-15 19:21:28 +01:00
command_path.sh
…
commands.rb
…
compilers.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
completions.rb
…
context.rb
…
cxxstdlib.rb
…
debrew.rb
…
dependable.rb
Add more Sorbet types
2025-08-15 19:21:28 +01:00
dependencies_helpers.rb
…
dependencies_helpers.rbi
…
dependencies.rb
…
dependencies.rbi
Update another overly narrow return type
2025-06-29 11:30:06 -07:00
dependency_collector.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
dependency.rb
Optionally use DownloadQueue for brew install
2025-07-18 15:00:23 +01:00
deprecate_disable.rb
cask/dsl: remap unsigned to fails_gatekeeper_check
2025-08-18 18:04:58 +10:00
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
diagnostic: fix error on verbose
2025-08-19 17:29:44 +01:00
download_queue.rb
download_queue: add missing require.
2025-08-08 08:33:26 +01:00
download_strategy.rb
Type remaining Kernel log extensions
2025-08-16 13:07:19 -07:00
download_strategy.rbi
…
downloadable.rb
Merge pull request #20474 from Homebrew/more_types
2025-08-15 18:40:12 +00:00
env_config.rb
Merge remote-tracking branch 'origin/main' into stricter-brew-wrappers
2025-08-18 18:41:19 +08:00
env_config.rbi
env_config: add auto option for download_concurrency
2025-07-29 15:15:37 +01:00
exceptions.rb
download_queue: display hash of rejected download
2025-08-06 23:02:18 -04:00
fetch.rb
…
formula_assertions.rb
formula_assertions: fix typechecking error in {shell,pipe}_output
2025-08-01 05:58:46 +08:00
formula_auditor.rb
Merge pull request #20485 from SMillerDev/feat/audit/codeberg_audit
2025-08-18 07:50:25 +00:00
formula_cellar_checks.rb
**/keg_relocate.rb: add set Sorbet typed: strict
2025-08-18 15:02:15 +01:00
formula_creator.rb
create: detect URL from latest release if it isn't archive
2025-06-26 15:07:51 +03:00
formula_free_port.rb
…
formula_info.rb
…
formula_installer.rb
Fix formula installs without a tab
2025-08-18 20:23:19 +01:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
…
formula_stub.rb
Create Homebrew::API::Internal
2025-08-12 02:40:48 -04:00
formula_support.rb
…
formula_versions.rb
Type remaining Kernel log extensions
2025-08-16 13:07:19 -07:00
formula.rb
Formula-Cookbook: document stable path variables
2025-08-19 09:04:12 -04:00
formulary.rb
Enable loading stubbed formulae
2025-08-19 02:47:07 -04:00
formulary.rbi
…
Gemfile
…
Gemfile.lock
brew vendor-gems: commit updates.
2025-08-15 09:58:56 +00:00
git_repository.rb
Deprecate/disable/remove code for Homebrew 4.6
2025-07-31 12:13:01 +01:00
github_packages.rb
…
github_releases.rb
…
github_runner_matrix.rb
github_runner_matrix: note about adding OS tags.
2025-07-16 17:22:33 +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
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
ignorable.rbi
brew style --fix
2025-08-13 12:23:12 -07:00
install_renamed.rb
Improve extend/* Sorbet typing
2025-07-31 17:31:27 +01:00
install.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
installed_dependents.rb
…
items.sh
…
keg_relocate.rb
Fix formula installs without a tab
2025-08-18 20:23:19 +01:00
keg.rb
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
keg.rbi
…
lazy_object.rb
…
linkage_cache_store.rb
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
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
Move formula analytics pretty name logic to MacOSVersion.
2025-08-18 16:57:20 +01:00
manpages.rb
…
mcp_server.rb
mcp_server: fix EOF handling.
2025-06-23 16:50:39 +01:00
messages.rb
Type remaining Kernel log extensions
2025-08-16 13:07:19 -07:00
metafiles.rb
…
migrator.rb
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
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
Fix type error in Readall
2025-07-27 10:07:34 -07:00
on_system.rbi
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
options.rb
…
options.rbi
…
os.rb
…
patch.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
PATH.rb
Refactor exec.rb type fixes
2025-06-29 09:02:24 -07:00
pkg_version.rb
…
pkg_version.rbi
…
postinstall.rb
Fix more HOMEBREW_FORBID_PACKAGES_FROM_PATHS issues
2025-08-14 19:35:11 +01:00
pour_bottle_check.rb
More Sorbet typed: strict files
2025-08-19 13:03:08 +01:00
readall.rb
Fix type error in Readall
2025-07-27 10:07:34 -07:00
readline_nonblock.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
README.md
…
reinstall.rb
Optionally use DownloadQueue for reinstall, upgrade.
2025-07-24 15:41:03 +01:00
requirement.rb
Remove unused 'which_all' Kernel ext
2025-08-16 16:18:26 -07:00
requirements.rb
…
resource_auditor.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
resource.rb
Add more Sorbet types
2025-08-15 19:21:28 +01:00
retryable_download.rb
download_queue: display hash of rejected download
2025-08-06 23:02:18 -04:00
rubocops.rb
…
sandbox.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
sbom.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
search.rb
…
service.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
settings.rb
…
shell_command.rb
…
simulate_system.rb
github_runner_matrix: fix skipped runner creation
2025-07-01 15:07:24 -04:00
software_spec.rb
software_spec: fix type signatures
2025-08-16 04:04:46 +08:00
source_location.rb
…
standalone.rb
…
startup.rb
…
style.rb
Replace ensure_formula_installed! with Formula#ensure_installed!
2025-08-02 03:43:37 +08:00
system_command.rb
output: express environment variables consistently
2025-08-04 09:50:06 -04: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
cask: replace unsigned deprecation reason with fails_gatekeeper_check
2025-08-18 18:04:57 +10:00
tap.sh
…
test_runner_formula.rb
github_runner_matrix: fix skipped runner creation
2025-07-01 15:07:24 -04:00
test.rb
Fix more HOMEBREW_FORBID_PACKAGES_FROM_PATHS issues
2025-08-14 19:35:11 +01:00
uninstall.rb
Use API helper methods
2025-08-12 17:04:15 -04:00
unlink.rb
…
unpack_strategy.rb
brew style --fix
2025-08-13 12:23:12 -07:00
unversioned_cask_checker.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
upgrade.rb
output: express environment variables consistently
2025-08-04 09:50:06 -04:00
url.rb
…
utils.rb
Improve extend/* Sorbet typing
2025-07-31 17:31:27 +01:00
version.rb
messages/comments: formatting fixes
2025-08-16 00:54:50 -04: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!