admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Mike McQuaid ed5805e50c
Add JSON API download strategy for download queue 
This fixes the weird/broken existing behaviour which was incorrectly
creating symlinks at download time. It also defers much more logic to
the original code.

For clarity, rename the existing `API::Download` class to
`API::SourceDownload`.

While we're here:
- add a/improve the `download_type` method on all `Downloadable`
  subclasses to improve download queue output format
- move some logic to `RetryDownload`
2025-07-22 17:48:32 +01:00
..
.bundle
…
aliases
Add docs for brew alias command
2025-07-15 13:34:49 -04:00
api
Add JSON API download strategy for download queue
2025-07-22 17:48:32 +01:00
bundle
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
cask
Add JSON API download strategy for download queue
2025-07-22 17:48:32 +01:00
cli
cli/named_args: don't warn about old tokens overlapping.
2025-06-25 17:24:35 +01:00
cmake
…
cmd
Improve Download Queue behaviour
2025-07-21 09:10:06 +01:00
completions
…
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
dispatch-build-bottle: use main branch
2025-07-21 10:24:23 +08:00
extend
env_script_all_files: don't overwrite existing stuff
2025-07-21 12:41:42 +08:00
formula-analytics
build(deps): bump certifi
2025-07-18 08:53:29 +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-07-19 00:31:02 +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 JSON API download strategy for download queue
2025-07-22 17:48:32 +01:00
unpack_strategy
…
utils
Audit no_autobump! reason for new packages
2025-07-17 17:12:33 +02:00
vendor
brew vendor-gems: commit updates.
2025-07-18 16:14:28 +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: require explicit opt-in.
2025-07-10 09:10:08 +01:00
autobump_constants.rb
autobump_constants: split NO_AUTOBUMP_REASONS_LIST
2025-06-25 15:31:18 +02:00
bottle_specification.rb
…
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_options.rb
…
build.rb
…
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
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
…
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
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
…
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
Add JSON API download strategy for download queue
2025-07-22 17:48:32 +01:00
download_strategy.rb
Optionally use DownloadQueue for brew install
2025-07-18 15:00:23 +01:00
download_strategy.rbi
…
downloadable.rb
Cleanup Downloadable variables and types
2025-04-23 03:30:15 +01:00
env_config.rb
Refactor DownloadQueue handling
2025-07-17 17:49:53 +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_auditor.rb
Audit no_autobump! reason for new packages
2025-07-17 17:12:33 +02: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
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
formula_installer: ignore bottle_tab_runtime_dependencies errors
2025-07-20 16:02:43 +01:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
…
formula_support.rb
…
formula_versions.rb
…
formula.rb
Refactor DownloadQueue handling
2025-07-17 17:49:53 +01:00
formulary.rb
formulary: make no_autobump! reason a symbol when needed
2025-07-17 17:16:37 +02:00
formulary.rbi
…
Gemfile
Portable Ruby 3.4.3
2025-04-22 11:50:08 -07:00
Gemfile.lock
Try updating platforms
2025-07-18 09:05:02 -07: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: 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
…
help.sh
…
ignorable.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
ignorable.rbi
…
install_renamed.rb
…
install.rb
Optionally use DownloadQueue for brew install
2025-07-18 15:00:23 +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
…
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
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
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
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
Refactor exec.rb type fixes
2025-06-29 09:02:24 -07:00
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
Update Library/Homebrew/reinstall.rb
2025-07-02 15:43:24 -04:00
requirement.rb
…
requirements.rb
…
resource_auditor.rb
audits: quote and reword problem description text
2025-05-30 23:49:26 -04:00
resource.rb
Add JSON API download strategy for download queue
2025-07-22 17:48:32 +01:00
retryable_download.rb
Add JSON API download strategy for download queue
2025-07-22 17:48:32 +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
…
service.rb
Cleanup extend/ directory usage.
2025-06-09 19:06:16 +01: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
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_auditor: do not audit autobump.txt in official taps
2025-04-29 22:38:14 +02:00
tap_constants.rb
…
tap.rb
Optionally parallelise API file downloads
2025-07-18 15:01:34 +01:00
tap.sh
…
test_runner_formula.rb
github_runner_matrix: fix skipped runner creation
2025-07-01 15:07:24 -04:00
test.rb
…
uninstall.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
unlink.rb
…
unpack_strategy.rb
…
unversioned_cask_checker.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
upgrade.rb
reject installed before to not print already up to date
2025-07-17 19:29:56 -04:00
url.rb
…
utils.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +01:00
version.rb
Fix RuboCop failures.
2025-07-14 19:12:38 +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!