1BUNDLE-CONFIG(1) BUNDLE-CONFIG(1)
2
6 bundle-config - Set bundler configuration options
7
9 bundle config [list|get|set|unset] [name [value]]
10
12 This command allows you to interact with Bundler´s configuration sys‐
13 tem.
14 Bundler loads configuration settings in this order:
16 1. Local config (app/.bundle/config)
18 2. Environmental variables (ENV)
20 3. Global config (~/.bundle/config)
22 4. Bundler default config
24 Executing bundle config list with will print a list of all bundler con‐
28 figuration for the current bundle, and where that configuration was
29 set.
30 Executing bundle config get <name> will print the value of that config‐
32 uration setting, and where it was set.
33 Executing bundle config set <name> <value> will set that configuration
35 to the value specified for all bundles executed as the current user.
36 The configuration will be stored in ~/.bundle/config. If name already
37 is set, name will be overridden and user will be warned.
38 Executing bundle config set --global <name> <value> works the same as
40 above.
41 Executing bundle config set --local <name> <value> will set that con‐
43 figuration to the local application. The configuration will be stored
44 in app/.bundle/config.
45 Executing bundle config unset <name> will delete the configuration in
47 both local and global sources.
48 Executing bundle config unset --global <name> will delete the configu‐
50 ration only from the user configuration.
51 Executing bundle config unset --local <name> <value> will delete the
53 configuration only from the local application.
54 Executing bundle with the BUNDLE_IGNORE_CONFIG environment variable set
56 will cause it to ignore all configuration.
57 Executing bundle config set disable_multisource true upgrades the warn‐
59 ing about the Gemfile containing multiple primary sources to an error.
60 Executing bundle config unset disable_multisource downgrades this error
61 to a warning.
62
64 Flags passed to bundle install or the Bundler runtime, such as --path
65 foo or --without production, are remembered between commands and saved
66 to your local application´s configuration (normally, ./.bundle/config).
67 However, this will be changed in bundler 3, so it´s better not to rely
69 on this behavior. If these options must be remembered, it´s better to
70 set them using bundle config (e.g., bundle config set path foo).
71 The options that can be configured are:
73 bin Creates a directory (defaults to ~/bin) and place any executa‐
75 bles from the gem there. These executables run in Bundler´s con‐
76 text. If used, you might add this directory to your environ‐
77 ment´s PATH variable. For instance, if the rails gem comes with
78 a rails executable, this flag will create a bin/rails executable
79 that ensures that all referred dependencies will be resolved
80 using the bundled gems.
81 deployment
83 In deployment mode, Bundler will ´roll-out´ the bundle for pro‐
84 duction use. Please check carefully if you want to have this
85 option enabled in development or test environments.
86 path The location to install the specified gems to. This defaults to
88 Rubygems´ setting. Bundler shares this location with Rubygems,
89 gem install ... will have gem installed there, too. Therefore,
90 gems installed without a --path ... setting will show up by
91 calling gem list. Accordingly, gems installed to other locations
92 will not get listed.
93 without
95 A space-separated list of groups referencing gems to skip during
96 installation.
97 with A space-separated list of groups referencing gems to include
99 during installation.
100
102 You can use bundle config to give Bundler the flags to pass to the gem
103 installer every time bundler tries to install a particular gem.
104 A very common example, the mysql gem, requires Snow Leopard users to
106 pass configuration flags to gem install to specify where to find the
107 mysql_config executable.
108 gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
112 Since the specific location of that executable can change from machine
116 to machine, you can specify these flags on a per-machine basis.
117 bundle config set build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
121 After running this command, every time bundler needs to install the
125 mysql gem, it will pass along the flags you specified.
126
128 Configuration keys in bundler have two forms: the canonical form and
129 the environment variable form.
130 For instance, passing the --without flag to bundle install(1) bun‐
132 dle-install.1.html prevents Bundler from installing certain groups
133 specified in the Gemfile(5). Bundler persists this value in app/.bun‐
134 dle/config so that calls to Bundler.setup do not try to find gems from
135 the Gemfile that you didn´t install. Additionally, subsequent calls to
136 bundle install(1) bundle-install.1.html remember this setting and skip
137 those groups.
138 The canonical form of this configuration is "without". To convert the
140 canonical form to the environment variable form, capitalize it, and
141 prepend BUNDLE_. The environment variable form of "without" is BUN‐
142 DLE_WITHOUT.
143 Any periods in the configuration keys must be replaced with two under‐
145 scores when setting it via environment variables. The configuration key
146 local.rack becomes the environment variable BUNDLE_LOCAL__RACK.
147
149 The following is a list of all configuration keys and their purpose.
150 You can learn more about their operation in bundle install(1) bun‐
151 dle-install.1.html.
152 · allow_bundler_dependency_conflicts (BUNDLE_ALLOW_BUNDLER_DEPEN‐
154 DENCY_CONFLICTS): Allow resolving to specifications that have
155 dependencies on bundler that are incompatible with the running
156 Bundler version.
157 · allow_deployment_source_credential_changes (BUNDLE_ALLOW_DEPLOY‐
159 MENT_SOURCE_CREDENTIAL_CHANGES): When in deployment mode, allow
160 changing the credentials to a gem´s source. Ex:
161 https://some.host.com/gems/path/ -> https://user_name:pass‐
162 word@some.host.com/gems/path
163 · allow_offline_install (BUNDLE_ALLOW_OFFLINE_INSTALL): Allow Bundler
165 to use cached data when installing without network access.
166 · auto_clean_without_path (BUNDLE_AUTO_CLEAN_WITHOUT_PATH): Automati‐
168 cally run bundle clean after installing when an explicit path has
169 not been set and Bundler is not installing into the system gems.
170 · auto_install (BUNDLE_AUTO_INSTALL): Automatically run bundle
172 install when gems are missing.
173 · bin (BUNDLE_BIN): Install executables from gems in the bundle to
175 the specified directory. Defaults to false.
176 · cache_all (BUNDLE_CACHE_ALL): Cache all gems, including path and
178 git gems.
179 · cache_all_platforms (BUNDLE_CACHE_ALL_PLATFORMS): Cache gems for
181 all platforms.
182 · cache_path (BUNDLE_CACHE_PATH): The directory that bundler will
184 place cached gems in when running bundle package, and that bundler
185 will look in when installing gems. Defaults to vendor/cache.
186 · clean (BUNDLE_CLEAN): Whether Bundler should run bundle clean auto‐
188 matically after bundle install.
189 · console (BUNDLE_CONSOLE): The console that bundle console starts.
191 Defaults to irb.
192 · default_install_uses_path (BUNDLE_DEFAULT_INSTALL_USES_PATH):
194 Whether a bundle install without an explicit --path argument
195 defaults to installing gems in .bundle.
196 · deployment (BUNDLE_DEPLOYMENT): Disallow changes to the Gemfile.
198 When the Gemfile is changed and the lockfile has not been updated,
199 running Bundler commands will be blocked.
200 · disable_checksum_validation (BUNDLE_DISABLE_CHECKSUM_VALIDATION):
202 Allow installing gems even if they do not match the checksum pro‐
203 vided by RubyGems.
204 · disable_exec_load (BUNDLE_DISABLE_EXEC_LOAD): Stop Bundler from
206 using load to launch an executable in-process in bundle exec.
207 · disable_local_branch_check (BUNDLE_DISABLE_LOCAL_BRANCH_CHECK):
209 Allow Bundler to use a local git override without a branch speci‐
210 fied in the Gemfile.
211 · disable_multisource (BUNDLE_DISABLE_MULTISOURCE): When set, Gem‐
213 files containing multiple sources will produce errors instead of
214 warnings. Use bundle config unset disable_multisource to unset.
215 · disable_platform_warnings (BUNDLE_DISABLE_PLATFORM_WARNINGS): Dis‐
217 able warnings during bundle install when a dependency is unused on
218 the current platform.
219 · disable_shared_gems (BUNDLE_DISABLE_SHARED_GEMS): Stop Bundler from
221 accessing gems installed to RubyGems´ normal location.
222 · disable_version_check (BUNDLE_DISABLE_VERSION_CHECK): Stop Bundler
224 from checking if a newer Bundler version is available on
225 rubygems.org.
226 · force_ruby_platform (BUNDLE_FORCE_RUBY_PLATFORM): Ignore the cur‐
228 rent machine´s platform and install only ruby platform gems. As a
229 result, gems with native extensions will be compiled from source.
230 · frozen (BUNDLE_FROZEN): Disallow changes to the Gemfile. When the
232 Gemfile is changed and the lockfile has not been updated, running
233 Bundler commands will be blocked. Defaults to true when --deploy‐
234 ment is used.
235 · gem.push_key (BUNDLE_GEM__PUSH_KEY): Sets the --key parameter for
237 gem push when using the rake release command with a private gem‐
238 stash server.
239 · gemfile (BUNDLE_GEMFILE): The name of the file that bundler should
241 use as the Gemfile. This location of this file also sets the root
242 of the project, which is used to resolve relative paths in the Gem‐
243 file, among other things. By default, bundler will search up from
244 the current working directory until it finds a Gemfile.
245 · global_gem_cache (BUNDLE_GLOBAL_GEM_CACHE): Whether Bundler should
247 cache all gems globally, rather than locally to the installing Ruby
248 installation.
249 · ignore_messages (BUNDLE_IGNORE_MESSAGES): When set, no post install
251 messages will be printed. To silence a single gem, use dot notation
252 like ignore_messages.httparty true.
253 · init_gems_rb (BUNDLE_INIT_GEMS_RB) Generate a gems.rb instead of a
255 Gemfile when running bundle init.
256 · jobs (BUNDLE_JOBS): The number of gems Bundler can install in par‐
258 allel. Defaults to 1.
259 · no_install (BUNDLE_NO_INSTALL): Whether bundle package should skip
261 installing gems.
262 · no_prune (BUNDLE_NO_PRUNE): Whether Bundler should leave outdated
264 gems unpruned when caching.
265 · only_update_to_newer_versions (BUNDLE_ONLY_UPDATE_TO_NEWER_VER‐
267 SIONS): During bundle update, only resolve to newer versions of the
268 gems in the lockfile.
269 · path (BUNDLE_PATH): The location on disk where all gems in your
271 bundle will be located regardless of $GEM_HOME or $GEM_PATH values.
272 Bundle gems not found in this location will be installed by bundle
273 install. Defaults to Gem.dir. When --deployment is used, defaults
274 to vendor/bundle.
275 · path.system (BUNDLE_PATH__SYSTEM): Whether Bundler will install
277 gems into the default system path (Gem.dir).
278 · path_relative_to_cwd (BUNDLE_PATH_RELATIVE_TO_CWD) Makes --path
280 relative to the CWD instead of the Gemfile.
281 · plugins (BUNDLE_PLUGINS): Enable Bundler´s experimental plugin sys‐
283 tem.
284 · prefer_patch (BUNDLE_PREFER_PATCH): Prefer updating only to next
286 patch version during updates. Makes bundle update calls equivalent
287 to bundler update --patch.
288 · print_only_version_number (BUNDLE_PRINT_ONLY_VERSION_NUMBER) Print
290 only version number from bundler --version.
291 · redirect (BUNDLE_REDIRECT): The number of redirects allowed for
293 network requests. Defaults to 5.
294 · retry (BUNDLE_RETRY): The number of times to retry failed network
296 requests. Defaults to 3.
297 · setup_makes_kernel_gem_public (BUNDLE_SETUP_MAKES_KERNEL_GEM_PUB‐
299 LIC): Have Bundler.setup make the Kernel#gem method public, even
300 though RubyGems declares it as private.
301 · shebang (BUNDLE_SHEBANG): The program name that should be invoked
303 for generated binstubs. Defaults to the ruby install name used to
304 generate the binstub.
305 · silence_deprecations (BUNDLE_SILENCE_DEPRECATIONS): Whether Bundler
307 should silence deprecation warnings for behavior that will be
308 changed in the next major version.
309 · silence_root_warning (BUNDLE_SILENCE_ROOT_WARNING): Silence the
311 warning Bundler prints when installing gems as root.
312 · skip_default_git_sources (BUNDLE_SKIP_DEFAULT_GIT_SOURCES): Whether
314 Bundler should skip adding default git source shortcuts to the Gem‐
315 file DSL.
316 · specific_platform (BUNDLE_SPECIFIC_PLATFORM): Allow bundler to
318 resolve for the specific running platform and store it in the lock‐
319 file, instead of only using a generic platform. A specific platform
320 is the exact platform triple reported by Gem::Platform.local, such
321 as x86_64-darwin-16 or universal-java-1.8. On the other hand,
322 generic platforms are those such as ruby, mswin, or java. In this
323 example, x86_64-darwin-16 would map to ruby and universal-java-1.8
324 to java.
325 · ssl_ca_cert (BUNDLE_SSL_CA_CERT): Path to a designated CA certifi‐
327 cate file or folder containing multiple certificates for trusted
328 CAs in PEM format.
329 · ssl_client_cert (BUNDLE_SSL_CLIENT_CERT): Path to a designated file
331 containing a X.509 client certificate and key in PEM format.
332 · ssl_verify_mode (BUNDLE_SSL_VERIFY_MODE): The SSL verification mode
334 Bundler uses when making HTTPS requests. Defaults to verify peer.
335 · suppress_install_using_messages (BUNDLE_SUPPRESS_INSTALL_USING_MES‐
337 SAGES): Avoid printing Using ... messages during installation when
338 the version of a gem has not changed.
339 · system_bindir (BUNDLE_SYSTEM_BINDIR): The location where RubyGems
341 installs binstubs. Defaults to Gem.bindir.
342 · timeout (BUNDLE_TIMEOUT): The seconds allowed before timing out for
344 network requests. Defaults to 10.
345 · unlock_source_unlocks_spec (BUNDLE_UNLOCK_SOURCE_UNLOCKS_SPEC):
347 Whether running bundle update --source NAME unlocks a gem with the
348 given name. Defaults to true.
349 · update_requires_all_flag (BUNDLE_UPDATE_REQUIRES_ALL_FLAG) Require
351 passing --all to bundle update when everything should be updated,
352 and disallow passing no options to bundle update.
353 · user_agent (BUNDLE_USER_AGENT): The custom user agent fragment
355 Bundler includes in API requests.
356 · with (BUNDLE_WITH): A :-separated list of groups whose gems bundler
358 should install.
359 · without (BUNDLE_WITHOUT): A :-separated list of groups whose gems
361 bundler should not install.
362 In general, you should set these settings per-application by using the
366 applicable flag to the bundle install(1) bundle-install.1.html or bun‐
367 dle package(1) bundle-package.1.html command.
368 You can set them globally either via environment variables or bundle
370 config, whichever is preferable for your setup. If you use both, envi‐
371 ronment variables will take preference over global settings.
372
374 Bundler also allows you to work against a git repository locally
375 instead of using the remote version. This can be achieved by setting up
376 a local override:
377 bundle config set local.GEM_NAME /path/to/local/git/repository
381 For example, in order to use a local Rack repository, a developer could
385 call:
386 bundle config set local.rack ~/Work/git/rack
390 Now instead of checking out the remote git repository, the local over‐
394 ride will be used. Similar to a path source, every time the local git
395 repository change, changes will be automatically picked up by Bundler.
396 This means a commit in the local git repo will update the revision in
397 the Gemfile.lock to the local git repo revision. This requires the same
398 attention as git submodules. Before pushing to the remote, you need to
399 ensure the local override was pushed, otherwise you may point to a com‐
400 mit that only exists in your local machine. You´ll also need to CGI
401 escape your usernames and passwords as well.
402 Bundler does many checks to ensure a developer won´t work with invalid
404 references. Particularly, we force a developer to specify a branch in
405 the Gemfile in order to use this feature. If the branch specified in
406 the Gemfile and the current branch in the local git repository do not
407 match, Bundler will abort. This ensures that a developer is always
408 working against the correct branches, and prevents accidental locking
409 to a different branch.
410 Finally, Bundler also ensures that the current revision in the Gem‐
412 file.lock exists in the local git repository. By doing this, Bundler
413 forces you to fetch the latest changes in the remotes.
414
416 Bundler supports overriding gem sources with mirrors. This allows you
417 to configure rubygems.org as the gem source in your Gemfile while still
418 using your mirror to fetch gems.
419 bundle config set mirror.SOURCE_URL MIRROR_URL
423 For example, to use a mirror of rubygems.org hosted at rubygems-mir‐
427 ror.org:
428 bundle config set mirror.http://rubygems.org http://rubygems-mirror.org
432 Each mirror also provides a fallback timeout setting. If the mirror
436 does not respond within the fallback timeout, Bundler will try to use
437 the original server instead of the mirror.
438 bundle config set mirror.SOURCE_URL.fallback_timeout TIMEOUT
442 For example, to fall back to rubygems.org after 3 seconds:
446 bundle config set mirror.https://rubygems.org.fallback_timeout 3
450 The default fallback timeout is 0.1 seconds, but the setting can cur‐
454 rently only accept whole seconds (for example, 1, 15, or 30).
455
457 Bundler allows you to configure credentials for any gem source, which
458 allows you to avoid putting secrets into your Gemfile.
459 bundle config set SOURCE_HOSTNAME USERNAME:PASSWORD
463 For example, to save the credentials of user claudette for the gem
467 source at gems.longerous.com, you would run:
468 bundle config set gems.longerous.com claudette:s00pers3krit
472 Or you can set the credentials as an environment variable like this:
476 export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
480 For gems with a git source with HTTP(S) URL you can specify credentials
484 like so:
485 bundle config set https://github.com/bundler/bundler.git username:password
489 Or you can set the credentials as an environment variable like so:
493 export BUNDLE_GITHUB__COM=username:password
497 This is especially useful for private repositories on hosts such as
501 Github, where you can use personal OAuth tokens:
502 export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic
506
510 Bundler´s home, config, cache and plugin directories are able to be
511 configured through environment variables. The default location for
512 Bundler´s home directory is ~/.bundle, which all directories inherit
513 from by default. The following outlines the available environment vari‐
514 ables and their default values
515 BUNDLE_USER_HOME : $HOME/.bundle
519 BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
520 BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
521 BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
522 January 2020 BUNDLE-CONFIG(1)