bundle-config - Man Page

Set bundler configuration options


bundle config [list|get|set|unset] [name [value]]


This command allows you to interact with Bundler´s configuration system.

Bundler loads configuration settings in this order:

  1. Local config (app/.bundle/config)
  2. Environmental variables (ENV)
  3. Global config (~/.bundle/config)
  4. Bundler default config

Executing bundle config list with will print a list of all bundler configuration for the current bundle, and where that configuration was set.

Executing bundle config get <name> will print the value of that configuration setting, and where it was set.

Executing bundle config set <name> <value> will set that configuration to the value specified for all bundles executed as the current user. The configuration will be stored in ~/.bundle/config. If name already is set, name will be overridden and user will be warned.

Executing bundle config set --global <name> <value> works the same as above.

Executing bundle config set --local <name> <value> will set that configuration to the local application. The configuration will be stored in app/.bundle/config.

Executing bundle config unset <name> will delete the configuration in both local and global sources.

Executing bundle config unset --global <name> will delete the configuration only from the user configuration.

Executing bundle config unset --local <name> <value> will delete the configuration only from the local application.

Executing bundle with the BUNDLE_IGNORE_CONFIG environment variable set will cause it to ignore all configuration.

Executing bundle config set disable_multisource true upgrades the warning about the Gemfile containing multiple primary sources to an error. Executing bundle config unset disable_multisource downgrades this error to a warning.

Remembering Options

Flags passed to bundle install or the Bundler runtime, such as --path foo or --without production, are remembered between commands and saved to your local application´s configuration (normally, ./.bundle/config).

However, this will be changed in bundler 3, so it´s better not to rely on this behavior. If these options must be remembered, it´s better to set them using bundle config (e.g., bundle config set path foo).

The options that can be configured are:


Creates a directory (defaults to ~/bin) 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 PATH variable. For instance, if the rails gem comes with a rails executable, this flag will create a bin/rails executable that ensures that all referred dependencies will be resolved using the bundled gems.


In deployment mode, Bundler will ´roll-out´ the bundle for production use. Please check carefully if you want to have this option enabled in development or test environments.


The location to install the specified gems to. This defaults to Rubygems´ setting. Bundler shares this location with Rubygems, gem install ... will have gem installed there, too. Therefore, gems installed without a --path ... setting will show up by calling gem list. Accordingly, gems installed to other locations will not get listed.


A space-separated list of groups referencing gems to skip during installation.


A space-separated list of groups referencing gems to include during installation.

Build Options

You can use bundle config to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem.

A very common example, the mysql gem, requires Snow Leopard users to pass configuration flags to gem install to specify where to find the mysql_config executable.

gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config

Since the specific location of that executable can change from machine to machine, you can specify these flags on a per-machine basis.

bundle config set build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config

After running this command, every time bundler needs to install the mysql gem, it will pass along the flags you specified.

Configuration Keys

Configuration keys in bundler have two forms: the canonical form and the environment variable form.

For instance, passing the --without flag to bundle install(1) bundle-install.1.html prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler persists this value in app/.bundle/config so that calls to Bundler.setup do not try to find gems from the Gemfile that you didn´t install. Additionally, subsequent calls to bundle install(1) bundle-install.1.html remember this setting and skip those groups.

The canonical form of this configuration is "without". To convert the canonical form to the environment variable form, capitalize it, and prepend BUNDLE_. The environment variable form of "without" is BUNDLE_WITHOUT.

Any periods in the configuration keys must be replaced with two underscores when setting it via environment variables. The configuration key local.rack becomes the environment variable BUNDLE_LOCAL__RACK.

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) bundle-install.1.html.

In general, you should set these settings per-application by using the applicable flag to the bundle install(1) bundle-install.1.html or bundle package(1) bundle-package.1.html command.

You can set them globally either via environment variables or bundle config, whichever is preferable for your setup. If you use both, environment variables will take preference over global settings.

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:

bundle config set local.GEM_NAME /path/to/local/git/repository

For example, in order to use a local Rack repository, a developer could call:

bundle config set local.rack ~/Work/git/rack

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

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 Gemfile in order to use this feature. If the branch specified in the Gemfile 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.

Finally, Bundler also ensures that the current revision in the Gemfile.lock exists in the local git repository. By doing this, Bundler forces you to fetch the latest changes in the remotes.

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.

bundle config set mirror.SOURCE_URL MIRROR_URL

For example, to use a mirror of rubygems.org hosted at rubygems-mirror.org:

bundle config set mirror.http://rubygems.org http://rubygems-mirror.org

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.

bundle config set mirror.SOURCE_URL.fallback_timeout TIMEOUT

For example, to fall back to rubygems.org after 3 seconds:

bundle config set mirror.https://rubygems.org.fallback_timeout 3

The default fallback timeout is 0.1 seconds, but the setting can currently only accept whole seconds (for example, 1, 15, or 30).

Credentials for Gem Sources

Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile.


For example, to save the credentials of user claudette for the gem source at gems.longerous.com, you would run:

bundle config set gems.longerous.com claudette:s00pers3krit

Or you can set the credentials as an environment variable like this:

export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"

For gems with a git source with HTTP(S) URL you can specify credentials like so:

bundle config set https://github.com/bundler/bundler.git username:password

Or you can set the credentials as an environment variable like so:

export BUNDLE_GITHUB__COM=username:password

This is especially useful for private repositories on hosts such as Github, where you can use personal OAuth tokens:

export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic

Configure Bundler Directories

Bundler´s home, config, cache and plugin directories are able to be configured through environment variables. The default location for Bundler´s home directory is ~/.bundle, which all directories inherit from by default. The following outlines the available environment variables and their default values


Referenced By

bundle-gem(1), bundle-install(1).

January 2020