admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Heath Stewart 222e8d129a
Document pwsh shell completion 
Based on discussion in #19408, update the documentation to specify that `:pwsh` must be passed explicitly and that it will translate to a "powershell" argument, as is currently supported by Go's common `github.com/spf13/cobra` module and Rust's common `clap` (with `clap_complete`) crate.
2025-03-04 02:16:48 -08:00
..
.bundle
…
aliases
Import brew alias and brew unalias commands
2025-02-07 14:31:50 +00:00
api
remove all references to JSON v3
2025-02-06 21:04:08 -08:00
cask
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
cli
Revert to_formulae_and_casks sig change
2025-02-16 15:41:57 -08:00
cmake
…
cmd
Enable strict typing in Formula
2025-02-24 10:23:42 -08:00
completions
feat: Add Bash completion for Homebrew aliases
2024-12-03 23:48:50 -05:00
data
spdx: update license data.
2024-12-31 00:15:10 +00:00
debrew
…
dev-cmd
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
extend
Enable strict typing in Formula
2025-02-24 10:23:42 -08:00
formula-analytics
Merge pull request #19395 from Homebrew/dependabot/pip/Library/Homebrew/formula-analytics/influxdb3-python-0.11.0
2025-02-27 19:08:50 +00:00
language
Enable strict typing in Formula
2025-02-24 10:23:42 -08:00
livecheck
Add interface for livecheck strategies
2025-02-26 16:45:39 -08:00
manpages
docs: prefer /opt/homebrew in examples
2025-02-03 15:30:03 +01:00
os
feat: add linux tests
2025-01-19 12:32:55 +01:00
requirements
…
rubocops
Add PowerShell (pwsh) completion support
2025-03-02 18:17:38 -08:00
shims
Add support for bottling Portable Ruby for ARM64 Linux
2025-01-19 17:06:32 +08:00
sorbet
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
standalone
Enforce finalized sorbet methods
2024-11-21 18:34:11 -08:00
startup
Import brew alias and brew unalias commands
2025-02-07 14:31:50 +00:00
test
Add PowerShell (pwsh) completion support
2025-03-02 18:17:38 -08:00
unpack_strategy
…
utils
Add PowerShell (pwsh) completion support
2025-03-02 18:17:38 -08:00
vendor
Merge pull request #19404 from Homebrew/dependabot/bundler/Library/Homebrew/sorbet-66760194a4
2025-03-02 05:48:00 +00:00
version
…
yard
…
.rspec_parallel
…
.rubocop.yml
…
.ruby-version
Portable Ruby 3.3.7
2025-01-16 15:12:03 -08:00
.simplecov
…
.yardopts
…
abstract_command.rb
…
api.rb
remove all references to JSON v3
2025-02-06 21:04:08 -08:00
ast_constants.rb
ast_constants: order deprecate! before disable!
2024-12-20 14:45:15 -05:00
attestation.rb
document the version that causes problems here
2024-12-05 14:16:30 -05:00
bottle_specification.rb
Update Library/Homebrew/formula.rb
2025-02-23 15:09:34 -08:00
bottle.rb
Split up SoftwareSpec
2025-02-04 16:27:39 +00:00
brew_irbrc
…
brew.rb
Fix handling of case-mistyped commands
2025-01-27 08:42:49 +00:00
brew.sh
fix: HOMEBREW_NO_SORBET_RUNTIME should work even if developer
2025-02-27 11:59:08 +08: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
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
Add PowerShell (pwsh) completion support
2025-03-02 18:17:38 -08:00
checksum.rb
…
cleaner.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
cleanup.rb
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
command_path.sh
…
commands.rb
…
compilers.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
completions.rb
Remove fish command completions for excluded commands
2024-11-20 17:35:42 -06:00
context.rb
…
cxxstdlib.rb
…
debrew.rb
Inline use of attr_predicate
2025-03-02 21:36:03 -08: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
Fix select_includes sig
2025-02-16 13:26:10 -08:00
dependency_collector.rb
…
dependency.rb
…
deprecate_disable.rb
deprecate_disable: typed: strict
2024-12-20 13:33:16 -05:00
description_cache_store.rb
…
descriptions.rb
brew style --fix
2024-11-26 14:09:13 -08:00
development_tools.rb
…
diagnostic.rb
Fix Rubocop warnings (without brew style --fix)
2025-02-28 09:59:32 +00:00
download_queue.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
download_strategy.rb
implement fixes and comments for DisableComment rubocop
2025-01-29 09:17:11 +00:00
download_strategy.rbi
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
downloadable.rb
…
env_config.rb
Add HOMEBREW_UPGRADE_GREEDY_CASKS
2025-02-25 15:34:49 +00:00
exceptions.rb
…
fetch.rb
…
formula_assertions.rb
…
formula_auditor.rb
formula_auditor: avoid pkg-config dependency in core tap
2024-12-02 21:46:51 -05:00
formula_cellar_checks.rb
Enable strict typing in Formula
2025-02-24 10:23:42 -08:00
formula_creator.rb
formula: add std_zig_args
2025-02-21 14:53:34 +01: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
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
formula_name_cask_token_auditor.rb
…
formula_path.sh
…
formula_pin.rb
…
formula_support.rb
…
formula_versions.rb
…
formula.rb
Document pwsh shell completion
2025-03-04 02:16:48 -08:00
formulary.rb
remove all references to JSON v3
2025-02-06 21:04:08 -08:00
formulary.rbi
…
Gemfile
Import brew formula-analytics and generate-analytics-api commands
2025-02-07 20:05:05 +00:00
Gemfile.lock
Merge pull request #19404 from Homebrew/dependabot/bundler/Library/Homebrew/sorbet-66760194a4
2025-03-02 05:48:00 +00:00
git_repository.rb
…
github_packages.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
github_releases.rb
…
github_runner_matrix.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
github_runner.rb
…
global.rb
Add support for Homebrew wrappers
2025-01-07 17:40:18 +00:00
hardware.rb
hardware: recognize 10 cores as deca
2025-01-18 18:40:21 -05:00
head_software_spec.rb
Split up SoftwareSpec
2025-02-04 16:27:39 +00:00
help.rb
…
help.sh
…
ignorable.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
ignorable.rbi
…
install_renamed.rb
…
install.rb
Add brew install --skip-link
2025-01-23 14:42:03 +00:00
installed_dependents.rb
…
items.sh
…
keg_relocate.rb
keg_relocate: fix error when dylib_id doesn't need changing
2024-10-26 06:31:05 +01:00
keg.rb
Add PowerShell (pwsh) completion support
2025-03-02 18:17:38 -08:00
keg.rbi
…
lazy_object.rb
implement fixes and comments for DisableComment rubocop
2025-01-29 09:17:11 +00:00
linkage_cache_store.rb
Resolve rubocop violations
2025-02-17 18:56:31 -08:00
linkage_checker.rb
…
linux_runner_spec.rb
…
linuxbrew-core-migration.rb
…
list.sh
…
livecheck.rb
Livecheck::Options: Rework as T::Struct
2025-02-25 10:56:32 -05: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
macos_version: define a method instead
2024-10-31 15:15:02 +08:00
manpages.rb
Namespace some top-level constants
2024-12-11 11:04:55 -08:00
messages.rb
…
metafiles.rb
…
migrator.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
missing_formula.rb
…
mktemp.rb
Add support for Homebrew wrappers
2025-01-07 17:40:18 +00:00
official_taps.rb
Import brew alias and brew unalias commands
2025-02-07 14:31:50 +00:00
options.rb
…
options.rbi
…
os.rb
glibc: set next version
2025-02-04 21:18:02 +01:00
patch.rb
patch: restore output from failed patch
2024-12-19 14:56:00 -05:00
PATH.rb
…
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
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
README.md
…
reinstall.rb
Merge pull request #19084 from Homebrew/add-comments-to-rubocop-disables
2025-01-13 11:32:31 +00:00
requirement.rb
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
requirements.rb
…
resource_auditor.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
resource.rb
Add interface for livecheck strategies
2025-02-26 16:45:39 -08:00
retryable_download.rb
…
rubocops.rb
…
sandbox.rb
Add support for Homebrew wrappers
2025-01-07 17:40:18 +00:00
sbom.rb
…
search.rb
fix(search.rb): fix regex regression in search
2025-02-28 09:33:32 -05:00
service.rb
Add missing utils/service require
2024-12-07 10:35:33 -08:00
settings.rb
…
shell_command.rb
…
simulate_system.rb
…
software_spec.rb
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
source_location.rb
…
standalone.rb
…
startup.rb
…
style.rb
Fix Rubocop warnings (without brew style --fix)
2025-02-28 09:59:32 +00:00
system_command.rb
Inline use of attr_predicate
2025-03-02 21:36:03 -08:00
system_config.rb
system_config: print brew branch
2024-11-25 23:06:40 +08:00
tab.rb
Merge pull request #19087 from Homebrew/installed_on_request_true
2025-01-13 09:36:05 +00:00
tap_auditor.rb
tap_auditor: check renamed formula exists
2024-11-09 12:02:03 -05:00
tap_constants.rb
…
tap.rb
remove all references to JSON v3
2025-02-06 21:04:08 -08:00
tap.sh
…
test_runner_formula.rb
…
test.rb
Add clarifying comments to rubocop:disables
2025-01-12 16:59:07 +00:00
uninstall.rb
uninstall: don't ignore deps even for developers
2024-11-18 00:13:12 +08:00
unlink.rb
…
unpack_strategy.rb
…
unversioned_cask_checker.rb
…
upgrade.rb
Fix usage of Tab#installed_(on_request|as_dependency)
2025-01-13 09:24:42 +00:00
url.rb
…
utils.rb
Move nil check inside demodulize
2025-02-24 11:57:20 -08:00
version.rb
Fix test
2025-02-17 19:11:48 -08: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!