bundle-config - Set bundler configuration options
bundle config[name [value]]
This command allows you to interact with bundler's configuration system.
Bundler retrieves its configuration from the local application (
environment variables, and the user's home directory (
in that order of priority.
bundle config with no parameters will print a list of all
bundler configuration for the current bundle, and where that configuration
bundle config <name> will print the value of that configuration
setting, and where it was set.
bundle config <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.
bundle config --global <name> <value> works the same as above.
bundle config --local <name> <value> will set that configuration to
the local application. The configuration will be stored in
bundle config --delete <name> will delete the configuration in both
local and global sources. Not compatible with --global or --local flag.
Executing bundle with the
BUNDLE_IGNORE_CONFIG environment variable set will
cause it to ignore all configuration.
bundle config disable_multisource true upgrades the warning about
the Gemfile containing multiple primary sources to an error. Executing
config --delete disable_multisource downgrades this error to a warning.
Flags passed to
bundle install or the Bundler runtime,
--path foo or
--without production, are not remembered between commands.
If these options must be remembered,they must be set using
bundle config path foo).
The options that can be configured are:
~/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
PATHvariable. For instance, if the
railsgem comes with a
railsexecutable, this flag will create a
bin/railsexecutable that ensures that all referred dependencies will be resolved using the bundled gems.
productionuse. Please check carefully if you want to have this option enabled in
gem install ...will have gem installed there, too. Therefore, gems installed without a
--path ...setting will show up by calling
gem list. Accodingly, gems installed to other locations will not get listed.
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
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 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 in bundler have two forms: the canonical form and the environment variable form.
For instance, passing the
--without flag to bundle install(1)
prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler
persists this value in
app/.bundle/config so that calls to
do not try to find gems from the
Gemfile that you didn't install. Additionally,
subsequent calls to bundle install(1) remember this setting and skip those
The canonical form of this configuration is
"without". To convert the canonical
form to the environment variable form, capitalize it, and prepend
environment variable form of
Any periods in the configuration keys must be replaced with two underscores when
setting it via environment variables. The configuration key
the environment variable
The following is a list of all configuration keys and their purpose. You can learn more about their operation in bundle install(1).
BUNDLE_PATH): The location on disk where all gems in your bundle will be located regardless of
$GEM_PATHvalues. Bundle gems not found in this location will be installed by
bundle install. Defaults to
Gem.dir. When --deployment is used, defaults to vendor/bundle.
BUNDLE_FROZEN): Disallow changes to the
Gemfile. Defaults to
:-separated list of groups whose gems bundler should not install
BUNDLE_BIN): Install executables from gems in the bundle to the specified directory. Defaults to
BUNDLE_GEMFILE): The name of the file that bundler should use as the
Gemfile. This location of this file also sets the root of the project, which is used to resolve relative paths in the
Gemfile, among other things. By default, bundler will search up from the current working directory until it finds a
BUNDLE_SSL_CA_CERT): Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format.
BUNDLE_SSL_CLIENT_CERT): Path to a designated file containing a X.509 client certificate and key in PEM format.
BUNDLE_CACHE_PATH): The directory that bundler will place cached gems in when running
bundle package, and that bundler will look in when installing gems.
BUNDLE_DISABLE_MULTISOURCE): When set, Gemfiles containing multiple sources will produce errors instead of warnings. Use
bundle config --delete disable_multisourceto unset.
BUNDLE_IGNORE_MESSAGES): When set, no post install messages will be printed. To silence a single gem, use dot notation like
BUNDLE_RETRY): The number of times to retry failed network requests. Defaults to
BUNDLE_REDIRECT): The number of redirects allowed for network requests. Defaults to
BUNDLE_TIMEOUT): The seconds allowed before timing out for network requests. Defaults to
In general, you should set these settings per-application by using the applicable flag to the bundle install(1) or bundle package(1) command.
You can set them globally either via environment variables or
whichever is preferable for your setup. If you use both, environment variables
will take preference over global settings.
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 local.GEM_NAME /path/to/local/git/repository
For example, in order to use a local Rack repository, a developer could call:
bundle config 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.
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.
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 mirror.SOURCE_URL MIRROR_URL
For example, to use a mirror of rubygems.org hosted at
bundle config mirror.http://rubygems.org http://rubygems-mirror.org
Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile.
bundle config SOURCE_HOSTNAME USERNAME:PASSWORD
For example, to save the credentials of user
claudette for the gem source at
gems.longerous.com, you would run:
bundle config gems.longerous.com claudette:s00pers3krit
Or you can set the credentials as an environment variable like this: