admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Sam Ford 76a54d1455
bump-cask-pr: ensure new_cask has a url 
We sometimes see errors like "attempted to use a `Downloadable`
without a URL!" in the homebrew/cask autobump workflow log because
`bump-cask-pr` can simulate Linux even if a cask doesn't support it,
leading to this error. This is something that should be resolved in
the future once I finally wrap up my related work to detect OS/arch
requirements but this adds a simple guard to address this in the
interim time.
2025-08-13 10:01:49 -04:00
..
.bundle
…
aliases
Add docs for brew alias command
2025-07-15 13:34:49 -04:00
api
Create Homebrew::API::Internal
2025-08-12 02:40:48 -04:00
bundle
output: express environment variables consistently
2025-08-04 09:50:06 -04:00
cask
Use API helper methods
2025-08-12 17:04:15 -04:00
cli
Use API helper methods
2025-08-12 17:04:15 -04:00
cmake
…
cmd
Fetch new API
2025-08-12 17:04:15 -04:00
completions
…
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
bump-cask-pr: ensure new_cask has a url
2025-08-13 10:01:49 -04:00
extend
Implement pkg-config macOS SDK mismatch diagnostic check
2025-08-13 09:03:26 +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
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
manpages
Update cask definition
2025-08-05 11:12:01 +01:00
os
os/linux/elf: bump to typed: strict
2025-08-12 10:25:40 +08:00
requirements
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
rubocops
Merge pull request #20402 from Homebrew/head-url-must-always-specify-branch
2025-08-13 07:47:21 +00:00
services
service: ensure JSON cron output can be null.
2025-08-06 16:09:39 +01:00
shims
formula: improve variable naming
2025-08-13 14:27:04 +08:00
sorbet
sorbet: Update RBI files.
2025-08-13 00:30:32 +00:00
standalone
standalone/init: cleanup respond_to? check
2025-05-02 01:40:13 +01:00
startup
output: express environment variables consistently
2025-08-04 09:50:06 -04:00
test
Fix HEAD installations with HOMEBREW_FORBID_PACKAGES_FROM_PATHS
2025-08-13 17:57:55 +08:00
unpack_strategy
…
utils
Use API helper methods
2025-08-12 17:04:15 -04:00
vendor
brew vendor-gems: commit updates.
2025-07-25 16:10:50 +00:00
version
…
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
Add Homebrew::EnvConfig.use_internal_api?
2025-08-12 17:18:08 -04: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
…
bottle.rb
Improve Download Queue output
2025-08-04 15:51:02 +01:00
brew_irbrc
…
brew.rb
Fetch new API
2025-08-12 17:04:15 -04: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
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
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
output: express environment variables consistently
2025-08-04 09:50:06 -04:00
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
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
…
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
Reorders git options for uncommitted modifications nudge
2025-08-05 14:58:44 -04:00
download_queue.rb
download_queue: add missing require.
2025-08-08 08:33:26 +01:00
download_strategy.rb
handle false content_type
2025-08-06 11:45:53 -07:00
download_strategy.rbi
…
downloadable.rb
Improve Download Queue output
2025-08-04 15:51:02 +01:00
env_config.rb
Add Homebrew::EnvConfig.use_internal_api?
2025-08-12 17:18:08 -04: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
Audit no_autobump! reason for new packages
2025-07-17 17:12:33 +02:00
formula_cellar_checks.rb
RubyDoc output fixes
2025-08-05 17:13:42 -04: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
output: express environment variables consistently
2025-08-04 09:50:06 -04: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
…
formula.rb
Merge pull request #20402 from Homebrew/head-url-must-always-specify-branch
2025-08-13 07:47:21 +00:00
formulary.rb
Fix HEAD installations with HOMEBREW_FORBID_PACKAGES_FROM_PATHS
2025-08-13 17:57:55 +08:00
formulary.rbi
…
Gemfile
…
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
…
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
…
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
Improve test for bottling
2025-08-13 09:51:27 +08:00
keg.rb
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
keg.rbi
…
lazy_object.rb
lazy_object: fix __getobj__ signature
2025-05-02 01:26:58 +01:00
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
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
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
…
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
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
…
requirements.rb
…
resource_auditor.rb
Always suggest a HEAD branch name if we can find one
2025-08-11 13:46:49 +01:00
resource.rb
Improve Download Queue output
2025-08-04 15:51:02 +01:00
retryable_download.rb
download_queue: display hash of rejected download
2025-08-06 23:02:18 -04: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
Try non-nil params
2025-08-10 09:37:57 -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
Improve Download Queue output
2025-08-04 15:51:02 +01: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_auditor: do not audit autobump.txt in official taps
2025-04-29 22:38:14 +02:00
tap_constants.rb
…
tap.rb
Use API helper methods
2025-08-12 17:04:15 -04: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
Use API helper methods
2025-08-12 17:04:15 -04:00
unlink.rb
…
unpack_strategy.rb
…
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
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!