You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -52,113 +52,165 @@ The canonical form of this configuration is \fB"without"\fR\. To convert the can
52
52
Any periods in the configuration keys must be replaced with two underscores when setting it via environment variables\. The configuration key \fBlocal\.rack\fR becomes the environment variable \fBBUNDLE_LOCAL__RACK\fR\.
53
53
.SH "LIST OF AVAILABLE KEYS"
54
54
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\.html\fR\.
55
-
.IP"\(bu"4
56
-
\fBallow_offline_install\fR (\fBBUNDLE_ALLOW_OFFLINE_INSTALL\fR): Allow Bundler to use cached data when installing without network access\.
57
-
.IP"\(bu"4
58
-
\fBauto_clean_without_path\fR (\fBBUNDLE_AUTO_CLEAN_WITHOUT_PATH\fR): Automatically run \fBbundleclean\fR after installing when an explicit \fBpath\fR has not been set and Bundler is not installing into the system gems\.
59
-
.IP"\(bu"4
60
-
\fBauto_install\fR (\fBBUNDLE_AUTO_INSTALL\fR): Automatically run \fBbundleinstall\fR when gems are missing\.
61
-
.IP"\(bu"4
62
-
\fBbin\fR (\fBBUNDLE_BIN\fR): Install executables from gems in the bundle to the specified directory\. Defaults to \fBfalse\fR\.
63
-
.IP"\(bu"4
64
-
\fBcache_all\fR (\fBBUNDLE_CACHE_ALL\fR): Cache all gems, including path and git gems\. This needs to be explicitly configured on bundler 1 and bundler 2, but will be the default on bundler 3\.
65
-
.IP"\(bu"4
66
-
\fBcache_all_platforms\fR (\fBBUNDLE_CACHE_ALL_PLATFORMS\fR): Cache gems for all platforms\.
67
-
.IP"\(bu"4
68
-
\fBcache_path\fR (\fBBUNDLE_CACHE_PATH\fR): The directory that bundler will place cached gems in when running \fBbundlepackage\fR, and that bundler will look in when installing gems\. Defaults to \fBvendor/cache\fR\.
69
-
.IP"\(bu"4
70
-
\fBclean\fR (\fBBUNDLE_CLEAN\fR): Whether Bundler should run \fBbundleclean\fR automatically after \fBbundleinstall\fR\.
71
-
.IP"\(bu"4
72
-
\fBconsole\fR (\fBBUNDLE_CONSOLE\fR): The console that \fBbundleconsole\fR starts\. Defaults to \fBirb\fR\.
73
-
.IP"\(bu"4
74
-
\fBdefault_install_uses_path\fR (\fBBUNDLE_DEFAULT_INSTALL_USES_PATH\fR): Whether a \fBbundleinstall\fR without an explicit \fB\-\-path\fR argument defaults to installing gems in \fB\.bundle\fR\.
75
-
.IP"\(bu"4
76
-
\fBdeployment\fR (\fBBUNDLE_DEPLOYMENT\fR): Equivalent to setting \fBfrozen\fR to \fBtrue\fR and \fBpath\fR to \fBvendor/bundle\fR\.
77
-
.IP"\(bu"4
78
-
\fBdisable_checksum_validation\fR (\fBBUNDLE_DISABLE_CHECKSUM_VALIDATION\fR): Allow installing gems even if they do not match the checksum provided by RubyGems\.
79
-
.IP"\(bu"4
80
-
\fBdisable_exec_load\fR (\fBBUNDLE_DISABLE_EXEC_LOAD\fR): Stop Bundler from using \fBload\fR to launch an executable in\-process in \fBbundleexec\fR\.
81
-
.IP"\(bu"4
82
-
\fBdisable_local_branch_check\fR (\fBBUNDLE_DISABLE_LOCAL_BRANCH_CHECK\fR): Allow Bundler to use a local git override without a branch specified in the Gemfile\.
83
-
.IP"\(bu"4
84
-
\fBdisable_local_revision_check\fR (\fBBUNDLE_DISABLE_LOCAL_REVISION_CHECK\fR): Allow Bundler to use a local git override without checking if the revision present in the lockfile is present in the repository\.
85
-
.IP"\(bu"4
86
-
\fBdisable_shared_gems\fR (\fBBUNDLE_DISABLE_SHARED_GEMS\fR): Stop Bundler from accessing gems installed to RubyGems' normal location\.
87
-
.IP"\(bu"4
88
-
\fBdisable_version_check\fR (\fBBUNDLE_DISABLE_VERSION_CHECK\fR): Stop Bundler from checking if a newer Bundler version is available on rubygems\.org\.
89
-
.IP"\(bu"4
90
-
\fBforce_ruby_platform\fR (\fBBUNDLE_FORCE_RUBY_PLATFORM\fR): Ignore the current machine's platform and install only \fBruby\fR platform gems\. As a result, gems with native extensions will be compiled from source\.
91
-
.IP"\(bu"4
92
-
\fBfrozen\fR (\fBBUNDLE_FROZEN\fR): Disallow any automatic changes to \fBGemfile\.lock\fR\. Bundler commands will be blocked unless the lockfile can be installed exactly as written\. Usually this will happen when changing the \fBGemfile\fR manually and forgetting to update the lockfile through \fBbundlelock\fR or \fBbundleinstall\fR\.
93
-
.IP"\(bu"4
94
-
\fBgem\.github_username\fR (\fBBUNDLE_GEM__GITHUB_USERNAME\fR): Sets a GitHub username or organization to be used in \fBREADME\fR file when you create a new gem via \fBbundlegem\fR command\. It can be overridden by passing an explicit \fB\-\-github\-username\fR flag to \fBbundlegem\fR\.
95
-
.IP"\(bu"4
96
-
\fBgem\.push_key\fR (\fBBUNDLE_GEM__PUSH_KEY\fR): Sets the \fB\-\-key\fR parameter for \fBgempush\fR when using the \fBrakerelease\fR command with a private gemstash server\.
97
-
.IP"\(bu"4
98
-
\fBgemfile\fR (\fBBUNDLE_GEMFILE\fR): The name of the file that bundler should use as the \fBGemfile\fR\. This location of this file also sets the root of the project, which is used to resolve relative paths in the \fBGemfile\fR, among other things\. By default, bundler will search up from the current working directory until it finds a \fBGemfile\fR\.
99
-
.IP"\(bu"4
100
-
\fBglobal_gem_cache\fR (\fBBUNDLE_GLOBAL_GEM_CACHE\fR): Whether Bundler should cache all gems globally, rather than locally to the installing Ruby installation\.
101
-
.IP"\(bu"4
102
-
\fBignore_funding_requests\fR (\fBBUNDLE_IGNORE_FUNDING_REQUESTS\fR): When set, no funding requests will be printed\.
103
-
.IP"\(bu"4
104
-
\fBignore_messages\fR (\fBBUNDLE_IGNORE_MESSAGES\fR): When set, no post install messages will be printed\. To silence a single gem, use dot notation like \fBignore_messages\.httpartytrue\fR\.
105
-
.IP"\(bu"4
106
-
\fBinit_gems_rb\fR (\fBBUNDLE_INIT_GEMS_RB\fR): Generate a \fBgems\.rb\fR instead of a \fBGemfile\fR when running \fBbundleinit\fR\.
107
-
.IP"\(bu"4
108
-
\fBjobs\fR (\fBBUNDLE_JOBS\fR): The number of gems Bundler can install in parallel\. Defaults to the number of available processors\.
109
-
.IP"\(bu"4
110
-
\fBlockfile_checksums\fR (\fBBUNDLE_LOCKFILE_CHECKSUMS\fR): Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources\.
111
-
.IP"\(bu"4
112
-
\fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR): Whether \fBbundlepackage\fR should skip installing gems\.
113
-
.IP"\(bu"4
114
-
\fBno_prune\fR (\fBBUNDLE_NO_PRUNE\fR): Whether Bundler should leave outdated gems unpruned when caching\.
115
-
.IP"\(bu"4
116
-
\fBonly\fR (\fBBUNDLE_ONLY\fR): A space\-separated list of groups to install only gems of the specified groups\.
117
-
.IP"\(bu"4
118
-
\fBpath\fR (\fBBUNDLE_PATH\fR): The location on disk where all gems in your bundle will be located regardless of \fB$GEM_HOME\fR or \fB$GEM_PATH\fR values\. Bundle gems not found in this location will be installed by \fBbundleinstall\fR\. Defaults to \fBGem\.dir\fR\.
119
-
.IP"\(bu"4
120
-
\fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR): Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
121
-
.IP"\(bu"4
122
-
\fBpath_relative_to_cwd\fR (\fBBUNDLE_PATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\.
\fBprefer_patch\fR (BUNDLE_PREFER_PATCH): Prefer updating only to next patch version during updates\. Makes \fBbundleupdate\fR calls equivalent to \fBbundlerupdate\-\-patch\fR\.
127
-
.IP"\(bu"4
128
-
\fBprint_only_version_number\fR (\fBBUNDLE_PRINT_ONLY_VERSION_NUMBER\fR): Print only version number from \fBbundler\-\-version\fR\.
129
-
.IP"\(bu"4
130
-
\fBredirect\fR (\fBBUNDLE_REDIRECT\fR): The number of redirects allowed for network requests\. Defaults to \fB5\fR\.
131
-
.IP"\(bu"4
132
-
\fBretry\fR (\fBBUNDLE_RETRY\fR): The number of times to retry failed network requests\. Defaults to \fB3\fR\.
133
-
.IP"\(bu"4
134
-
\fBsetup_makes_kernel_gem_public\fR (\fBBUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC\fR): Have \fBBundler\.setup\fR make the \fBKernel#gem\fR method public, even though RubyGems declares it as private\.
135
-
.IP"\(bu"4
136
-
\fBshebang\fR (\fBBUNDLE_SHEBANG\fR): The program name that should be invoked for generated binstubs\. Defaults to the ruby install name used to generate the binstub\.
137
-
.IP"\(bu"4
138
-
\fBsilence_deprecations\fR (\fBBUNDLE_SILENCE_DEPRECATIONS\fR): Whether Bundler should silence deprecation warnings for behavior that will be changed in the next major version\.
139
-
.IP"\(bu"4
140
-
\fBsilence_root_warning\fR (\fBBUNDLE_SILENCE_ROOT_WARNING\fR): Silence the warning Bundler prints when installing gems as root\.
141
-
.IP"\(bu"4
142
-
\fBssl_ca_cert\fR (\fBBUNDLE_SSL_CA_CERT\fR): Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format\.
143
-
.IP"\(bu"4
144
-
\fBssl_client_cert\fR (\fBBUNDLE_SSL_CLIENT_CERT\fR): Path to a designated file containing a X\.509 client certificate and key in PEM format\.
145
-
.IP"\(bu"4
146
-
\fBssl_verify_mode\fR (\fBBUNDLE_SSL_VERIFY_MODE\fR): The SSL verification mode Bundler uses when making HTTPS requests\. Defaults to verify peer\.
147
-
.IP"\(bu"4
148
-
\fBsystem_bindir\fR (\fBBUNDLE_SYSTEM_BINDIR\fR): The location where RubyGems installs binstubs\. Defaults to \fBGem\.bindir\fR\.
149
-
.IP"\(bu"4
150
-
\fBtimeout\fR (\fBBUNDLE_TIMEOUT\fR): The seconds allowed before timing out for network requests\. Defaults to \fB10\fR\.
151
-
.IP"\(bu"4
152
-
\fBupdate_requires_all_flag\fR (\fBBUNDLE_UPDATE_REQUIRES_ALL_FLAG\fR): Require passing \fB\-\-all\fR to \fBbundleupdate\fR when everything should be updated, and disallow passing no options to \fBbundleupdate\fR\.
153
-
.IP"\(bu"4
154
-
\fBuser_agent\fR (\fBBUNDLE_USER_AGENT\fR): The custom user agent fragment Bundler includes in API requests\.
155
-
.IP"\(bu"4
156
-
\fBversion\fR (\fBBUNDLE_VERSION\fR): The version of Bundler to use when running under Bundler environment\. Defaults to \fBlockfile\fR\. You can also specify \fBsystem\fR or \fBx\.y\.z\fR\.\fBlockfile\fR will use the Bundler version specified in the \fBGemfile\.lock\fR, \fBsystem\fR will use the system version of Bundler, and \fBx\.y\.z\fR will use the specified version of Bundler\.
157
-
.IP"\(bu"4
158
-
\fBwith\fR (\fBBUNDLE_WITH\fR): A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should install\.
159
-
.IP"\(bu"4
160
-
\fBwithout\fR (\fBBUNDLE_WITHOUT\fR): A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should not install\.
Automatically run \fBbundleclean\fR after installing when an explicit \fBpath\fR has not been set and Bundler is not installing into the system gems\.
61
+
.TP
62
+
\fBauto_install\fR (\fBBUNDLE_AUTO_INSTALL\fR)
63
+
Automatically run \fBbundleinstall\fR when gems are missing\.
64
+
.TP
65
+
\fBbin\fR (\fBBUNDLE_BIN\fR)
66
+
Install executables from gems in the bundle to the specified directory\. Defaults to \fBfalse\fR\.
67
+
.TP
68
+
\fBcache_all\fR (\fBBUNDLE_CACHE_ALL\fR)
69
+
Cache all gems, including path and git gems\. This needs to be explicitly configured on bundler 1 and bundler 2, but will be the default on bundler 3\.
The directory that bundler will place cached gems in when running \fBbundlepackage\fR, and that bundler will look in when installing gems\. Defaults to \fBvendor/cache\fR\.
76
+
.TP
77
+
\fBclean\fR (\fBBUNDLE_CLEAN\fR)
78
+
Whether Bundler should run \fBbundleclean\fR automatically after \fBbundleinstall\fR\.
79
+
.TP
80
+
\fBconsole\fR (\fBBUNDLE_CONSOLE\fR)
81
+
The console that \fBbundleconsole\fR starts\. Defaults to \fBirb\fR\.
Ignore the current machine's platform and install only \fBruby\fR platform gems\. As a result, gems with native extensions will be compiled from source\.
109
+
.TP
110
+
\fBfrozen\fR (\fBBUNDLE_FROZEN\fR)
111
+
Disallow any automatic changes to \fBGemfile\.lock\fR\. Bundler commands will be blocked unless the lockfile can be installed exactly as written\. Usually this will happen when changing the \fBGemfile\fR manually and forgetting to update the lockfile through \fBbundlelock\fR or \fBbundleinstall\fR\.
Sets a GitHub username or organization to be used in \fBREADME\fR file when you create a new gem via \fBbundlegem\fR command\. It can be overridden by passing an explicit \fB\-\-github\-username\fR flag to \fBbundlegem\fR\.
115
+
.TP
116
+
\fBgem\.push_key\fR (\fBBUNDLE_GEM__PUSH_KEY\fR)
117
+
Sets the \fB\-\-key\fR parameter for \fBgempush\fR when using the \fBrakerelease\fR command with a private gemstash server\.
118
+
.TP
119
+
\fBgemfile\fR (\fBBUNDLE_GEMFILE\fR)
120
+
The name of the file that bundler should use as the \fBGemfile\fR\. This location of this file also sets the root of the project, which is used to resolve relative paths in the \fBGemfile\fR, among other things\. By default, bundler will search up from the current working directory until it finds a \fBGemfile\fR\.
Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources\.
139
+
.TP
140
+
\fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR)
141
+
Whether \fBbundlepackage\fR should skip installing gems\.
142
+
.TP
143
+
\fBno_prune\fR (\fBBUNDLE_NO_PRUNE\fR)
144
+
Whether Bundler should leave outdated gems unpruned when caching\.
145
+
.TP
146
+
\fBonly\fR (\fBBUNDLE_ONLY\fR)
147
+
A space\-separated list of groups to install only gems of the specified groups\.
148
+
.TP
149
+
\fBpath\fR (\fBBUNDLE_PATH\fR)
150
+
The location on disk where all gems in your bundle will be located regardless of \fB$GEM_HOME\fR or \fB$GEM_PATH\fR values\. Bundle gems not found in this location will be installed by \fBbundleinstall\fR\. Defaults to \fBGem\.dir\fR\.
151
+
.TP
152
+
\fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR)
153
+
Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
Require passing \fB\-\-all\fR to \fBbundleupdate\fR when everything should be updated, and disallow passing no options to \fBbundleupdate\fR\.
202
+
.TP
203
+
\fBuser_agent\fR (\fBBUNDLE_USER_AGENT\fR)
204
+
The custom user agent fragment Bundler includes in API requests\.
205
+
.TP
206
+
\fBversion\fR (\fBBUNDLE_VERSION\fR)
207
+
The version of Bundler to use when running under Bundler environment\. Defaults to \fBlockfile\fR\. You can also specify \fBsystem\fR or \fBx\.y\.z\fR\.\fBlockfile\fR will use the Bundler version specified in the \fBGemfile\.lock\fR, \fBsystem\fR will use the system version of Bundler, and \fBx\.y\.z\fR will use the specified version of Bundler\.
208
+
.TP
209
+
\fBwith\fR (\fBBUNDLE_WITH\fR)
210
+
A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should install\.
211
+
.TP
212
+
\fBwithout\fR (\fBBUNDLE_WITHOUT\fR)
213
+
A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should not install\.
162
214
.SH "REMEMBERING OPTIONS"
163
215
Flags passed to \fBbundleinstall\fR or the Bundler runtime, such as \fB\-\-pathfoo\fR or \fB\-\-withoutproduction\fR, are remembered between commands and saved to your local application's configuration (normally, \fB\./\.bundle/config\fR)\.
0 commit comments