admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Carlo Cabrera f5bddacf0c
Merge pull request #20345 from Homebrew/assertions-typecheck 
formula_assertions: fix typechecking error in `{shell,pipe}_output`
2025-08-01 10:09:39 +00:00
..
.bundle
…
aliases
Add docs for brew alias command
2025-07-15 13:34:49 -04:00
api
api: fix handling of source downloads
2025-07-31 05:40:40 +01:00
bundle
Deprecate/disable/remove code for Homebrew 4.6
2025-07-31 12:13:01 +01:00
cask
Merge pull request #20343 from Homebrew/fix_uri_parser_warning
2025-07-31 13:38:39 +00:00
cli
Enable strict typing in Cask::Audit
2025-07-30 12:43:32 -07:00
cmake
…
cmd
fix: Add missing env var mention on upgrade help page
2025-07-30 21:37:23 +00:00
completions
feat: Add Bash completion for Homebrew aliases
2024-12-03 23:48:50 -05:00
data
spdx: update license data.
2025-07-02 00:17:54 +00:00
debrew
debrew: set typed: strict
2025-06-17 16:33:58 +01:00
dev-cmd
Deprecate/disable/remove code for Homebrew 4.6
2025-07-31 12:13:01 +01:00
extend
Improve extend/* Sorbet typing
2025-07-31 17:31:27 +01:00
formula-analytics
build(deps): bump certifi
2025-07-25 09:12:24 +00:00
language
Merge branch 'main' into py3-whl
2025-07-16 11:32:22 -04:00
livecheck
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
manpages
parser: show related env var in switch description
2025-06-03 13:57:42 -04:00
os
Improve some Pathname instance variable handling
2025-07-11 08:02:27 +00:00
requirements
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
rubocops
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
services
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
shims
compilers: add gcc-15
2025-04-23 10:09:45 +02:00
sorbet
sorbet: Update RBI files.
2025-08-01 00:37:45 +00: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
Add Cask install/upgrade/reinstall support for download queue
2025-07-30 08:18:35 +01:00
unpack_strategy
unpack .dmg: ignore .HFS+ Private* metadata directories
2025-03-18 12:59:21 +01:00
utils
Deprecate/disable/remove code for Homebrew 4.6
2025-07-31 12:13:01 +01:00
vendor
brew vendor-gems: commit updates.
2025-07-25 16:10:50 +00:00
version
…
yard
…
.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
Add JSON API download strategy for download queue
2025-07-22 17:48:32 +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: split NO_AUTOBUMP_REASONS_LIST
2025-06-25 15:31:18 +02:00
bottle_specification.rb
Fix bottle block generation and audit for arm64 Linux
2025-03-18 16:10:43 +08:00
bottle.rb
Add JSON API download strategy for download queue
2025-07-22 17:48:32 +01:00
brew_irbrc
…
brew.rb
Improve Download Queue behaviour
2025-07-21 09:10:06 +01:00
brew.sh
Switch to using main as the default branch
2025-06-24 11:14:57 +01:00
build_environment.rb
build_environment: pass http_proxy env vars through to build env
2025-01-13 19:35:31 +00:00
build_options.rb
…
build.rb
Merge pull request #19174 from alebcay/pod2man-shim
2025-02-26 13:55:34 +00:00
bump_version_parser.rb
bump: skip PR checking when up to date
2024-11-24 20:50:37 -05:00
bundle_version.rb
Bump more files to Sorbet typed: strict
2025-01-11 00:11:27 +00:00
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
Bump more files to Sorbet typed: strict
2025-01-11 00:11:27 +00:00
cask.rb
…
caveats.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
checksum.rb
…
cleaner.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
cleanup.rb
cleanup: don't warn when loading a renamed cask.
2025-07-15 14:22:38 +01:00
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
cxxstdlib: typed: strong
2024-09-26 14:32:55 -04:00
debrew.rb
debrew: migrate away from mutex_m
2025-04-15 23:02:00 +01:00
dependable.rb
…
dependencies_helpers.rb
Fix type error in DependenciesHelpers#dependents
2025-02-18 20:48:56 -08:00
dependencies_helpers.rbi
Enable strict typing in DependenciesHelpers
2025-02-16 12:24:22 -08:00
dependencies.rb
Enable strict typing in DependenciesHelpers
2025-02-16 12:24:22 -08:00
dependencies.rbi
Update another overly narrow return type
2025-06-29 11:30:06 -07:00
dependency_collector.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
dependency.rb
Optionally use DownloadQueue for brew install
2025-07-18 15:00:23 +01:00
deprecate_disable.rb
deprecate!/disable!: remove non-typed replacement field
2025-04-21 21:13:25 +02:00
description_cache_store.rb
…
descriptions.rb
brew style --fix
2024-11-26 14:09:13 -08:00
development_tools.rb
Fix DevelopmentTools::ld64_version on macOS
2025-06-21 21:13:38 -04:00
diagnostic.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
download_queue.rb
download_queue: fix bottle manifest handling.
2025-07-29 12:42:13 +01:00
download_strategy.rb
Fix URI parser warning
2025-07-31 12:21:19 +01:00
download_strategy.rbi
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
downloadable.rb
Cleanup Downloadable variables and types
2025-04-23 03:30:15 +01:00
env_config.rb
Document HOMEBREW_DOWNLOAD_CONCURRENCY environment variable
2025-07-31 12:18:08 +01:00
env_config.rbi
env_config: add auto option for download_concurrency
2025-07-29 15:15:37 +01: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_assertions: fix typechecking error in {shell,pipe}_output
2025-08-01 05:58:46 +08:00
formula_auditor.rb
Audit no_autobump! reason for new packages
2025-07-17 17:12:33 +02:00
formula_cellar_checks.rb
Reduce shape variations in Homebrew::Service
2025-07-28 17:03:43 -07: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
Bump more files to Sorbet typed: strict
2025-01-11 00:11:27 +00:00
formula_installer.rb
formula*: add source download support for download queue.
2025-07-29 13:48:43 +01:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
formula_pin: typed: strict
2024-09-26 14:48:32 -04:00
formula_support.rb
…
formula_versions.rb
…
formula.rb
Improve extend/* Sorbet typing
2025-07-31 17:31:27 +01:00
formulary.rb
Fix URI parser warning
2025-07-31 12:21:19 +01:00
formulary.rbi
…
Gemfile
Portable Ruby 3.4.3
2025-04-22 11:50:08 -07:00
Gemfile.lock
Downgrade to Bundler 2.6.8
2025-07-25 17:06:11 +01:00
git_repository.rb
Deprecate/disable/remove code for Homebrew 4.6
2025-07-31 12:13:01 +01:00
github_packages.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
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
Bump some files to Sorbet typed: strict
2025-04-27 22:45:44 +01:00
help.rb
Bump more files to Sorbet typed: strict
2024-10-06 20:04:42 +01:00
help.sh
…
ignorable.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
ignorable.rbi
…
install_renamed.rb
Improve extend/* Sorbet typing
2025-07-31 17:31:27 +01:00
install.rb
Improve extend/* Sorbet typing
2025-07-31 17:31:27 +01:00
installed_dependents.rb
…
items.sh
…
keg_relocate.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
keg.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01:00
keg.rbi
Fix tests
2024-10-05 12:18:29 -07:00
lazy_object.rb
lazy_object: fix __getobj__ signature
2025-05-02 01:26:58 +01:00
linkage_cache_store.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08: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
Make os available in cask livecheck blocks
2025-04-04 09:17:32 -04:00
locale.rb
Fix Rubocop warnings (without brew style --fix)
2025-02-28 09:59:32 +00:00
lock_file.rb
Prevent race condition when deleting lock files.
2024-11-24 01:29:42 +01:00
macos_runner_spec.rb
…
macos_version.rb
MacOSVersion: enable strong typing
2025-06-15 09:02:41 -04:00
manpages.rb
Namespace some top-level constants
2024-12-11 11:04:55 -08:00
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
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
missing_formula.rb
Remove alias generic_* definitions in favour of using super
2025-06-16 08:10:08 +00:00
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
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
Link to Support Tiers in diagnostic/error messages
2025-04-01 11:35:27 +01:00
patch.rb
patch: restore output from failed patch
2024-12-19 14:56:00 -05:00
PATH.rb
Refactor exec.rb type fixes
2025-06-29 09:02:24 -07:00
pkg_version.rb
pkg_version: make typed: strict
2024-12-05 14:01:37 +00:00
pkg_version.rbi
…
postinstall.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
pour_bottle_check.rb
Split up SoftwareSpec
2025-02-04 16:27:39 +00: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
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
requirements.rb
…
resource_auditor.rb
audits: quote and reword problem description text
2025-05-30 23:49:26 -04:00
resource.rb
Deprecate/disable/remove code for Homebrew 4.6
2025-07-31 12:13:01 +01:00
retryable_download.rb
retryable_download: ensure HOMEBREW_CELLAR exists.
2025-07-29 12:19:38 +01:00
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
fix(search.rb): fix regex regression in search
2025-02-28 09:33:32 -05:00
service.rb
Fix specs
2025-07-28 21:14:23 -07: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
Add JSON API download strategy for download queue
2025-07-22 17:48:32 +01:00
source_location.rb
…
standalone.rb
…
startup.rb
Enable Bootsnap by default
2025-03-31 17:55:07 +01:00
style.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
system_command.rb
Make --debug output a bit quieter by default
2025-07-25 17:14:46 +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_auditor: do not audit autobump.txt in official taps
2025-04-29 22:38:14 +02:00
tap_constants.rb
dev-cmd/bump-formula-pr: always use full git repo as tap remote
2024-10-15 10:20:58 +02:00
tap.rb
Deprecate/disable/remove code for Homebrew 4.6
2025-07-31 12:13:01 +01:00
tap.sh
tap.sh: tweak naming
2024-09-25 16:49:46 +08:00
test_runner_formula.rb
github_runner_matrix: fix skipped runner creation
2025-07-01 15:07:24 -04:00
test.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
uninstall.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
unlink.rb
…
unpack_strategy.rb
unpack_strategy/directory: use mv for nested unpack
2024-10-20 11:29:30 -04:00
unversioned_cask_checker.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
upgrade.rb
Optionally use DownloadQueue for reinstall, upgrade.
2025-07-24 15:41:03 +01:00
url.rb
refactor: Enable strict typing in download_strategy
2025-03-12 15:15:20 -07:00
utils.rb
Improve extend/* Sorbet typing
2025-07-31 17:31:27 +01:00
version.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
warnings.rb
warnings: typed: strict
2024-09-27 12:31:59 -04:00

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!