Module: Homebrew::EnvConfig Private
- Defined in:
- env_config.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Helper module for querying Homebrew-specific environment variables.
Constant Summary collapse
- ENVS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
{ HOMEBREW_ADDITIONAL_GOOGLE_ANALYTICS_ID: { description: "Additional Google Analytics tracking ID to emit user behaviour analytics to. " \ "For more information, see: <https://docs.brew.sh/Analytics>", }, HOMEBREW_API_DOMAIN: { description: "Use this URL as the download mirror for Homebrew JSON API. " \ "If metadata files at that URL are temporarily unavailable, " \ "the default API domain will be used as a fallback mirror.", default_text: "`https://formulae.brew.sh/api`.", default: HOMEBREW_API_DEFAULT_DOMAIN, }, HOMEBREW_ARCH: { description: "Linux only: Pass this value to a type name representing the compiler's `-march` option.", default: "native", }, HOMEBREW_ARTIFACT_DOMAIN: { description: "Prefix all download URLs, including those for bottles, with this value. " \ "For example, `HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080` will cause a " \ "formula with the URL `https://example.com/foo.tar.gz` to instead download from " \ "`http://localhost:8080/https://example.com/foo.tar.gz`. " \ "Bottle URLs however, have their domain replaced with this prefix. " \ "This results in e.g. " \ "`https://ghcr.io/v2/homebrew/core/gettext/manifests/0.21` " \ "to instead be downloaded from " \ "`http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21`", }, HOMEBREW_API_AUTO_UPDATE_SECS: { description: "Check Homebrew's API for new formulae or cask data every " \ "`HOMEBREW_API_AUTO_UPDATE_SECS` seconds. Alternatively, disable API auto-update " \ "checks entirely with HOMEBREW_NO_AUTO_UPDATE.", default: 450, }, HOMEBREW_AUTO_UPDATE_SECS: { description: "Run `brew update` once every `HOMEBREW_AUTO_UPDATE_SECS` seconds before some commands, " \ "e.g. `brew install`, `brew upgrade` and `brew tap`. Alternatively, " \ "disable auto-update entirely with `HOMEBREW_NO_AUTO_UPDATE`.", default_text: "86400 (24 hours), 3600 (1 hour) if a developer command has been run " \ "or 300 (5 minutes) if `HOMEBREW_NO_INSTALL_FROM_API` is set.", }, HOMEBREW_AUTOREMOVE: { description: "If set, calls to `brew cleanup` and `brew uninstall` will automatically " \ "remove unused formula dependents and if `HOMEBREW_NO_INSTALL_CLEANUP` is not set, " \ "`brew cleanup` will start running `brew autoremove` periodically.", boolean: true, }, HOMEBREW_BAT: { description: "If set, use `bat` for the `brew cat` command.", boolean: true, }, HOMEBREW_BAT_CONFIG_PATH: { description: "Use this as the `bat` configuration file.", default_text: "`$BAT_CONFIG_PATH`.", }, HOMEBREW_BAT_THEME: { description: "Use this as the `bat` theme for syntax highlighting.", default_text: "`$BAT_THEME`.", }, HOMEBREW_BOOTSNAP: { description: "If set, use Bootsnap to speed up repeated `brew` calls. " \ "A no-op when using Homebrew's vendored, relocatable Ruby on macOS (as it doesn't work).", boolean: true, }, HOMEBREW_BOTTLE_DOMAIN: { description: "Use this URL as the download mirror for bottles. " \ "If bottles at that URL are temporarily unavailable, " \ "the default bottle domain will be used as a fallback mirror. " \ "For example, `HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080` will cause all bottles to " \ "download from the prefix `http://localhost:8080/`. " \ "If bottles are not available at `HOMEBREW_BOTTLE_DOMAIN` " \ "they will be downloaded from the default bottle domain.", default_text: "`https://ghcr.io/v2/homebrew/core`.", default: HOMEBREW_BOTTLE_DEFAULT_DOMAIN, }, HOMEBREW_BREW_GIT_REMOTE: { description: "Use this URL as the Homebrew/brew `git`(1) remote.", default: HOMEBREW_BREW_DEFAULT_GIT_REMOTE, }, HOMEBREW_BROWSER: { description: "Use this as the browser when opening project homepages.", default_text: "`$BROWSER` or the OS's default browser.", }, HOMEBREW_CACHE: { description: "Use this directory as the download cache.", default_text: "macOS: `$HOME/Library/Caches/Homebrew`, " \ "Linux: `$XDG_CACHE_HOME/Homebrew` or `$HOME/.cache/Homebrew`.", default: HOMEBREW_DEFAULT_CACHE, }, HOMEBREW_CASK_OPTS: { description: "Append these options to all `cask` commands. All `--*dir` options, " \ "`--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are supported. " \ "For example, you might add something like the following to your " \ "`~/.profile`, `~/.bash_profile`, or `~/.zshenv`:" \ '\n\n `export HOMEBREW_CASK_OPTS="--appdir=~/Applications --fontdir=/Library/Fonts"`', }, HOMEBREW_CLEANUP_MAX_AGE_DAYS: { description: "Cleanup all cached files older than this many days.", default: 120, }, HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS: { description: "If set, `brew install`, `brew upgrade` and `brew reinstall` will cleanup all formulae " \ "when this number of days has passed.", default: 30, }, HOMEBREW_COLOR: { description: "If set, force colour output on non-TTY outputs.", boolean: true, }, HOMEBREW_CORE_GIT_REMOTE: { description: "Use this URL as the Homebrew/homebrew-core `git`(1) remote.", default_text: "`https://github.com/Homebrew/homebrew-core`.", default: HOMEBREW_CORE_DEFAULT_GIT_REMOTE, }, HOMEBREW_CURL_PATH: { description: "Linux only: Set this value to a new enough `curl` executable for Homebrew to use.", default: "curl", }, HOMEBREW_CURL_RETRIES: { description: "Pass the given retry count to `--retry` when invoking `curl`(1).", default: 3, }, HOMEBREW_CURL_VERBOSE: { description: "If set, pass `--verbose` when invoking `curl`(1).", boolean: true, }, HOMEBREW_CURLRC: { description: "If set, do not pass `--disable` when invoking `curl`(1), which disables the " \ "use of `curlrc`.", boolean: true, }, HOMEBREW_DEBUG: { description: "If set, always assume `--debug` when running commands.", boolean: true, }, HOMEBREW_DEVELOPER: { description: "If set, tweak behaviour to be more relevant for Homebrew developers (active or " \ "budding) by e.g. turning warnings into errors.", boolean: true, }, HOMEBREW_DISABLE_LOAD_FORMULA: { description: "If set, refuse to load formulae. This is useful when formulae are not trusted (such " \ "as in pull requests).", boolean: true, }, HOMEBREW_DISPLAY: { description: "Use this X11 display when opening a page in a browser, for example with " \ "`brew home`. Primarily useful on Linux.", default_text: "`$DISPLAY`.", }, HOMEBREW_DISPLAY_INSTALL_TIMES: { description: "If set, print install times for each formula at the end of the run.", boolean: true, }, HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN: { description: "Use this base64 encoded username and password for authenticating with a Docker registry " \ "proxying GitHub Packages. If `HOMEBREW_DOCKER_REGISTRY_TOKEN` is set, it will be used instead.", }, HOMEBREW_DOCKER_REGISTRY_TOKEN: { description: "Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. " \ "Preferred over `HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN`.", }, HOMEBREW_EDITOR: { description: "Use this editor when editing a single formula, or several formulae in the " \ "same directory." \ "\n\n *Note:* `brew edit` will open all of Homebrew as discontinuous files " \ "and directories. Visual Studio Code can handle this correctly in project mode, but many " \ "editors will do strange things in this case.", default_text: "`$EDITOR` or `$VISUAL`.", }, HOMEBREW_EVAL_ALL: { description: "If set, `brew` commands evaluate all formulae and casks, executing their arbitrary code, by " \ "default without requiring --eval-all. Required to cache formula and cask descriptions.", boolean: true, }, HOMEBREW_FAIL_LOG_LINES: { description: "Output this many lines of output on formula `system` failures.", default: 15, }, HOMEBREW_FORBIDDEN_LICENSES: { description: "A space-separated list of licenses. Homebrew will refuse to install a " \ "formula if it or any of its dependencies has a license on this list.", }, HOMEBREW_FORCE_BREWED_CA_CERTIFICATES: { description: "If set, always use a Homebrew-installed `ca-certificates` rather than the system version. " \ "Automatically set if the system version is too old.", boolean: true, }, HOMEBREW_FORCE_BREWED_CURL: { description: "If set, always use a Homebrew-installed `curl`(1) rather than the system version. " \ "Automatically set if the system version of `curl` is too old.", boolean: true, }, HOMEBREW_FORCE_BREWED_GIT: { description: "If set, always use a Homebrew-installed `git`(1) rather than the system version. " \ "Automatically set if the system version of `git` is too old.", boolean: true, }, HOMEBREW_FORCE_VENDOR_RUBY: { description: "If set, always use Homebrew's vendored, relocatable Ruby version even if the system version " \ "of Ruby is new enough.", boolean: true, }, HOMEBREW_GIT_EMAIL: { description: "Set the Git author and committer email to this value.", }, HOMEBREW_GIT_NAME: { description: "Set the Git author and committer name to this value.", }, HOMEBREW_GIT_PATH: { description: "Linux only: Set this value to a new enough `git` executable for Homebrew to use.", default: "git", }, HOMEBREW_GITHUB_API_TOKEN: { description: "Use this personal access token for the GitHub API, for features such as " \ "`brew search`. You can create one at <https://github.com/settings/tokens>. If set, " \ "GitHub will allow you a greater number of API requests. For more information, see: " \ "<https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting>" \ "\n\n *Note:* Homebrew doesn't require permissions for any of the scopes, but some " \ "developer commands may require additional permissions.", }, HOMEBREW_GITHUB_PACKAGES_TOKEN: { description: "Use this GitHub personal access token when accessing the GitHub Packages Registry " \ "(where bottles may be stored).", }, HOMEBREW_GITHUB_PACKAGES_USER: { description: "Use this username when accessing the GitHub Packages Registry (where bottles may be stored).", }, HOMEBREW_INSTALL_BADGE: { description: "Print this text before the installation summary of each successful build.", default_text: 'The "Beer Mug" emoji.', default: "🍺", }, HOMEBREW_LIVECHECK_WATCHLIST: { description: "Consult this file for the list of formulae to check by default when no formula argument " \ "is passed to `brew livecheck`.", default_text: "`$HOME/.brew_livecheck_watchlist`", default: "~/.brew_livecheck_watchlist", }, HOMEBREW_LOGS: { description: "Use this directory to store log files.", default_text: "macOS: `$HOME/Library/Logs/Homebrew`, " \ "Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`.", default: HOMEBREW_DEFAULT_LOGS, }, HOMEBREW_MAKE_JOBS: { description: "Use this value as the number of parallel jobs to run when building with `make`(1).", default_text: "The number of available CPU cores.", default: lambda { require "os" require "hardware" Hardware::CPU.cores }, }, HOMEBREW_NO_ANALYTICS: { description: "If set, do not send analytics. For more information, see: <https://docs.brew.sh/Analytics>", boolean: true, }, HOMEBREW_NO_AUTO_UPDATE: { description: "If set, do not automatically update before running some commands, e.g. " \ "`brew install`, `brew upgrade` and `brew tap`. Alternatively, " \ "run this less often by setting `HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the default.", boolean: true, }, HOMEBREW_NO_BOOTSNAP: { description: "If set, do not use Bootsnap to speed up repeated `brew` calls.", boolean: true, }, HOMEBREW_NO_CLEANUP_FORMULAE: { description: "A comma-separated list of formulae. Homebrew will refuse to clean up " \ "or autoremove a formula if it appears on this list.", }, HOMEBREW_NO_COLOR: { description: "If set, do not print text with colour added.", default_text: "`$NO_COLOR`.", boolean: true, }, HOMEBREW_NO_EMOJI: { description: "If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build.", boolean: true, }, HOMEBREW_NO_ENV_HINTS: { description: "If set, do not print any hints about changing Homebrew's behaviour with environment variables.", boolean: true, }, HOMEBREW_NO_GOOGLE_ANALYTICS: { description: "If set, do not send analytics to Google Analytics but allow sending to Homebrew's InfluxDB " \ "analytics server. For more information, see: <https://docs.brew.sh/Analytics>", boolean: true, }, HOMEBREW_NO_GITHUB_API: { description: "If set, do not use the GitHub API, e.g. for searches or fetching relevant issues " \ "after a failed install.", boolean: true, }, HOMEBREW_NO_INSECURE_REDIRECT: { description: "If set, forbid redirects from secure HTTPS to insecure HTTP." \ "\n\n *Note:* While ensuring your downloads are fully secure, this is likely to cause " \ "from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download.", boolean: true, }, HOMEBREW_NO_INSTALL_CLEANUP: { description: "If set, `brew install`, `brew upgrade` and `brew reinstall` will never automatically " \ "cleanup installed/upgraded/reinstalled formulae or all formulae every " \ "`HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS` days. Alternatively, `HOMEBREW_NO_CLEANUP_FORMULAE` " \ "allows specifying specific formulae to not clean up.", boolean: true, }, HOMEBREW_NO_INSTALL_FROM_API: { description: "If set, do not install formulae and casks in homebrew/core and homebrew/cask taps using " \ "Homebrew's API and instead use (large, slow) local checkouts of these repositories.", boolean: true, }, HOMEBREW_NO_INSTALL_UPGRADE: { description: "If set, `brew install` <formula> will not upgrade <formula> if it is installed but " \ "outdated.", boolean: true, }, HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK: { description: "If set, do not check for broken linkage of dependents or outdated dependents after " \ "installing, upgrading or reinstalling formulae. This will result in fewer dependents " \ "(and their dependencies) being upgraded or reinstalled but may result in more breakage " \ "from running `brew install` <formula> or `brew upgrade` <formula>.", boolean: true, }, HOMEBREW_PIP_INDEX_URL: { description: "If set, `brew install <formula>` will use this URL to download PyPI package resources.", default_text: "`https://pypi.org/simple`.", }, HOMEBREW_PRY: { description: "If set, use Pry for the `brew irb` command.", boolean: true, }, HOMEBREW_UPGRADE_GREEDY: { description: "If set, pass `--greedy` to all cask upgrade commands.", boolean: true, }, HOMEBREW_SIMULATE_MACOS_ON_LINUX: { description: "If set, running Homebrew on Linux will simulate certain macOS code paths. This is useful " \ "when auditing macOS formulae while on Linux.", boolean: true, }, HOMEBREW_SKIP_OR_LATER_BOTTLES: { description: "If set along with `HOMEBREW_DEVELOPER`, do not use bottles from older versions " \ "of macOS. This is useful in development on new macOS versions.", boolean: true, }, HOMEBREW_SORBET_RUNTIME: { description: "If set, enable runtime typechecking using Sorbet.", boolean: true, }, HOMEBREW_SSH_CONFIG_PATH: { description: "If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching " \ "`git` repos over `ssh`.", default_text: "`$HOME/.ssh/config`", }, HOMEBREW_SVN: { description: "Use this as the `svn`(1) binary.", default_text: "A Homebrew-built Subversion (if installed), or the system-provided binary.", }, HOMEBREW_TEMP: { description: "Use this path as the temporary directory for building packages. Changing " \ "this may be needed if your system temporary directory and Homebrew prefix are on " \ "different volumes, as macOS has trouble moving symlinks across volumes when the target " \ "does not yet exist. This issue typically occurs when using FileVault or custom SSD " \ "configurations.", default_text: "macOS: `/private/tmp`, Linux: `/tmp`.", default: HOMEBREW_DEFAULT_TEMP, }, HOMEBREW_UPDATE_TO_TAG: { description: "If set, always use the latest stable tag (even if developer commands " \ "have been run).", boolean: true, }, HOMEBREW_VERBOSE: { description: "If set, always assume `--verbose` when running commands.", boolean: true, }, HOMEBREW_VERBOSE_USING_DOTS: { description: "If set, verbose output will print a `.` no more than once a minute. This can be " \ "useful to avoid long-running Homebrew commands being killed due to no output.", boolean: true, }, SUDO_ASKPASS: { description: "If set, pass the `-A` option when calling `sudo`(8).", }, all_proxy: { description: "Use this SOCKS5 proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", }, ftp_proxy: { description: "Use this FTP proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", }, http_proxy: { description: "Use this HTTP proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", }, https_proxy: { description: "Use this HTTPS proxy for `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", }, no_proxy: { description: "A comma-separated list of hostnames and domain names excluded " \ "from proxying by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", }, }.freeze
- CUSTOM_IMPLEMENTATIONS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
Set.new([ :HOMEBREW_MAKE_JOBS, :HOMEBREW_CASK_OPTS, ]).freeze
Class Method Summary collapse
-
.automatically_set_no_install_from_api? ⇒ Boolean
private
-
.cask_opts ⇒ Array<String>
private
-
.cask_opts_binaries? ⇒ Boolean
private
-
.cask_opts_quarantine? ⇒ Boolean
private
-
.cask_opts_require_sha? ⇒ Boolean
private
-
.env_method_name(env, hash) ⇒ String
private
-
.make_jobs ⇒ String
private
Needs a custom implementation.
Class Method Details
.automatically_set_no_install_from_api? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
495 496 497 |
# File 'env_config.rb', line 495 def automatically_set_no_install_from_api? ENV["HOMEBREW_AUTOMATICALLY_SET_NO_INSTALL_FROM_API"].present? end |
.cask_opts ⇒ Array<String>
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
465 466 467 |
# File 'env_config.rb', line 465 def cask_opts Shellwords.shellsplit(ENV.fetch("HOMEBREW_CASK_OPTS", "")) end |
.cask_opts_binaries? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
470 471 472 473 474 475 476 477 |
# File 'env_config.rb', line 470 def cask_opts_binaries? cask_opts.reverse_each do |opt| return true if opt == "--binaries" return false if opt == "--no-binaries" end true end |
.cask_opts_quarantine? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
480 481 482 483 484 485 486 487 |
# File 'env_config.rb', line 480 def cask_opts_quarantine? cask_opts.reverse_each do |opt| return true if opt == "--quarantine" return false if opt == "--no-quarantine" end true end |
.cask_opts_require_sha? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
490 491 492 |
# File 'env_config.rb', line 490 def cask_opts_require_sha? cask_opts.include?("--require-sha") end |
.env_method_name(env, hash) ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
417 418 419 420 421 422 423 |
# File 'env_config.rb', line 417 def env_method_name(env, hash) method_name = env.to_s .sub(/^HOMEBREW_/, "") .downcase method_name = "#{method_name}?" if hash[:boolean] method_name end |
.make_jobs ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Needs a custom implementation.
454 455 456 457 458 459 460 461 462 |
# File 'env_config.rb', line 454 def make_jobs jobs = ENV["HOMEBREW_MAKE_JOBS"].to_i return jobs.to_s if jobs.positive? ENVS.fetch(:HOMEBREW_MAKE_JOBS) .fetch(:default) .call .to_s end |