." generated with Ronn-NG/v0.10.1 ." github.com/apjanke/ronn-ng/tree/0.10.1 .TH “BUNDLE-CONFIG” “1” “July 2025” “” .SH “NAME” fBbundle-configfR - Set bundler configuration options .SH “SYNOPSIS” fBbundle configfR list .br fBbundle configfR [get] NAME .br fBbundle configfR [set] NAME VALUE .br fBbundle configfR unset NAME .SH “DESCRIPTION” This command allows you to interact with Bundler’s configuration system. .P Bundler loads configuration settings in this order: .IP “1.” 4 Local config (fB<project_root>/.bundle/configfR or fB$BUNDLE_APP_CONFIG/configfR) .IP “2.” 4 Environmental variables (fBENVfR) .IP “3.” 4 Global config (fB~/.bundle/configfR) .IP “4.” 4 Bundler default config .IP “” 0 .P Executing fBbundle config listfR will print a list of all bundler configuration for the current bundle, and where that configuration was set. .P Executing fBbundle config get <name>fR will print the value of that configuration setting, and where it was set. .P Executing fBbundle config set <name> <value>fR defaults to setting fBlocalfR configuration if executing from within a local application, otherwise it will set fBglobalfR configuration. See fB--localfR and fB--globalfR options below. .P Executing fBbundle config set --local <name> <value>fR will set that configuration in the directory for the local application. The configuration will be stored in fB<project_root>/.bundle/configfR. If fBBUNDLE_APP_CONFIGfR is set, the configuration will be stored in fB$BUNDLE_APP_CONFIG/configfR. .P Executing fBbundle config set --global <name> <value>fR will set that configuration to the value specified for all bundles executed as the current user. The configuration will be stored in fB~/.bundle/configfR. If fInamefR already is set, fInamefR will be overridden and user will be warned. .P Executing fBbundle config unset <name>fR will delete the configuration in both local and global sources. .P Executing fBbundle config unset --global <name>fR will delete the configuration only from the user configuration. .P Executing fBbundle config unset --local <name>fR will delete the configuration only from the local application. .P Executing bundle with the fBBUNDLE_IGNORE_CONFIGfR environment variable set will cause it to ignore all configuration. .SH “CONFIGURATION KEYS” Configuration keys in bundler have two forms: the canonical form and the environment variable form. .P For instance, passing the fB--withoutfR flag to bundle install(1) fIbundle-install.1.htmlfR prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler persists this value in fBapp/.bundle/configfR so that calls to fBBundler.setupfR do not try to find gems from the fBGemfilefR that you didn’t install. Additionally, subsequent calls to bundle install(1) fIbundle-install.1.htmlfR remember this setting and skip those groups. .P The canonical form of this configuration is fB“without”fR. To convert the canonical form to the environment variable form, capitalize it, and prepend fBBUNDLE_fR. The environment variable form of fB“without”fR is fBBUNDLE_WITHOUTfR. .P Any periods in the configuration keys must be replaced with two underscores when setting it via environment variables. The configuration key fBlocal.rackfR becomes the environment variable fBBUNDLE_LOCAL__RACKfR. .SH “LIST OF AVAILABLE KEYS” The following is a list of all configuration keys and their purpose. You can learn more about their operation in bundle install(1) fIbundle-install.1.htmlfR. .TP fBallow_offline_installfR (fBBUNDLE_ALLOW_OFFLINE_INSTALLfR) Allow Bundler to use cached data when installing without network access. .TP fBauto_installfR (fBBUNDLE_AUTO_INSTALLfR) Automatically run fBbundle installfR when gems are missing. .TP fBbinfR (fBBUNDLE_BINfR) Install executables from gems in the bundle to the specified directory. Defaults to fBfalsefR. .TP fBcache_allfR (fBBUNDLE_CACHE_ALLfR) Cache all gems, including path and git gems. This needs to be explicitly before bundler 4, but will be the default on bundler 4. .TP fBcache_all_platformsfR (fBBUNDLE_CACHE_ALL_PLATFORMSfR) Cache gems for all platforms. .TP fBcache_pathfR (fBBUNDLE_CACHE_PATHfR) The directory that bundler will place cached gems in when running fBbundle packagefR, and that bundler will look in when installing gems. Defaults to fBvendor/cachefR. .TP fBcleanfR (fBBUNDLE_CLEANfR) Whether Bundler should run fBbundle cleanfR automatically after fBbundle installfR. Defaults to fBtruefR in Bundler 4, as long as fBpathfR is not explicitly configured. .TP fBconsolefR (fBBUNDLE_CONSOLEfR) The console that fBbundle consolefR starts. Defaults to fBirbfR. .TP fBdefault_cli_commandfR (fBBUNDLE_DEFAULT_CLI_COMMANDfR) The command that running fBbundlefR without arguments should run. Defaults to fBcli_helpfR since Bundler 4, but can also be fBinstallfR which was the previous default. .TP fBdeploymentfR (fBBUNDLE_DEPLOYMENTfR) Equivalent to setting fBfrozenfR to fBtruefR and fBpathfR to fBvendor/bundlefR. .TP fBdisable_checksum_validationfR (fBBUNDLE_DISABLE_CHECKSUM_VALIDATIONfR) Allow installing gems even if they do not match the checksum provided by RubyGems. .TP fBdisable_exec_loadfR (fBBUNDLE_DISABLE_EXEC_LOADfR) Stop Bundler from using fBloadfR to launch an executable in-process in fBbundle execfR. .TP fBdisable_local_branch_checkfR (fBBUNDLE_DISABLE_LOCAL_BRANCH_CHECKfR) Allow Bundler to use a local git override without a branch specified in the Gemfile. .TP fBdisable_local_revision_checkfR (fBBUNDLE_DISABLE_LOCAL_REVISION_CHECKfR) Allow Bundler to use a local git override without checking if the revision present in the lockfile is present in the repository. .TP fBdisable_shared_gemsfR (fBBUNDLE_DISABLE_SHARED_GEMSfR) Stop Bundler from accessing gems installed to RubyGems’ normal location. .TP fBdisable_version_checkfR (fBBUNDLE_DISABLE_VERSION_CHECKfR) Stop Bundler from checking if a newer Bundler version is available on rubygems.org. .TP fBforce_ruby_platformfR (fBBUNDLE_FORCE_RUBY_PLATFORMfR) Ignore the current machine’s platform and install only fBrubyfR platform gems. As a result, gems with native extensions will be compiled from source. .TP fBfrozenfR (fBBUNDLE_FROZENfR) Disallow any automatic changes to fBGemfile.lockfR. Bundler commands will be blocked unless the lockfile can be installed exactly as written. Usually this will happen when changing the fBGemfilefR manually and forgetting to update the lockfile through fBbundle lockfR or fBbundle installfR. .TP fBgem.github_usernamefR (fBBUNDLE_GEM__GITHUB_USERNAMEfR) Sets a GitHub username or organization to be used in the fBREADMEfR and fB.gemspecfR files when you create a new gem via fBbundle gemfR command. It can be overridden by passing an explicit fB--github-usernamefR flag to fBbundle gemfR. .TP fBgem.push_keyfR (fBBUNDLE_GEM__PUSH_KEYfR) Sets the fB--keyfR parameter for fBgem pushfR when using the fBrake releasefR command with a private gemstash server. .TP fBgemfilefR (fBBUNDLE_GEMFILEfR) The name of the file that bundler should use as the fBGemfilefR. This location of this file also sets the root of the project, which is used to resolve relative paths in the fBGemfilefR, among other things. By default, bundler will search up from the current working directory until it finds a fBGemfilefR. .TP fBglobal_gem_cachefR (fBBUNDLE_GLOBAL_GEM_CACHEfR) Whether Bundler should cache all gems and compiled extensions globally, rather than locally to the configured installation path. .TP fBignore_funding_requestsfR (fBBUNDLE_IGNORE_FUNDING_REQUESTSfR) When set, no funding requests will be printed. .TP fBignore_messagesfR (fBBUNDLE_IGNORE_MESSAGESfR) When set, no post install messages will be printed. To silence a single gem, use dot notation like fBignore_messages.httparty truefR. .TP fBinit_gems_rbfR (fBBUNDLE_INIT_GEMS_RBfR) Generate a fBgems.rbfR instead of a fBGemfilefR when running fBbundle initfR. .TP fBjobsfR (fBBUNDLE_JOBSfR) The number of gems Bundler can install in parallel. Defaults to the number of available processors. .TP fBlockfile_checksumsfR (fBBUNDLE_LOCKFILE_CHECKSUMSfR) Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources. .TP fBno_installfR (fBBUNDLE_NO_INSTALLfR) Whether fBbundle packagefR should skip installing gems. .TP fBno_prunefR (fBBUNDLE_NO_PRUNEfR) Whether Bundler should leave outdated gems unpruned when caching. .TP fBonlyfR (fBBUNDLE_ONLYfR) A space-separated list of groups to install only gems of the specified groups. .TP fBpathfR (fBBUNDLE_PATHfR) The location on disk where all gems in your bundle will be located regardless of fB$GEM_HOMEfR or fB$GEM_PATHfR values. Bundle gems not found in this location will be installed by fBbundle installfR. Defaults to fB.bundlefR relative to repository root in Bundler 4, and to the default system path (fBGem.dirfR) before Bundler 4. .TP fBpath.systemfR (fBBUNDLE_PATH__SYSTEMfR) Whether Bundler will install gems into the default system path (fBGem.dirfR). .TP fBpluginsfR (fBBUNDLE_PLUGINSfR) Enable Bundler’s experimental plugin system. .TP fBprefer_patchfR (BUNDLE_PREFER_PATCH) Prefer updating only to next patch version during updates. Makes fBbundle updatefR calls equivalent to fBbundler update --patchfR. .TP fBredirectfR (fBBUNDLE_REDIRECTfR) The number of redirects allowed for network requests. Defaults to fB5fR. .TP fBretryfR (fBBUNDLE_RETRYfR) The number of times to retry failed network requests. Defaults to fB3fR. .TP fBshebangfR (fBBUNDLE_SHEBANGfR) The program name that should be invoked for generated binstubs. Defaults to the ruby install name used to generate the binstub. .TP fBsilence_deprecationsfR (fBBUNDLE_SILENCE_DEPRECATIONSfR) Whether Bundler should silence deprecation warnings for behavior that will be changed in the next major version. .TP fBsilence_root_warningfR (fBBUNDLE_SILENCE_ROOT_WARNINGfR) Silence the warning Bundler prints when installing gems as root. .TP fBsimulate_versionfR (fBBUNDLE_SIMULATE_VERSIONfR) The virtual version Bundler should use for activating feature flags. Can be used to simulate all the new functionality that will be enabled in a future major version. .TP fBssl_ca_certfR (fBBUNDLE_SSL_CA_CERTfR) Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format. .TP fBssl_client_certfR (fBBUNDLE_SSL_CLIENT_CERTfR) Path to a designated file containing a X.509 client certificate and key in PEM format. .TP fBssl_verify_modefR (fBBUNDLE_SSL_VERIFY_MODEfR) The SSL verification mode Bundler uses when making HTTPS requests. Defaults to verify peer. .TP fBsystem_bindirfR (fBBUNDLE_SYSTEM_BINDIRfR) The location where RubyGems installs binstubs. Defaults to fBGem.bindirfR. .TP fBtimeoutfR (fBBUNDLE_TIMEOUTfR) The seconds allowed before timing out for network requests. Defaults to fB10fR. .TP fBupdate_requires_all_flagfR (fBBUNDLE_UPDATE_REQUIRES_ALL_FLAGfR) Require passing fB--allfR to fBbundle updatefR when everything should be updated, and disallow passing no options to fBbundle updatefR. .TP fBuser_agentfR (fBBUNDLE_USER_AGENTfR) The custom user agent fragment Bundler includes in API requests. .TP fBverbosefR (fBBUNDLE_VERBOSEfR) Whether Bundler should print verbose output. Defaults to fBfalsefR, unless the fB--verbosefR CLI flag is used. .TP fBversionfR (fBBUNDLE_VERSIONfR) The version of Bundler to use when running under Bundler environment. Defaults to fBlockfilefR. You can also specify fBsystemfR or fBx.y.zfR. fBlockfilefR will use the Bundler version specified in the fBGemfile.lockfR, fBsystemfR will use the system version of Bundler, and fBx.y.zfR will use the specified version of Bundler. .TP fBwithfR (fBBUNDLE_WITHfR) A space-separated or fB:fR-separated list of groups whose gems bundler should install. .TP fBwithoutfR (fBBUNDLE_WITHOUTfR) A space-separated or fB:fR-separated list of groups whose gems bundler should not install. .SH “REMEMBERING OPTIONS” Flags passed to fBbundle installfR or the Bundler runtime, such as fB--path foofR or fB--without productionfR, are remembered between commands and saved to your local application’s configuration (normally, fB./.bundle/configfR). .P However, this will be changed in bundler 4, so it’s better not to rely on this behavior. If these options must be remembered, it’s better to set them using fBbundle configfR (e.g., fBbundle config set --local path foofR). .P The flags that can be configured are: .TP fB--binfR Creates a directory (defaults to fB~/binfR) and place any executables from the gem there. These executables run in Bundler’s context. If used, you might add this directory to your environment’s fBPATHfR variable. For instance, if the fBrailsfR gem comes with a fBrailsfR executable, this flag will create a fBbin/railsfR executable that ensures that all referred dependencies will be resolved using the bundled gems. .TP fB--deploymentfR In deployment mode, Bundler will ‘roll-out’ the bundle for fBproductionfR use. Please check carefully if you want to have this option enabled in fBdevelopmentfR or fBtestfR environments. .TP fB--onlyfR A space-separated list of groups to install only gems of the specified groups. Please check carefully if you want to install also gems without a group, cause they get put inside fBdefaultfR group. For example fBonly test:defaultfR will install all gems specified in test group and without one. .TP fB--pathfR The location to install the specified gems to. This defaults to Rubygems’ setting. Bundler shares this location with Rubygems, fBgem install |.|.|.fR will have gem installed there, too. Therefore, gems installed without a fB--path |.|.|.fR setting will show up by calling fBgem listfR. Accordingly, gems installed to other locations will not get listed. .TP fB--withoutfR A space-separated or fB:fR-separated list of groups referencing gems to skip during installation. .TP fB--withfR A space-separated or fB:fR-separated list of fBoptionalfR groups referencing gems to include during installation. .SH “BUILD OPTIONS” You can use fBbundle configfR to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem. .P A very common example, the fBmysqlfR gem, requires Snow Leopard users to pass configuration flags to fBgem installfR to specify where to find the fBmysql_configfR executable. .IP “” 4 .nf gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config .fi .IP “” 0 .P Since the specific location of that executable can change from machine to machine, you can specify these flags on a per-machine basis. .IP “” 4 .nf bundle config set --global build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config .fi .IP “” 0 .P After running this command, every time bundler needs to install the fBmysqlfR gem, it will pass along the flags you specified. .SH “LOCAL GIT REPOS” Bundler also allows you to work against a git repository locally instead of using the remote version. This can be achieved by setting up a local override: .IP “” 4 .nf bundle config set --local local.GEM_NAME /path/to/local/git/repository .fi .IP “” 0 .P For example, in order to use a local Rack repository, a developer could call: .IP “” 4 .nf bundle config set --local local.rack ~/Work/git/rack .fi .IP “” 0 .P Now instead of checking out the remote git repository, the local override will be used. Similar to a path source, every time the local git repository change, changes will be automatically picked up by Bundler. This means a commit in the local git repo will update the revision in the fBGemfile.lockfR to the local git repo revision. This requires the same attention as git submodules. Before pushing to the remote, you need to ensure the local override was pushed, otherwise you may point to a commit that only exists in your local machine. You’ll also need to CGI escape your usernames and passwords as well. .P Bundler does many checks to ensure a developer won’t work with invalid references. Particularly, we force a developer to specify a branch in the fBGemfilefR in order to use this feature. If the branch specified in the fBGemfilefR and the current branch in the local git repository do not match, Bundler will abort. This ensures that a developer is always working against the correct branches, and prevents accidental locking to a different branch. .P Finally, Bundler also ensures that the current revision in the fBGemfile.lockfR exists in the local git repository. By doing this, Bundler forces you to fetch the latest changes in the remotes. .SH “MIRRORS OF GEM SOURCES” Bundler supports overriding gem sources with mirrors. This allows you to configure rubygems.org as the gem source in your Gemfile while still using your mirror to fetch gems. .IP “” 4 .nf bundle config set --global mirror.SOURCE_URL MIRROR_URL .fi .IP “” 0 .P For example, to use a mirror of rubygems.org hosted at example.org: .IP “” 4 .nf bundle config set --global mirror.rubygems.org example.org .fi .IP “” 0 .P Each mirror also provides a fallback timeout setting. If the mirror does not respond within the fallback timeout, Bundler will try to use the original server instead of the mirror. .IP “” 4 .nf bundle config set --global mirror.SOURCE_URL.fallback_timeout TIMEOUT .fi .IP “” 0 .P For example, to fall back to rubygems.org after 3 seconds: .IP “” 4 .nf bundle config set --global mirror.rubygems.org.fallback_timeout 3 .fi .IP “” 0 .P The default fallback timeout is 0.1 seconds, but the setting can currently only accept whole seconds (for example, 1, 15, or 30). .SH “CREDENTIALS FOR GEM SOURCES” Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile. .IP “” 4 .nf bundle config set --global SOURCE_HOSTNAME USERNAME:PASSWORD .fi .IP “” 0 .P For example, to save the credentials of user fBclaudettefR for the gem source at fBgems.longerous.comfR, you would run: .IP “” 4 .nf bundle config set --global gems.longerous.com claudette:s00pers3krit .fi .IP “” 0 .P Or you can set the credentials as an environment variable like this: .IP “” 4 .nf export BUNDLE_GEMS__LONGEROUS__COM=“claudette:s00pers3krit” .fi .IP “” 0 .P For gems with a git source with HTTP(S) URL you can specify credentials like so: .IP “” 4 .nf bundle config set --global github.com/rubygems/rubygems.git username:password .fi .IP “” 0 .P Or you can set the credentials as an environment variable like so: .IP “” 4 .nf export BUNDLE_GITHUB__COM=username:password .fi .IP “” 0 .P This is especially useful for private repositories on hosts such as GitHub, where you can use personal OAuth tokens: .IP “” 4 .nf export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic .fi .IP “” 0 .P Note that any configured credentials will be redacted by informative commands such as fBbundle config listfR or fBbundle config getfR, unless you use the fB--parseablefR flag. This is to avoid unintentionally leaking credentials when copy-pasting bundler output. .P Also note that to guarantee a sane mapping between valid environment variable names and valid host names, bundler makes the following transformations: .IP “(bu” 4 Any fB-fR characters in a host name are mapped to a triple underscore (fB___fR) in the corresponding environment variable. .IP “(bu” 4 Any fB.fR characters in a host name are mapped to a double underscore (fB__fR) in the corresponding environment variable. .IP “” 0 .P This means that if you have a gem server named fBmy.gem-host.comfR, you’ll need to use the fBBUNDLE_MY__GEM___HOST__COMfR variable to configure credentials for it through ENV. .SH “CONFIGURE BUNDLER DIRECTORIES” Bundler’s home, cache and plugin directories and config file can be configured through environment variables. The default location for Bundler’s home directory is fB~/.bundlefR, which all directories inherit from by default. The following outlines the available environment variables and their default values .IP “” 4 .nf BUNDLE_USER_HOME : $HOME/.bundle BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin .fi .IP “” 0