Module: Homebrew::EnvConfig

Defined in:
env_config.rb,
sorbet/rbi/dsl/homebrew/env_config.rbi

Overview

This module is part of an internal API. This module may only be used internally in repositories owned by Homebrew, except in casks or formulae. 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 an internal API. This constant may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

T.let({
  HOMEBREW_ALLOWED_TAPS:                     {
    description: "A space-separated list of taps. Homebrew will refuse to install a " \
                 "formula unless it and all of its dependencies are in an official tap " \
                 "or in a tap on this list.",
  },
  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_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_ARTIFACT_DOMAIN_NO_FALLBACK:      {
    description: "If `HOMEBREW_ARTIFACT_DOMAIN` and `HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK` are both set, " \
                 "if the request to `HOMEBREW_ARTIFACT_DOMAIN` fails then it Homebrew will error rather than " \
                 "trying any other/default URLs.",
    boolean:     true,
  },
  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_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 on Linux when not using Homebrew's vendored, relocatable Ruby.",
    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_BUNDLE_USER_CACHE:                {
    description: "If set, use this directory as the `bundle`(1) user cache.",
  },
  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_CURLRC:                           {
    description: "If set to an absolute path (i.e. beginning with `/`), pass it with `--config` when invoking " \
                 "`curl`(1). " \
                 "If set but _not_ a valid path, do not pass `--disable`, which disables the " \
                 "use of `.curlrc`.",
  },
  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_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_DEBREW:                   {
    description: "If set, the interactive formula debugger available via `--debug` will be disabled.",
    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_CASKS:                  {
    description: "A space-separated list of casks. Homebrew will refuse to install a " \
                 "cask if it or any of its dependencies is on this list.",
  },
  HOMEBREW_FORBIDDEN_FORMULAE:               {
    description: "A space-separated list of formulae. Homebrew will refuse to install a " \
                 "formula or cask if it or any of its dependencies is on this list.",
  },
  HOMEBREW_FORBIDDEN_LICENSES:               {
    description: "A space-separated list of SPDX license identifiers. Homebrew will refuse to install a " \
                 "formula if it or any of its dependencies has a license on this list.",
  },
  HOMEBREW_FORBIDDEN_OWNER:                  {
    description: "The person who has set any `HOMEBREW_FORBIDDEN_*` variables.",
    default:     "you",
  },
  HOMEBREW_FORBIDDEN_OWNER_CONTACT:          {
    description: "How to contact the `HOMEBREW_FORBIDDEN_OWNER`, if set and necessary.",
  },
  HOMEBREW_FORBIDDEN_TAPS:                   {
    description: "A space-separated list of taps. Homebrew will refuse to install a " \
                 "formula if it or any of its dependencies is in a tap on this list.",
  },
  HOMEBREW_FORBID_PACKAGES_FROM_PATHS:       {
    description: "If set, Homebrew will refuse to read formulae or casks provided from file paths, " \
                 "e.g. `brew install ./package.rb`.",
    boolean:     true,
  },
  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_FORMULA_BUILD_NETWORK:            {
    description: "If set, controls network access to the sandbox for formulae builds. Overrides any " \
                 "controls set through DSL usage inside formulae. Must be `allow` or `deny`. If no value is " \
                 "set through this environment variable or DSL usage, the default behavior is `allow`.",
  },
  HOMEBREW_FORMULA_POSTINSTALL_NETWORK:      {
    description: "If set, controls network access to the sandbox for formulae postinstall. Overrides any " \
                 "controls set through DSL usage inside formulae. Must be `allow` or `deny`. If no value is " \
                 "set through this environment variable or DSL usage, the default behavior is `allow`.",
  },
  HOMEBREW_FORMULA_TEST_NETWORK:             {
    description: "If set, controls network access to the sandbox for formulae test. Overrides any " \
                 "controls set through DSL usage inside formulae. Must be `allow` or `deny`. If no value is " \
                 "set through this environment variable or DSL usage, the default behavior is `allow`.",
  },
  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/rate-limits-for-the-rest-api>" \
                 "\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_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_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: "`$XDG_CONFIG_HOME/homebrew/livecheck_watchlist.txt` if `$XDG_CONFIG_HOME` is set " \
                  "or `$HOME/.homebrew/livecheck_watchlist.txt` otherwise.",
    default:      "#{ENV.fetch("HOMEBREW_USER_CONFIG_HOME")}/livecheck_watchlist.txt",
  },
  HOMEBREW_LOCK_CONTEXT:                     {
    description: "If set, Homebrew will add this output as additional context for locking errors. " \
                 "This is useful when running `brew` in the background.",
  },
  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. Google Analytics were destroyed. " \
                 "For more information, see: <https://docs.brew.sh/Analytics>",
    boolean:     true,
  },
  HOMEBREW_NO_AUTOREMOVE:                    {
    description: "If set, calls to `brew cleanup` and `brew uninstall` will not automatically " \
                 "remove unused formula dependents.",
    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`. Preferably, " \
                 "run this less often by setting `HOMEBREW_AUTO_UPDATE_SECS` to a value higher than the " \
                 "default. Note that setting this and e.g. tapping new taps may result in a broken  " \
                 "configuration. Please ensure you always run `brew update` before reporting any issues.",
    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_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_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_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|cask> will not upgrade <formula|cask> if it is installed but " \
                 "outdated.",
    boolean:     true,
  },
  HOMEBREW_NO_UPDATE_REPORT_NEW:             {
    description: "If set, `brew update` will not show the list of newly added formulae/casks.",
    boolean:     true,
  },
  HOMEBREW_NO_VERIFY_ATTESTATIONS:           {
    description: "If set, Homebrew not verify cryptographic attestations of build provenance for bottles " \
                 "from homebrew-core.",
    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_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. " \
                 "Set by default for `HOMEBREW_DEVELOPER` or when running some developer commands.",
    boolean:     true,
  },
  HOMEBREW_SSH_CONFIG_PATH:                  {
    description:  "If set, Homebrew will use the given config file instead of `~/.ssh/config` when fetching " \
                  "Git repositories over SSH.",
    default_text: "`$HOME/.ssh/config`",
  },
  HOMEBREW_SUDO_THROUGH_SUDO_USER:           {
    description: "If set, Homebrew will use the `SUDO_USER` environment variable to define the user to " \
                 "`sudo`(8) through when running `sudo`(8).",
    boolean:     true,
  },
  HOMEBREW_SVN:                              {
    description:  "Use this as the `svn`(1) binary.",
    default_text: "A Homebrew-built Subversion (if installed), or the system-provided binary.",
  },
  HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY:        {
    description: "If set in Homebrew's system-wide environment file (`/etc/homebrew/brew.env`), " \
                 "the system-wide environment file will be loaded last to override any prefix or user settings.",
    boolean:     true,
  },
  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_UPGRADE_GREEDY:                   {
    description: "If set, pass `--greedy` to all cask upgrade commands.",
    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,
  },
  HOMEBREW_VERIFY_ATTESTATIONS:              {
    description: "If set, Homebrew will use the `gh` tool to verify cryptographic attestations " \
                 "of build provenance for bottles from homebrew-core.",
    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, T::Hash[Symbol, T::Hash[Symbol, T.untyped]])
CUSTOM_IMPLEMENTATIONS =

This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

T.let(Set.new([
  :HOMEBREW_MAKE_JOBS,
  :HOMEBREW_CASK_OPTS,
]).freeze, T::Set[Symbol])

Class Method Summary collapse

Class Method Details

.all_proxy::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.

Returns:



11
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 11

def all_proxy; end

.allowed_taps::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.

Returns:



14
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 14

def allowed_taps; end

.api_auto_update_secsInteger

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.

Returns:

  • (Integer)


17
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 17

def api_auto_update_secs; end

.api_domainString

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.

Returns:



20
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 20

def api_domain; end

.archString

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.

Returns:



23
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 23

def arch; end

.artifact_domain::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.

Returns:



26
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 26

def artifact_domain; end

.artifact_domain_no_fallback?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.

Returns:

  • (Boolean)


29
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 29

def artifact_domain_no_fallback?; end

.auto_update_secs::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.

Returns:



32
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 32

def auto_update_secs; end

.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.

Returns:

  • (Boolean)


585
586
587
# File 'env_config.rb', line 585

def automatically_set_no_install_from_api?
  ENV["HOMEBREW_AUTOMATICALLY_SET_NO_INSTALL_FROM_API"].present?
end

.bat?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.

Returns:

  • (Boolean)


35
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 35

def bat?; end

.bat_config_path::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.

Returns:



38
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 38

def bat_config_path; end

.bat_theme::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.

Returns:



41
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 41

def bat_theme; end

.bootsnap?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.

Returns:

  • (Boolean)


44
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 44

def bootsnap?; end

.bottle_domainString

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.

Returns:



47
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 47

def bottle_domain; end

.brew_git_remoteString

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.

Returns:



50
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 50

def brew_git_remote; end

.browser::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.

Returns:



53
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 53

def browser; end

.bundle_user_cache::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.

Returns:



56
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 56

def bundle_user_cache; end

.cacheString

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.

Returns:



59
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 59

def cache; end

.cask_optsArray<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.

Returns:



555
556
557
# File 'env_config.rb', line 555

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.

Returns:

  • (Boolean)


560
561
562
563
564
565
566
567
# File 'env_config.rb', line 560

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.

Returns:

  • (Boolean)


570
571
572
573
574
575
576
577
# File 'env_config.rb', line 570

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.

Returns:

  • (Boolean)


580
581
582
# File 'env_config.rb', line 580

def cask_opts_require_sha?
  cask_opts.include?("--require-sha")
end

.cleanup_max_age_daysInteger

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.

Returns:

  • (Integer)


62
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 62

def cleanup_max_age_days; end

.cleanup_periodic_full_daysInteger

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.

Returns:

  • (Integer)


65
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 65

def cleanup_periodic_full_days; end

.color?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.

Returns:

  • (Boolean)


68
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 68

def color?; end

.core_git_remoteString

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.

Returns:



71
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 71

def core_git_remote; end

.curl_pathString

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.

Returns:



74
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 74

def curl_path; end

.curl_retriesInteger

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.

Returns:

  • (Integer)


77
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 77

def curl_retries; end

.curl_verbose?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.

Returns:

  • (Boolean)


80
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 80

def curl_verbose?; end

.curlrc::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.

Returns:



83
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 83

def curlrc; end

.debug?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.

Returns:

  • (Boolean)


86
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 86

def debug?; end

.devcmdrun?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.

Returns:

  • (Boolean)


590
591
592
# File 'env_config.rb', line 590

def devcmdrun?
  Homebrew::Settings.read("devcmdrun") == "true"
end

.developer?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.

Returns:

  • (Boolean)


89
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 89

def developer?; end

.disable_debrew?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.

Returns:

  • (Boolean)


92
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 92

def disable_debrew?; end

.disable_load_formula?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.

Returns:

  • (Boolean)


95
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 95

def disable_load_formula?; end

.display::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.

Returns:



98
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 98

def display; end

.display_install_times?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.

Returns:

  • (Boolean)


101
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 101

def display_install_times?; end

.docker_registry_basic_auth_token::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.

Returns:



104
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 104

def docker_registry_basic_auth_token; end

.docker_registry_token::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.

Returns:



107
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 107

def docker_registry_token; end

.editor::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.

Returns:



110
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 110

def editor; 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.

Parameters:

Returns:



496
497
498
499
500
501
502
# File 'env_config.rb', line 496

def env_method_name(env, hash)
  method_name = env.to_s
                   .sub(/^HOMEBREW_/, "")
                   .downcase
  method_name = "#{method_name}?" if hash[:boolean]
  method_name
end

.eval_all?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.

Returns:

  • (Boolean)


113
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 113

def eval_all?; end

.fail_log_linesInteger

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.

Returns:

  • (Integer)


116
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 116

def fail_log_lines; end

.forbid_packages_from_paths?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.

Returns:

  • (Boolean)


119
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 119

def forbid_packages_from_paths?; end

.forbidden_casks::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.

Returns:



122
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 122

def forbidden_casks; end

.forbidden_formulae::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.

Returns:



125
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 125

def forbidden_formulae; end

.forbidden_licenses::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.

Returns:



128
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 128

def forbidden_licenses; end

.forbidden_ownerString

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.

Returns:



131
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 131

def forbidden_owner; end

.forbidden_owner_contact::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.

Returns:



134
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 134

def forbidden_owner_contact; end

.forbidden_taps::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.

Returns:



137
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 137

def forbidden_taps; end

.force_brewed_ca_certificates?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.

Returns:

  • (Boolean)


140
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 140

def force_brewed_ca_certificates?; end

.force_brewed_curl?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.

Returns:

  • (Boolean)


143
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 143

def force_brewed_curl?; end

.force_brewed_git?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.

Returns:

  • (Boolean)


146
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 146

def force_brewed_git?; end

.force_vendor_ruby?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.

Returns:

  • (Boolean)


149
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 149

def force_vendor_ruby?; end

.formula_build_network::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.

Returns:



152
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 152

def formula_build_network; end

.formula_postinstall_network::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.

Returns:



155
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 155

def formula_postinstall_network; end

.formula_test_network::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.

Returns:



158
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 158

def formula_test_network; end

.ftp_proxy::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.

Returns:



161
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 161

def ftp_proxy; end

.git_email::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.

Returns:



164
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 164

def git_email; end

.git_name::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.

Returns:



167
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 167

def git_name; end

.git_pathString

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.

Returns:



170
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 170

def git_path; end

.github_api_token::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.

Returns:



173
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 173

def github_api_token; end

.github_packages_token::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.

Returns:



176
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 176

def github_packages_token; end

.github_packages_user::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.

Returns:



179
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 179

def github_packages_user; end

.http_proxy::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.

Returns:



182
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 182

def http_proxy; end

.https_proxy::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.

Returns:



185
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 185

def https_proxy; end

.install_badgeString

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.

Returns:



188
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 188

def install_badge; end

.livecheck_watchlistString

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.

Returns:



191
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 191

def livecheck_watchlist; end

.lock_context::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.

Returns:



194
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 194

def lock_context; end

.logsString

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.

Returns:



197
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 197

def logs; end

.make_jobsString

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.

Returns:



544
545
546
547
548
549
550
551
552
# File 'env_config.rb', line 544

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

.no_analytics?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.

Returns:

  • (Boolean)


200
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 200

def no_analytics?; end

.no_auto_update?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.

Returns:

  • (Boolean)


203
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 203

def no_auto_update?; end

.no_autoremove?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.

Returns:

  • (Boolean)


206
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 206

def no_autoremove?; end

.no_bootsnap?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.

Returns:

  • (Boolean)


209
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 209

def no_bootsnap?; end

.no_cleanup_formulae::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.

Returns:



212
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 212

def no_cleanup_formulae; end

.no_color?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.

Returns:

  • (Boolean)


215
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 215

def no_color?; end

.no_emoji?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.

Returns:

  • (Boolean)


218
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 218

def no_emoji?; end

.no_env_hints?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.

Returns:

  • (Boolean)


221
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 221

def no_env_hints?; end

.no_github_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.

Returns:

  • (Boolean)


224
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 224

def no_github_api?; end

.no_insecure_redirect?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.

Returns:

  • (Boolean)


227
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 227

def no_insecure_redirect?; end

.no_install_cleanup?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.

Returns:

  • (Boolean)


230
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 230

def no_install_cleanup?; end

.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.

Returns:

  • (Boolean)


233
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 233

def no_install_from_api?; end

.no_install_upgrade?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.

Returns:

  • (Boolean)


236
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 236

def no_install_upgrade?; end

.no_installed_dependents_check?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.

Returns:

  • (Boolean)


239
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 239

def no_installed_dependents_check?; end

.no_proxy::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.

Returns:



242
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 242

def no_proxy; end

.no_update_report_new?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.

Returns:

  • (Boolean)


245
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 245

def no_update_report_new?; end

.no_verify_attestations?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.

Returns:

  • (Boolean)


248
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 248

def no_verify_attestations?; end

.pip_index_url::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.

Returns:



251
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 251

def pip_index_url; end

.pry?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.

Returns:

  • (Boolean)


254
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 254

def pry?; end

.simulate_macos_on_linux?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.

Returns:

  • (Boolean)


257
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 257

def simulate_macos_on_linux?; end

.skip_or_later_bottles?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.

Returns:

  • (Boolean)


260
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 260

def skip_or_later_bottles?; end

.sorbet_runtime?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.

Returns:

  • (Boolean)


263
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 263

def sorbet_runtime?; end

.ssh_config_path::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.

Returns:



266
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 266

def ssh_config_path; end

.sudo_askpass::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.

Returns:



269
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 269

def sudo_askpass; end

.sudo_through_sudo_user?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.

Returns:

  • (Boolean)


272
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 272

def sudo_through_sudo_user?; end

.svn::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.

Returns:



275
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 275

def svn; end

.system_env_takes_priority?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.

Returns:

  • (Boolean)


278
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 278

def system_env_takes_priority?; end

.tempString

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.

Returns:



281
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 281

def temp; end

.update_to_tag?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.

Returns:

  • (Boolean)


284
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 284

def update_to_tag?; end

.upgrade_greedy?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.

Returns:

  • (Boolean)


287
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 287

def upgrade_greedy?; end

.verbose?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.

Returns:

  • (Boolean)


290
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 290

def verbose?; end

.verbose_using_dots?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.

Returns:

  • (Boolean)


293
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 293

def verbose_using_dots?; end

.verify_attestations?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.

Returns:

  • (Boolean)


296
# File 'sorbet/rbi/dsl/homebrew/env_config.rbi', line 296

def verify_attestations?; end