admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Ruoyu Zhong c834a862ab
cmd/update-report: fix formula description display 
When on a non-default branch (for e.g., testing), `Formula[formula]` can
return an error. In that case let's silently ignore it.
2025-09-13 23:27:25 +08:00
..
.bundle
…
aliases
Refactor T.must called on .first
2025-08-25 20:27:47 -07:00
api
Download new API files once per Homebrew instance
2025-09-03 15:30:31 -04:00
bundle
Use type-safe blocks
2025-09-07 12:13:36 -07:00
cask
Merge pull request #20656 from Homebrew/copilot/fix-cask-rename-issue-linux
2025-09-12 08:49:14 +00:00
cli
Create DownloadQueue helper to check concurrency and initialize
2025-08-25 13:39:35 -04:00
cmake
…
cmd
cmd/update-report: fix formula description display
2025-09-13 23:27:25 +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
…
dev-cmd
Simplify pluralisation of common words
2025-09-12 09:02:43 +01:00
extend
Check host libstdc++ for brew gcc dependency
2025-09-12 14:15:56 -04:00
formula-analytics
build(deps): bump actions/attest-build-provenance in the all group
2025-08-29 08:18:14 +00:00
language
Refactor T.must called on .first
2025-08-25 20:27:47 -07:00
livecheck
Merge pull request #20613 from Homebrew/dug/typed-system-command
2025-09-08 07:32:58 +00:00
manpages
Remove docs saying that installing from a file is allowed
2025-09-05 10:58:33 +02:00
os
Check host libstdc++ for brew gcc dependency
2025-09-12 14:15:56 -04:00
requirements
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
rubocops
rubocop: replace :unsigned automatically
2025-08-23 13:13:48 +10:00
services
Enable strict typing in SystemCommand
2025-09-02 10:26:40 -07:00
shims
shims/super/cc: rpath-link glibc if indirect dep
2025-09-03 22:08:10 -04:00
sorbet
dev-cmd/contributions: add --team flag.
2025-09-11 11:36:48 +01:00
standalone
…
startup
output: express environment variables consistently
2025-08-04 09:50:06 -04:00
test
Check host libstdc++ for brew gcc dependency
2025-09-12 14:15:56 -04:00
unpack_strategy
Enable strict typing in SystemCommand
2025-09-02 10:26:40 -07:00
utils
Fix symlinked tap loading issue in cask loader
2025-09-12 09:02:43 +01:00
vendor
brew vendor-gems: commit updates.
2025-09-12 08:21:55 +00:00
version
brew style --fix
2025-08-13 12:23:12 -07:00
yard
Enable strict typing in yard extensions
2025-08-23 09:23:30 -07:00
.rspec_parallel
…
.rubocop.yml
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
.ruby-version
Portable Ruby 3.4.5
2025-07-16 08:58:14 -07:00
.simplecov
…
.yardopts
…
abstract_command.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
api_hashable.rb
…
api.rb
Download new API files once per Homebrew instance
2025-09-03 15:30:31 -04:00
ast_constants.rb
…
attestation.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01: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
Merge pull request #20525 from Homebrew/utils_output
2025-08-22 09:10:29 +00: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_environment: typed: strict
2025-09-11 06:26:01 +02:00
build_options.rb
build_options: typed: strict
2025-09-11 06:26:01 +02:00
build.rb
build: suggestions from @MikeMcQuaid
2025-09-11 06:26:01 +02:00
bump_version_parser.rb
bump: output lower upstream version
2025-09-05 16:24:59 -04:00
bundle_version.rb
…
bundle.rb
Enable strict typing in Kernel extensions + utils.rb
2025-08-23 18:44:36 -07:00
cachable.rb
…
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
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
cleanup.rb
Simplify pluralisation of common words
2025-09-12 09:02:43 +01:00
command_path.sh
…
commands.rb
Use type-safe blocks
2025-09-07 12:13:36 -07:00
compilers.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
completions.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
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
…
dependency_collector.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
dependency.rb
Use formula stubs for some dependency checking
2025-08-25 00:34:09 -04:00
deprecate_disable.rb
deprecate_disable: add unreachable reason
2025-09-11 21:12:24 -07:00
description_cache_store.rb
Use type-safe blocks
2025-09-07 12:13:36 -07:00
descriptions.rb
…
development_tools.rb
development_tools: make gcc_version public api
2025-09-03 20:35:20 -04:00
diagnostic.rb
diagnostic: fix undefined ohai method
2025-08-23 20:52:31 +08:00
download_queue.rb
Create DownloadQueue helper to check concurrency and initialize
2025-08-25 13:39:35 -04:00
download_strategy.rb
DownloadStrategyDetector: handle tangled.sh Git URLs
2025-09-01 08:12:37 -04:00
download_strategy.rbi
…
downloadable.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
env_config.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
exceptions.rb
Simplify pluralisation of common words
2025-09-12 09:02:43 +01:00
fetch.rb
…
formula_assertions.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
formula_auditor.rb
Allow head-only formulae in third party taps
2025-09-06 00:13:07 -04:00
formula_cellar_checks.rb
formula_cellar_checks: avoid changing name
2025-08-25 12:00:33 -04:00
formula_creator.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
formula_free_port.rb
…
formula_info.rb
…
formula_installer.rb
formula_installer: optlink even with cask installed
2025-09-12 12:24:14 -04:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
…
formula_stub.rb
Include aliases and renames in FormulaStub
2025-08-26 17:02:57 -04:00
formula_versions.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
formula.rb
Rename formula_support to keg_only reason, refactor slightly
2025-08-24 14:57:19 -07:00
formulary.rb
Fix symlinked tap loading issue in cask loader
2025-09-12 09:02:43 +01:00
Gemfile
…
Gemfile.lock
brew vendor-gems: commit updates.
2025-09-12 08:21:55 +00:00
git_repository.rb
Enable strict typing in Kernel extensions + utils.rb
2025-08-23 18:44:36 -07:00
github_packages.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
github_releases.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
github_runner_matrix.rb
Drop macOS Ventura CI in Homebrew/core
2025-09-11 17:55:38 -07:00
github_runner.rb
…
global.rb
…
hardware.rb
…
head_software_spec.rb
…
help.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
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
Simplify pluralisation of common words
2025-09-12 09:02:43 +01:00
installed_dependents.rb
…
items.sh
…
keg_only_reason.rb
keg_only_reason: typed: strict
2025-08-28 15:19:08 +02:00
keg_relocate.rb
keg_relocate: add more relocation paths
2025-09-05 14:48:12 +09:00
keg.rb
feat: update regex replace for pod2man
2025-08-28 21:01:19 +09:00
keg.rbi
…
lazy_object.rb
…
linkage_cache_store.rb
RubyDoc output fixes
2025-08-05 17:13:42 -04:00
linkage_checker.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
list.sh
…
livecheck.rb
…
locale.rb
locale: typed: strict
2025-08-28 15:20:54 +02:00
lock_file.rb
lock_file/simulate_system: typed: strict
2025-09-01 13:59:07 +01:00
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
manpages: fix type.
2025-08-22 14:31:59 +01:00
mcp_server.rb
mcp_server: add missing style changed argument.
2025-08-23 20:40:20 +01:00
messages.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
metafiles.rb
…
migrator.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
missing_formula.rb
Enable strict typing in Formulary
2025-08-24 12:58:48 -04:00
mktemp.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
official_taps.rb
Add additional brew contributions functionality.
2025-09-10 15:32:06 +01:00
on_system.rb
Fix type error in Readall
2025-07-27 10:07:34 -07:00
on_system.rbi
…
options.rb
…
options.rbi
…
os.rb
Check host libstdc++ for brew gcc dependency
2025-09-12 14:15:56 -04:00
patch.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
PATH.rb
Enable strict typing in Kernel extensions + utils.rb
2025-08-23 18:44:36 -07:00
pkg_version.rb
…
pkg_version.rbi
…
postinstall.rb
Make Pathname.prepend WriteMkpathExtension as late as possible.
2025-09-02 17:00:34 +01:00
pour_bottle_check.rb
More Sorbet typed: strict files
2025-08-19 13:03:08 +01:00
readall.rb
Enable strict typing in SystemCommand
2025-09-02 10:26:40 -07:00
readline_nonblock.rb
…
README.md
…
reinstall.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
requirement.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
requirements.rb
…
resource_auditor.rb
Remove temporary audit exception for lsr
2025-09-01 09:50:10 -04:00
resource.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
retryable_download.rb
Simplify pluralisation of common words
2025-09-12 09:02:43 +01:00
rubocops.rb
…
sandbox.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
sbom.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
search.rb
Simplify pluralisation of common words
2025-09-12 09:02:43 +01:00
service.rb
messages/comments: wording fixes
2025-08-16 00:57:59 -04:00
settings.rb
settings: typed: strict
2025-08-21 14:19:34 +08:00
shell_command.rb
…
simulate_system.rb
lock_file/simulate_system: typed: strict
2025-09-01 13:59:07 +01: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
Use type-safe blocks
2025-09-07 12:13:36 -07:00
system_command.rb
system_command: add missing must_succeed
2025-09-09 10:49:21 +08:00
system_config.rb
Enable strict typing in SystemCommand
2025-09-02 10:26:40 -07:00
tab.rb
…
tap_auditor.rb
…
tap_constants.rb
…
tap.rb
Simplify pluralisation of common words
2025-09-12 09:02:43 +01:00
tap.sh
…
test_runner_formula.rb
…
test.rb
Make Pathname.prepend WriteMkpathExtension as late as possible.
2025-09-02 17:00:34 +01:00
uninstall.rb
Move o* output methods to Utils::Output
2025-08-20 19:20:19 +01:00
unlink.rb
…
unpack_strategy.rb
Avoid repeated calls to affix checks
2025-08-31 11:11:41 -07:00
unversioned_cask_checker.rb
unversioned_cask_checker: process rename operations
2025-08-26 21:23:07 +08:00
upgrade.rb
Simplify pluralisation of common words
2025-09-12 09:02:43 +01:00
url.rb
…
utils.rb
Simplify pluralisation of common words
2025-09-12 09:02:43 +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!