1BUNDLE-CONFIG(1) BUNDLE-CONFIG(1)
2
6 bundle-config - Set bundler configuration options
7
9 bundle config [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 with no parameters will print a list of all
28 bundler configuration for the current bundle, and where that configura‐
29 tion was set.
30 Executing bundle config <name> will print the value of that configura‐
32 tion setting, and where it was set.
33 Executing bundle config <name> <value> will set that configuration to
35 the value specified for all bundles executed as the current user. The
36 configuration will be stored in ~/.bundle/config. If name already is
37 set, name will be overridden and user will be warned.
38 Executing bundle config --global <name> <value> works the same as
40 above.
41 Executing bundle config --local <name> <value> will set that configura‐
43 tion to the local application. The configuration will be stored in
44 app/.bundle/config.
45 Executing bundle config --delete <name> will delete the configuration
47 in both local and global sources. Not compatible with --global or
48 --local flag.
49 Executing bundle with the BUNDLE_IGNORE_CONFIG environment variable set
51 will cause it to ignore all configuration.
52 Executing bundle config disable_multisource true upgrades the warning
54 about the Gemfile containing multiple primary sources to an error. Exe‐
55 cuting bundle config --delete disable_multisource downgrades this error
56 to a warning.
57
59 Flags passed to bundle install or the Bundler runtime, such as --path
60 foo or --without production, are not remembered between commands. If
61 these options must be remembered,they must be set using bundle config
62 (e.g., bundle config path foo).
63 The options that can be configured are:
65 bin Creates a directory (defaults to ~/bin) and place any executa‐
67 bles from the gem there. These executables run in Bundler´s con‐
68 text. If used, you might add this directory to your environ‐
69 ment´s PATH variable. For instance, if the rails gem comes with
70 a rails executable, this flag will create a bin/rails executable
71 that ensures that all referred dependencies will be resolved
72 using the bundled gems.
73 deployment
75 In deployment mode, Bundler will ´roll-out´ the bundle for pro‐
76 duction use. Please check carefully if you want to have this
77 option enabled in development or test environments.
78 path The location to install the specified gems to. This defaults to
80 Rubygems´ setting. Bundler shares this location with Rubygems,
81 gem install ... will have gem installed there, too. Therefore,
82 gems installed without a --path ... setting will show up by
83 calling gem list. Accordingly, gems installed to other locations
84 will not get listed.
85 without
87 A space-separated list of groups referencing gems to skip during
88 installation.
89 with A space-separated list of groups referencing gems to include
91 during installation.
92
94 You can use bundle config to give Bundler the flags to pass to the gem
95 installer every time bundler tries to install a particular gem.
96 A very common example, the mysql gem, requires Snow Leopard users to
98 pass configuration flags to gem install to specify where to find the
99 mysql_config executable.
100 gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
104 Since the specific location of that executable can change from machine
108 to machine, you can specify these flags on a per-machine basis.
109 bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
113 After running this command, every time bundler needs to install the
117 mysql gem, it will pass along the flags you specified.
118
120 Configuration keys in bundler have two forms: the canonical form and
121 the environment variable form.
122 For instance, passing the --without flag to bundle install(1) bun‐
124 dle-install.1.html prevents Bundler from installing certain groups
125 specified in the Gemfile(5). Bundler persists this value in app/.bun‐
126 dle/config so that calls to Bundler.setup do not try to find gems from
127 the Gemfile that you didn´t install. Additionally, subsequent calls to
128 bundle install(1) bundle-install.1.html remember this setting and skip
129 those groups.
130 The canonical form of this configuration is "without". To convert the
132 canonical form to the environment variable form, capitalize it, and
133 prepend BUNDLE_. The environment variable form of "without" is BUN‐
134 DLE_WITHOUT.
135 Any periods in the configuration keys must be replaced with two under‐
137 scores when setting it via environment variables. The configuration key
138 local.rack becomes the environment variable BUNDLE_LOCAL__RACK.
139
141 The following is a list of all configuration keys and their purpose.
142 You can learn more about their operation in bundle install(1) bun‐
143 dle-install.1.html.
144 · allow_bundler_dependency_conflicts (BUNDLE_ALLOW_BUNDLER_DEPEN‐
146 DENCY_CONFLICTS): Allow resolving to specifications that have
147 dependencies on bundler that are incompatible with the running
148 Bundler version.
149 · allow_deployment_source_credential_changes (BUNDLE_ALLOW_DEPLOY‐
151 MENT_SOURCE_CREDENTIAL_CHANGES): When in deployment mode, allow
152 changing the credentials to a gem´s source. Ex:
153 https://some.host.com/gems/path/ -> https://user_name:pass‐
154 word@some.host.com/gems/path
155 · allow_offline_install (BUNDLE_ALLOW_OFFLINE_INSTALL): Allow Bundler
157 to use cached data when installing without network access.
158 · auto_clean_without_path (BUNDLE_AUTO_CLEAN_WITHOUT_PATH): Automati‐
160 cally run bundle clean after installing when an explicit path has
161 not been set and Bundler is not installing into the system gems.
162 · auto_install (BUNDLE_AUTO_INSTALL): Automatically run bundle
164 install when gems are missing.
165 · bin (BUNDLE_BIN): Install executables from gems in the bundle to
167 the specified directory. Defaults to false.
168 · cache_all (BUNDLE_CACHE_ALL): Cache all gems, including path and
170 git gems.
171 · cache_all_platforms (BUNDLE_CACHE_ALL_PLATFORMS): Cache gems for
173 all platforms.
174 · cache_path (BUNDLE_CACHE_PATH): The directory that bundler will
176 place cached gems in when running bundle package, and that bundler
177 will look in when installing gems. Defaults to vendor/bundle.
178 · clean (BUNDLE_CLEAN): Whether Bundler should run bundle clean auto‐
180 matically after bundle install.
181 · console (BUNDLE_CONSOLE): The console that bundle console starts.
183 Defaults to irb.
184 · default_install_uses_path (BUNDLE_DEFAULT_INSTALL_USES_PATH):
186 Whether a bundle install without an explicit --path argument
187 defaults to installing gems in .bundle.
188 · deployment (BUNDLE_DEPLOYMENT): Disallow changes to the Gemfile.
190 When the Gemfile is changed and the lockfile has not been updated,
191 running Bundler commands will be blocked.
192 · disable_checksum_validation (BUNDLE_DISABLE_CHECKSUM_VALIDATION):
194 Allow installing gems even if they do not match the checksum pro‐
195 vided by RubyGems.
196 · disable_exec_load (BUNDLE_DISABLE_EXEC_LOAD): Stop Bundler from
198 using load to launch an executable in-process in bundle exec.
199 · disable_local_branch_check (BUNDLE_DISABLE_LOCAL_BRANCH_CHECK):
201 Allow Bundler to use a local git override without a branch speci‐
202 fied in the Gemfile.
203 · disable_multisource (BUNDLE_DISABLE_MULTISOURCE): When set, Gem‐
205 files containing multiple sources will produce errors instead of
206 warnings. Use bundle config --delete disable_multisource to unset.
207 · disable_platform_warnings (BUNDLE_DISABLE_PLATFORM_WARNINGS): Dis‐
209 able warnings during bundle install when a dependency is unused on
210 the current platform.
211 · disable_shared_gems (BUNDLE_DISABLE_SHARED_GEMS): Stop Bundler from
213 accessing gems installed to RubyGems´ normal location.
214 · disable_version_check (BUNDLE_DISABLE_VERSION_CHECK): Stop Bundler
216 from checking if a newer Bundler version is available on
217 rubygems.org.
218 · error_on_stderr (BUNDLE_ERROR_ON_STDERR): Print Bundler errors to
220 stderr.
221 · force_ruby_platform (BUNDLE_FORCE_RUBY_PLATFORM): Ignore the cur‐
223 rent machine´s platform and install only ruby platform gems. As a
224 result, gems with native extensions will be compiled from source.
225 · frozen (BUNDLE_FROZEN): Disallow changes to the Gemfile. When the
227 Gemfile is changed and the lockfile has not been updated, running
228 Bundler commands will be blocked. Defaults to true when --deploy‐
229 ment is used.
230 · gem.push_key (BUNDLE_GEM__PUSH_KEY): Sets the --key parameter for
232 gem push when using the rake release command with a private gem‐
233 stash server.
234 · gemfile (BUNDLE_GEMFILE): The name of the file that bundler should
236 use as the Gemfile. This location of this file also sets the root
237 of the project, which is used to resolve relative paths in the Gem‐
238 file, among other things. By default, bundler will search up from
239 the current working directory until it finds a Gemfile.
240 · global_gem_cache (BUNDLE_GLOBAL_GEM_CACHE): Whether Bundler should
242 cache all gems globally, rather than locally to the installing Ruby
243 installation.
244 · global_path_appends_ruby_scope (BUN‐
246 DLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE): Whether Bundler should append
247 the Ruby scope (e.g. engine and ABI version) to a globally-config‐
248 ured path.
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 · list_command (BUNDLE_LIST_COMMAND) Enable new list command feature
261 · major_deprecations (BUNDLE_MAJOR_DEPRECATIONS): Whether Bundler
263 should print deprecation warnings for behavior that will be changed
264 in the next major version.
265 · no_install (BUNDLE_NO_INSTALL): Whether bundle package should skip
267 installing gems.
268 · no_prune (BUNDLE_NO_PRUNE): Whether Bundler should leave outdated
270 gems unpruned when caching.
271 · only_update_to_newer_versions (BUNDLE_ONLY_UPDATE_TO_NEWER_VER‐
273 SIONS): During bundle update, only resolve to newer versions of the
274 gems in the lockfile.
275 · path (BUNDLE_PATH): The location on disk where all gems in your
277 bundle will be located regardless of $GEM_HOME or $GEM_PATH values.
278 Bundle gems not found in this location will be installed by bundle
279 install. Defaults to Gem.dir. When --deployment is used, defaults
280 to vendor/bundle.
281 · path.system (BUNDLE_PATH__SYSTEM): Whether Bundler will install
283 gems into the default system path (Gem.dir).
284 · path_relative_to_cwd (PATH_RELATIVE_TO_CWD) Makes --path relative
286 to the CWD instead of the Gemfile.
287 · plugins (BUNDLE_PLUGINS): Enable Bundler´s experimental plugin sys‐
289 tem.
290 · prefer_gems_rb (BUNDLE_PREFER_GEMS_RB) Prefer gems.rb to Gemfile
292 when Bundler is searching for a Gemfile.
293 · print_only_version_number (BUNDLE_PRINT_ONLY_VERSION_NUMBER) Print
295 only version number from bundler --version.
296 · redirect (BUNDLE_REDIRECT): The number of redirects allowed for
298 network requests. Defaults to 5.
299 · retry (BUNDLE_RETRY): The number of times to retry failed network
301 requests. Defaults to 3.
302 · setup_makes_kernel_gem_public (BUNDLE_SETUP_MAKES_KERNEL_GEM_PUB‐
304 LIC): Have Bundler.setup make the Kernel#gem method public, even
305 though RubyGems declares it as private.
306 · shebang (BUNDLE_SHEBANG): The program name that should be invoked
308 for generated binstubs. Defaults to the ruby install name used to
309 generate the binstub.
310 · silence_root_warning (BUNDLE_SILENCE_ROOT_WARNING): Silence the
312 warning Bundler prints when installing gems as root.
313 · skip_default_git_sources (BUNDLE_SKIP_DEFAULT_GIT_SOURCES): Whether
315 Bundler should skip adding default git source shortcuts to the Gem‐
316 file DSL.
317 · specific_platform (BUNDLE_SPECIFIC_PLATFORM): Allow bundler to
319 resolve for the specific running platform and store it in the lock‐
320 file, instead of only using a generic platform. A specific platform
321 is the exact platform triple reported by Gem::Platform.local, such
322 as x86_64-darwin-16 or universal-java-1.8. On the other hand,
323 generic platforms are those such as ruby, mswin, or java. In this
324 example, x86_64-darwin-16 would map to ruby and universal-java-1.8
325 to java.
326 · ssl_ca_cert (BUNDLE_SSL_CA_CERT): Path to a designated CA certifi‐
328 cate file or folder containing multiple certificates for trusted
329 CAs in PEM format.
330 · ssl_client_cert (BUNDLE_SSL_CLIENT_CERT): Path to a designated file
332 containing a X.509 client certificate and key in PEM format.
333 · ssl_verify_mode (BUNDLE_SSL_VERIFY_MODE): The SSL verification mode
335 Bundler uses when making HTTPS requests. Defaults to verify peer.
336 · suppress_install_using_messages (BUNDLE_SUPPRESS_INSTALL_USING_MES‐
338 SAGES): Avoid printing Using ... messages during installation when
339 the version of a gem has not changed.
340 · system_bindir (BUNDLE_SYSTEM_BINDIR): The location where RubyGems
342 installs binstubs. Defaults to Gem.bindir.
343 · timeout (BUNDLE_TIMEOUT): The seconds allowed before timing out for
345 network requests. Defaults to 10.
346 · unlock_source_unlocks_spec (BUNDLE_UNLOCK_SOURCE_UNLOCKS_SPEC):
348 Whether running bundle update --source NAME unlocks a gem with the
349 given name. Defaults to true.
350 · update_requires_all_flag (BUNDLE_UPDATE_REQUIRES_ALL_FLAG) Require
352 passing --all to bundle update when everything should be updated,
353 and disallow passing no options to bundle update.
354 · user_agent (BUNDLE_USER_AGENT): The custom user agent fragment
356 Bundler includes in API requests.
357 · with (BUNDLE_WITH): A :-separated list of groups whose gems bundler
359 should install.
360 · without (BUNDLE_WITHOUT): A :-separated list of groups whose gems
362 bundler should not install.
363 In general, you should set these settings per-application by using the
367 applicable flag to the bundle install(1) bundle-install.1.html or bun‐
368 dle package(1) bundle-package.1.html command.
369 You can set them globally either via environment variables or bundle
371 config, whichever is preferable for your setup. If you use both, envi‐
372 ronment variables will take preference over global settings.
373
375 Bundler also allows you to work against a git repository locally
376 instead of using the remote version. This can be achieved by setting up
377 a local override:
378 bundle config local.GEM_NAME /path/to/local/git/repository
382 For example, in order to use a local Rack repository, a developer could
386 call:
387 bundle config local.rack ~/Work/git/rack
391 Now instead of checking out the remote git repository, the local over‐
395 ride will be used. Similar to a path source, every time the local git
396 repository change, changes will be automatically picked up by Bundler.
397 This means a commit in the local git repo will update the revision in
398 the Gemfile.lock to the local git repo revision. This requires the same
399 attention as git submodules. Before pushing to the remote, you need to
400 ensure the local override was pushed, otherwise you may point to a com‐
401 mit that only exists in your local machine. You´ll also need to CGI
402 escape your usernames and passwords as well.
403 Bundler does many checks to ensure a developer won´t work with invalid
405 references. Particularly, we force a developer to specify a branch in
406 the Gemfile in order to use this feature. If the branch specified in
407 the Gemfile and the current branch in the local git repository do not
408 match, Bundler will abort. This ensures that a developer is always
409 working against the correct branches, and prevents accidental locking
410 to a different branch.
411 Finally, Bundler also ensures that the current revision in the Gem‐
413 file.lock exists in the local git repository. By doing this, Bundler
414 forces you to fetch the latest changes in the remotes.
415
417 Bundler supports overriding gem sources with mirrors. This allows you
418 to configure rubygems.org as the gem source in your Gemfile while still
419 using your mirror to fetch gems.
420 bundle config mirror.SOURCE_URL MIRROR_URL
424 For example, to use a mirror of rubygems.org hosted at rubygems-mir‐
428 ror.org:
429 bundle config mirror.http://rubygems.org http://rubygems-mirror.org
433 Each mirror also provides a fallback timeout setting. If the mirror
437 does not respond within the fallback timeout, Bundler will try to use
438 the original server instead of the mirror.
439 bundle config mirror.SOURCE_URL.fallback_timeout TIMEOUT
443 For example, to fall back to rubygems.org after 3 seconds:
447 bundle config mirror.https://rubygems.org.fallback_timeout 3
451 The default fallback timeout is 0.1 seconds, but the setting can cur‐
455 rently only accept whole seconds (for example, 1, 15, or 30).
456
458 Bundler allows you to configure credentials for any gem source, which
459 allows you to avoid putting secrets into your Gemfile.
460 bundle config SOURCE_HOSTNAME USERNAME:PASSWORD
464 For example, to save the credentials of user claudette for the gem
468 source at gems.longerous.com, you would run:
469 bundle config gems.longerous.com claudette:s00pers3krit
473 Or you can set the credentials as an environment variable like this:
477 export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
481 For gems with a git source with HTTP(S) URL you can specify credentials
485 like so:
486 bundle config https://github.com/bundler/bundler.git username:password
490 Or you can set the credentials as an environment variable like so:
494 export BUNDLE_GITHUB__COM=username:password
498 This is especially useful for private repositories on hosts such as
502 Github, where you can use personal OAuth tokens:
503 export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic
507
511 Bundler´s home, config, cache and plugin directories are able to be
512 configured through environment variables. The default location for
513 Bundler´s home directory is ~/.bundle, which all directories inherit
514 from by default. The following outlines the available environment vari‐
515 ables and their default values
516 BUNDLE_USER_HOME : $HOME/.bundle
520 BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
521 BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
522 BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
523 December 2018 BUNDLE-CONFIG(1)