bundler 2.6.5 → 2.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1172 -1024
  3. data/README.md +7 -7
  4. data/bundler.gemspec +2 -2
  5. data/lib/bundler/build_metadata.rb +10 -11
  6. data/lib/bundler/checksum.rb +22 -12
  7. data/lib/bundler/cli/common.rb +1 -1
  8. data/lib/bundler/cli/config.rb +2 -2
  9. data/lib/bundler/cli/doctor/diagnose.rb +167 -0
  10. data/lib/bundler/cli/doctor/ssl.rb +249 -0
  11. data/lib/bundler/cli/doctor.rb +27 -155
  12. data/lib/bundler/cli/gem.rb +62 -30
  13. data/lib/bundler/cli/inject.rb +2 -2
  14. data/lib/bundler/cli/install.rb +5 -5
  15. data/lib/bundler/cli/issue.rb +2 -2
  16. data/lib/bundler/cli/lock.rb +2 -1
  17. data/lib/bundler/cli/outdated.rb +1 -1
  18. data/lib/bundler/cli/update.rb +3 -3
  19. data/lib/bundler/cli.rb +26 -49
  20. data/lib/bundler/compact_index_client/cache.rb +1 -1
  21. data/lib/bundler/compact_index_client/parser.rb +1 -1
  22. data/lib/bundler/compact_index_client/updater.rb +2 -1
  23. data/lib/bundler/compact_index_client.rb +1 -5
  24. data/lib/bundler/current_ruby.rb +27 -3
  25. data/lib/bundler/definition.rb +184 -151
  26. data/lib/bundler/dependency.rb +1 -1
  27. data/lib/bundler/dsl.rb +35 -26
  28. data/lib/bundler/errors.rb +18 -0
  29. data/lib/bundler/feature_flag.rb +15 -12
  30. data/lib/bundler/fetcher/dependency.rb +2 -1
  31. data/lib/bundler/fetcher/downloader.rb +33 -7
  32. data/lib/bundler/fetcher.rb +49 -19
  33. data/lib/bundler/friendly_errors.rb +3 -2
  34. data/lib/bundler/index.rb +7 -2
  35. data/lib/bundler/injector.rb +9 -9
  36. data/lib/bundler/installer.rb +6 -5
  37. data/lib/bundler/lazy_specification.rb +38 -19
  38. data/lib/bundler/lockfile_parser.rb +29 -10
  39. data/lib/bundler/man/bundle-add.1 +1 -1
  40. data/lib/bundler/man/bundle-binstubs.1 +1 -1
  41. data/lib/bundler/man/bundle-cache.1 +1 -1
  42. data/lib/bundler/man/bundle-check.1 +1 -1
  43. data/lib/bundler/man/bundle-clean.1 +1 -1
  44. data/lib/bundler/man/bundle-config.1 +175 -129
  45. data/lib/bundler/man/bundle-config.1.ronn +93 -88
  46. data/lib/bundler/man/bundle-console.1 +1 -1
  47. data/lib/bundler/man/bundle-doctor.1 +43 -4
  48. data/lib/bundler/man/bundle-doctor.1.ronn +48 -4
  49. data/lib/bundler/man/bundle-env.1 +1 -1
  50. data/lib/bundler/man/bundle-exec.1 +3 -3
  51. data/lib/bundler/man/bundle-exec.1.ronn +2 -2
  52. data/lib/bundler/man/bundle-fund.1 +1 -1
  53. data/lib/bundler/man/bundle-gem.1 +67 -44
  54. data/lib/bundler/man/bundle-gem.1.ronn +8 -4
  55. data/lib/bundler/man/bundle-help.1 +1 -1
  56. data/lib/bundler/man/bundle-info.1 +1 -1
  57. data/lib/bundler/man/bundle-init.1 +1 -1
  58. data/lib/bundler/man/bundle-inject.1 +2 -2
  59. data/lib/bundler/man/bundle-inject.1.ronn +1 -1
  60. data/lib/bundler/man/bundle-install.1 +4 -4
  61. data/lib/bundler/man/bundle-install.1.ronn +3 -4
  62. data/lib/bundler/man/bundle-issue.1 +1 -1
  63. data/lib/bundler/man/bundle-licenses.1 +1 -1
  64. data/lib/bundler/man/bundle-list.1 +1 -1
  65. data/lib/bundler/man/bundle-lock.1 +1 -1
  66. data/lib/bundler/man/bundle-open.1 +1 -1
  67. data/lib/bundler/man/bundle-outdated.1 +1 -1
  68. data/lib/bundler/man/bundle-platform.1 +1 -1
  69. data/lib/bundler/man/bundle-plugin.1 +1 -1
  70. data/lib/bundler/man/bundle-pristine.1 +1 -1
  71. data/lib/bundler/man/bundle-remove.1 +1 -1
  72. data/lib/bundler/man/bundle-show.1 +1 -1
  73. data/lib/bundler/man/bundle-update.1 +5 -5
  74. data/lib/bundler/man/bundle-update.1.ronn +4 -4
  75. data/lib/bundler/man/bundle-version.1 +1 -1
  76. data/lib/bundler/man/bundle-viz.1 +1 -1
  77. data/lib/bundler/man/bundle.1 +1 -1
  78. data/lib/bundler/man/gemfile.5 +1 -1
  79. data/lib/bundler/match_platform.rb +31 -12
  80. data/lib/bundler/materialization.rb +2 -2
  81. data/lib/bundler/plugin/api/source.rb +1 -1
  82. data/lib/bundler/plugin/index.rb +1 -1
  83. data/lib/bundler/plugin/installer/path.rb +8 -0
  84. data/lib/bundler/plugin.rb +1 -1
  85. data/lib/bundler/resolver/candidate.rb +12 -9
  86. data/lib/bundler/resolver/package.rb +1 -1
  87. data/lib/bundler/resolver/strategy.rb +40 -0
  88. data/lib/bundler/resolver.rb +18 -27
  89. data/lib/bundler/rubygems_ext.rb +131 -120
  90. data/lib/bundler/rubygems_integration.rb +11 -6
  91. data/lib/bundler/runtime.rb +9 -6
  92. data/lib/bundler/self_manager.rb +32 -42
  93. data/lib/bundler/settings/validator.rb +0 -23
  94. data/lib/bundler/settings.rb +4 -6
  95. data/lib/bundler/shared_helpers.rb +10 -4
  96. data/lib/bundler/source/gemspec.rb +1 -4
  97. data/lib/bundler/source/git/git_proxy.rb +17 -6
  98. data/lib/bundler/source/git.rb +5 -1
  99. data/lib/bundler/source/path.rb +9 -2
  100. data/lib/bundler/source/rubygems/remote.rb +11 -3
  101. data/lib/bundler/source_list.rb +30 -16
  102. data/lib/bundler/source_map.rb +1 -1
  103. data/lib/bundler/spec_set.rb +55 -16
  104. data/lib/bundler/templates/Executable +0 -11
  105. data/lib/bundler/templates/newgem/github/workflows/main.yml.tt +2 -0
  106. data/lib/bundler/templates/newgem/newgem.gemspec.tt +6 -5
  107. data/lib/bundler/ui/shell.rb +2 -2
  108. data/lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb +53 -3
  109. data/lib/bundler/vendor/connection_pool/lib/connection_pool/version.rb +1 -1
  110. data/lib/bundler/vendor/connection_pool/lib/connection_pool.rb +11 -0
  111. data/lib/bundler/vendor/net-http-persistent/README.rdoc +1 -1
  112. data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/timed_stack_multi.rb +2 -1
  113. data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb +81 -42
  114. data/lib/bundler/vendor/pub_grub/lib/pub_grub/basic_package_source.rb +4 -24
  115. data/lib/bundler/vendor/pub_grub/lib/pub_grub/strategy.rb +42 -0
  116. data/lib/bundler/vendor/pub_grub/lib/pub_grub/version_range.rb +20 -8
  117. data/lib/bundler/vendor/pub_grub/lib/pub_grub/version_solver.rb +17 -29
  118. data/lib/bundler/vendor/uri/lib/uri/common.rb +7 -3
  119. data/lib/bundler/vendor/uri/lib/uri/generic.rb +12 -11
  120. data/lib/bundler/vendor/uri/lib/uri/rfc2396_parser.rb +6 -6
  121. data/lib/bundler/vendor/uri/lib/uri/version.rb +1 -1
  122. data/lib/bundler/version.rb +10 -2
  123. data/lib/bundler/worker.rb +1 -1
  124. data/lib/bundler.rb +14 -12
  125. metadata +9 -16
  126. data/lib/bundler/compact_index_client/gem_parser.rb +0 -32
  127. data/lib/bundler/gem_helpers.rb +0 -144
  128. data/lib/bundler/templates/Executable.bundler +0 -109
  129. data/lib/bundler/vendor/connection_pool/.document +0 -1
  130. data/lib/bundler/vendor/fileutils/.document +0 -1
  131. data/lib/bundler/vendor/net-http-persistent/.document +0 -1
  132. data/lib/bundler/vendor/pub_grub/.document +0 -1
  133. data/lib/bundler/vendor/securerandom/.document +0 -1
  134. data/lib/bundler/vendor/thor/.document +0 -1
  135. data/lib/bundler/vendor/tsort/.document +0 -1
  136. data/lib/bundler/vendor/uri/.document +0 -1
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.10.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.10.1
3
- .TH "BUNDLE\-ADD" "1" "January 2025" ""
3
+ .TH "BUNDLE\-ADD" "1" "July 2025" ""
4
4
  .SH "NAME"
5
5
  \fBbundle\-add\fR \- Add gem to the Gemfile and run bundle install
6
6
  .SH "SYNOPSIS"
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.10.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.10.1
3
- .TH "BUNDLE\-BINSTUBS" "1" "January 2025" ""
3
+ .TH "BUNDLE\-BINSTUBS" "1" "July 2025" ""
4
4
  .SH "NAME"
5
5
  \fBbundle\-binstubs\fR \- Install the binstubs of the listed gems
6
6
  .SH "SYNOPSIS"
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.10.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.10.1
3
- .TH "BUNDLE\-CACHE" "1" "January 2025" ""
3
+ .TH "BUNDLE\-CACHE" "1" "July 2025" ""
4
4
  .SH "NAME"
5
5
  \fBbundle\-cache\fR \- Package your needed \fB\.gem\fR files into your application
6
6
  .SH "SYNOPSIS"
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.10.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.10.1
3
- .TH "BUNDLE\-CHECK" "1" "January 2025" ""
3
+ .TH "BUNDLE\-CHECK" "1" "July 2025" ""
4
4
  .SH "NAME"
5
5
  \fBbundle\-check\fR \- Verifies if dependencies are satisfied by installed gems
6
6
  .SH "SYNOPSIS"
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.10.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.10.1
3
- .TH "BUNDLE\-CLEAN" "1" "January 2025" ""
3
+ .TH "BUNDLE\-CLEAN" "1" "July 2025" ""
4
4
  .SH "NAME"
5
5
  \fBbundle\-clean\fR \- Cleans up unused gems in your bundler directory
6
6
  .SH "SYNOPSIS"
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.10.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.10.1
3
- .TH "BUNDLE\-CONFIG" "1" "January 2025" ""
3
+ .TH "BUNDLE\-CONFIG" "1" "July 2025" ""
4
4
  .SH "NAME"
5
5
  \fBbundle\-config\fR \- Set bundler configuration options
6
6
  .SH "SYNOPSIS"
@@ -42,30 +42,193 @@ Executing \fBbundle config unset \-\-global <name>\fR will delete the configurat
42
42
  Executing \fBbundle config unset \-\-local <name>\fR will delete the configuration only from the local application\.
43
43
  .P
44
44
  Executing bundle with the \fBBUNDLE_IGNORE_CONFIG\fR environment variable set will cause it to ignore all configuration\.
45
+ .SH "CONFIGURATION KEYS"
46
+ Configuration keys in bundler have two forms: the canonical form and the environment variable form\.
47
+ .P
48
+ For instance, passing the \fB\-\-without\fR flag to bundle install(1) \fIbundle\-install\.1\.html\fR prevents Bundler from installing certain groups specified in the Gemfile(5)\. Bundler persists this value in \fBapp/\.bundle/config\fR so that calls to \fBBundler\.setup\fR do not try to find gems from the \fBGemfile\fR that you didn't install\. Additionally, subsequent calls to bundle install(1) \fIbundle\-install\.1\.html\fR remember this setting and skip those groups\.
49
+ .P
50
+ The canonical form of this configuration is \fB"without"\fR\. To convert the canonical form to the environment variable form, capitalize it, and prepend \fBBUNDLE_\fR\. The environment variable form of \fB"without"\fR is \fBBUNDLE_WITHOUT\fR\.
51
+ .P
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
+ .SH "LIST OF AVAILABLE KEYS"
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
+ .TP
56
+ \fBallow_offline_install\fR (\fBBUNDLE_ALLOW_OFFLINE_INSTALL\fR)
57
+ Allow Bundler to use cached data when installing without network access\.
58
+ .TP
59
+ \fBauto_install\fR (\fBBUNDLE_AUTO_INSTALL\fR)
60
+ Automatically run \fBbundle install\fR when gems are missing\.
61
+ .TP
62
+ \fBbin\fR (\fBBUNDLE_BIN\fR)
63
+ Install executables from gems in the bundle to the specified directory\. Defaults to \fBfalse\fR\.
64
+ .TP
65
+ \fBcache_all\fR (\fBBUNDLE_CACHE_ALL\fR)
66
+ Cache all gems, including path and git gems\. This needs to be explicitly before bundler 4, but will be the default on bundler 4\.
67
+ .TP
68
+ \fBcache_all_platforms\fR (\fBBUNDLE_CACHE_ALL_PLATFORMS\fR)
69
+ Cache gems for all platforms\.
70
+ .TP
71
+ \fBcache_path\fR (\fBBUNDLE_CACHE_PATH\fR)
72
+ The directory that bundler will place cached gems in when running \fBbundle package\fR, and that bundler will look in when installing gems\. Defaults to \fBvendor/cache\fR\.
73
+ .TP
74
+ \fBclean\fR (\fBBUNDLE_CLEAN\fR)
75
+ Whether Bundler should run \fBbundle clean\fR automatically after \fBbundle install\fR\. Defaults to \fBtrue\fR in Bundler 4, as long as \fBpath\fR is not explicitly configured\.
76
+ .TP
77
+ \fBconsole\fR (\fBBUNDLE_CONSOLE\fR)
78
+ The console that \fBbundle console\fR starts\. Defaults to \fBirb\fR\.
79
+ .TP
80
+ \fBdefault_cli_command\fR (\fBBUNDLE_DEFAULT_CLI_COMMAND\fR)
81
+ The command that running \fBbundle\fR without arguments should run\. Defaults to \fBcli_help\fR since Bundler 4, but can also be \fBinstall\fR which was the previous default\.
82
+ .TP
83
+ \fBdeployment\fR (\fBBUNDLE_DEPLOYMENT\fR)
84
+ Equivalent to setting \fBfrozen\fR to \fBtrue\fR and \fBpath\fR to \fBvendor/bundle\fR\.
85
+ .TP
86
+ \fBdisable_checksum_validation\fR (\fBBUNDLE_DISABLE_CHECKSUM_VALIDATION\fR)
87
+ Allow installing gems even if they do not match the checksum provided by RubyGems\.
88
+ .TP
89
+ \fBdisable_exec_load\fR (\fBBUNDLE_DISABLE_EXEC_LOAD\fR)
90
+ Stop Bundler from using \fBload\fR to launch an executable in\-process in \fBbundle exec\fR\.
91
+ .TP
92
+ \fBdisable_local_branch_check\fR (\fBBUNDLE_DISABLE_LOCAL_BRANCH_CHECK\fR)
93
+ Allow Bundler to use a local git override without a branch specified in the Gemfile\.
94
+ .TP
95
+ \fBdisable_local_revision_check\fR (\fBBUNDLE_DISABLE_LOCAL_REVISION_CHECK\fR)
96
+ Allow Bundler to use a local git override without checking if the revision present in the lockfile is present in the repository\.
97
+ .TP
98
+ \fBdisable_shared_gems\fR (\fBBUNDLE_DISABLE_SHARED_GEMS\fR)
99
+ Stop Bundler from accessing gems installed to RubyGems' normal location\.
100
+ .TP
101
+ \fBdisable_version_check\fR (\fBBUNDLE_DISABLE_VERSION_CHECK\fR)
102
+ Stop Bundler from checking if a newer Bundler version is available on rubygems\.org\.
103
+ .TP
104
+ \fBforce_ruby_platform\fR (\fBBUNDLE_FORCE_RUBY_PLATFORM\fR)
105
+ 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\.
106
+ .TP
107
+ \fBfrozen\fR (\fBBUNDLE_FROZEN\fR)
108
+ 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 \fBbundle lock\fR or \fBbundle install\fR\.
109
+ .TP
110
+ \fBgem\.github_username\fR (\fBBUNDLE_GEM__GITHUB_USERNAME\fR)
111
+ Sets a GitHub username or organization to be used in the \fBREADME\fR and \fB\.gemspec\fR files when you create a new gem via \fBbundle gem\fR command\. It can be overridden by passing an explicit \fB\-\-github\-username\fR flag to \fBbundle gem\fR\.
112
+ .TP
113
+ \fBgem\.push_key\fR (\fBBUNDLE_GEM__PUSH_KEY\fR)
114
+ Sets the \fB\-\-key\fR parameter for \fBgem push\fR when using the \fBrake release\fR command with a private gemstash server\.
115
+ .TP
116
+ \fBgemfile\fR (\fBBUNDLE_GEMFILE\fR)
117
+ 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\.
118
+ .TP
119
+ \fBglobal_gem_cache\fR (\fBBUNDLE_GLOBAL_GEM_CACHE\fR)
120
+ Whether Bundler should cache all gems and compiled extensions globally, rather than locally to the configured installation path\.
121
+ .TP
122
+ \fBignore_funding_requests\fR (\fBBUNDLE_IGNORE_FUNDING_REQUESTS\fR)
123
+ When set, no funding requests will be printed\.
124
+ .TP
125
+ \fBignore_messages\fR (\fBBUNDLE_IGNORE_MESSAGES\fR)
126
+ When set, no post install messages will be printed\. To silence a single gem, use dot notation like \fBignore_messages\.httparty true\fR\.
127
+ .TP
128
+ \fBinit_gems_rb\fR (\fBBUNDLE_INIT_GEMS_RB\fR)
129
+ Generate a \fBgems\.rb\fR instead of a \fBGemfile\fR when running \fBbundle init\fR\.
130
+ .TP
131
+ \fBjobs\fR (\fBBUNDLE_JOBS\fR)
132
+ The number of gems Bundler can install in parallel\. Defaults to the number of available processors\.
133
+ .TP
134
+ \fBlockfile_checksums\fR (\fBBUNDLE_LOCKFILE_CHECKSUMS\fR)
135
+ Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources\.
136
+ .TP
137
+ \fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR)
138
+ Whether \fBbundle package\fR should skip installing gems\.
139
+ .TP
140
+ \fBno_prune\fR (\fBBUNDLE_NO_PRUNE\fR)
141
+ Whether Bundler should leave outdated gems unpruned when caching\.
142
+ .TP
143
+ \fBonly\fR (\fBBUNDLE_ONLY\fR)
144
+ A space\-separated list of groups to install only gems of the specified groups\.
145
+ .TP
146
+ \fBpath\fR (\fBBUNDLE_PATH\fR)
147
+ 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 \fBbundle install\fR\. Defaults to \fB\.bundle\fR relative to repository root in Bundler 4, and to the default system path (\fBGem\.dir\fR) before Bundler 4\.
148
+ .TP
149
+ \fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR)
150
+ Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
151
+ .TP
152
+ \fBplugins\fR (\fBBUNDLE_PLUGINS\fR)
153
+ Enable Bundler's experimental plugin system\.
154
+ .TP
155
+ \fBprefer_patch\fR (BUNDLE_PREFER_PATCH)
156
+ Prefer updating only to next patch version during updates\. Makes \fBbundle update\fR calls equivalent to \fBbundler update \-\-patch\fR\.
157
+ .TP
158
+ \fBredirect\fR (\fBBUNDLE_REDIRECT\fR)
159
+ The number of redirects allowed for network requests\. Defaults to \fB5\fR\.
160
+ .TP
161
+ \fBretry\fR (\fBBUNDLE_RETRY\fR)
162
+ The number of times to retry failed network requests\. Defaults to \fB3\fR\.
163
+ .TP
164
+ \fBshebang\fR (\fBBUNDLE_SHEBANG\fR)
165
+ The program name that should be invoked for generated binstubs\. Defaults to the ruby install name used to generate the binstub\.
166
+ .TP
167
+ \fBsilence_deprecations\fR (\fBBUNDLE_SILENCE_DEPRECATIONS\fR)
168
+ Whether Bundler should silence deprecation warnings for behavior that will be changed in the next major version\.
169
+ .TP
170
+ \fBsilence_root_warning\fR (\fBBUNDLE_SILENCE_ROOT_WARNING\fR)
171
+ Silence the warning Bundler prints when installing gems as root\.
172
+ .TP
173
+ \fBsimulate_version\fR (\fBBUNDLE_SIMULATE_VERSION\fR)
174
+ The virtual version Bundler should use for activating feature flags\. Can be used to simulate all the new functionality that will be enabled in a future major version\.
175
+ .TP
176
+ \fBssl_ca_cert\fR (\fBBUNDLE_SSL_CA_CERT\fR)
177
+ Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format\.
178
+ .TP
179
+ \fBssl_client_cert\fR (\fBBUNDLE_SSL_CLIENT_CERT\fR)
180
+ Path to a designated file containing a X\.509 client certificate and key in PEM format\.
181
+ .TP
182
+ \fBssl_verify_mode\fR (\fBBUNDLE_SSL_VERIFY_MODE\fR)
183
+ The SSL verification mode Bundler uses when making HTTPS requests\. Defaults to verify peer\.
184
+ .TP
185
+ \fBsystem_bindir\fR (\fBBUNDLE_SYSTEM_BINDIR\fR)
186
+ The location where RubyGems installs binstubs\. Defaults to \fBGem\.bindir\fR\.
187
+ .TP
188
+ \fBtimeout\fR (\fBBUNDLE_TIMEOUT\fR)
189
+ The seconds allowed before timing out for network requests\. Defaults to \fB10\fR\.
190
+ .TP
191
+ \fBupdate_requires_all_flag\fR (\fBBUNDLE_UPDATE_REQUIRES_ALL_FLAG\fR)
192
+ Require passing \fB\-\-all\fR to \fBbundle update\fR when everything should be updated, and disallow passing no options to \fBbundle update\fR\.
193
+ .TP
194
+ \fBuser_agent\fR (\fBBUNDLE_USER_AGENT\fR)
195
+ The custom user agent fragment Bundler includes in API requests\.
196
+ .TP
197
+ \fBverbose\fR (\fBBUNDLE_VERBOSE\fR)
198
+ Whether Bundler should print verbose output\. Defaults to \fBfalse\fR, unless the \fB\-\-verbose\fR CLI flag is used\.
199
+ .TP
200
+ \fBversion\fR (\fBBUNDLE_VERSION\fR)
201
+ 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\.
202
+ .TP
203
+ \fBwith\fR (\fBBUNDLE_WITH\fR)
204
+ A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should install\.
205
+ .TP
206
+ \fBwithout\fR (\fBBUNDLE_WITHOUT\fR)
207
+ A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should not install\.
45
208
  .SH "REMEMBERING OPTIONS"
46
209
  Flags passed to \fBbundle install\fR or the Bundler runtime, such as \fB\-\-path foo\fR or \fB\-\-without production\fR, are remembered between commands and saved to your local application's configuration (normally, \fB\./\.bundle/config\fR)\.
47
210
  .P
48
- 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 \fBbundle config\fR (e\.g\., \fBbundle config set \-\-local path foo\fR)\.
211
+ However, this will be changed in bundler 4, so it's better not to rely on this behavior\. If these options must be remembered, it's better to set them using \fBbundle config\fR (e\.g\., \fBbundle config set \-\-local path foo\fR)\.
49
212
  .P
50
- The options that can be configured are:
213
+ The flags that can be configured are:
51
214
  .TP
52
- \fBbin\fR
215
+ \fB\-\-bin\fR
53
216
  Creates a directory (defaults to \fB~/bin\fR) 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 \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
54
217
  .TP
55
- \fBdeployment\fR
218
+ \fB\-\-deployment\fR
56
219
  In deployment mode, Bundler will 'roll\-out' the bundle for \fBproduction\fR use\. Please check carefully if you want to have this option enabled in \fBdevelopment\fR or \fBtest\fR environments\.
57
220
  .TP
58
- \fBonly\fR
59
- A space\-separated list of groups to install only gems of the specified groups\.
221
+ \fB\-\-only\fR
222
+ A space\-separated list of groups to install only gems of the specified groups\. Please check carefully if you want to install also gems without a group, cause they get put inside \fBdefault\fR group\. For example \fBonly test:default\fR will install all gems specified in test group and without one\.
60
223
  .TP
61
- \fBpath\fR
224
+ \fB\-\-path\fR
62
225
  The location to install the specified gems to\. This defaults to Rubygems' setting\. Bundler shares this location with Rubygems, \fBgem install \|\.\|\.\|\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \|\.\|\.\|\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
63
226
  .TP
64
- \fBwithout\fR
65
- A space\-separated list of groups referencing gems to skip during installation\.
227
+ \fB\-\-without\fR
228
+ A space\-separated or \fB:\fR\-separated list of groups referencing gems to skip during installation\.
66
229
  .TP
67
- \fBwith\fR
68
- A space\-separated list of \fBoptional\fR groups referencing gems to include during installation\.
230
+ \fB\-\-with\fR
231
+ A space\-separated or \fB:\fR\-separated list of \fBoptional\fR groups referencing gems to include during installation\.
69
232
  .SH "BUILD OPTIONS"
70
233
  You can use \fBbundle config\fR to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem\.
71
234
  .P
@@ -84,123 +247,6 @@ bundle config set \-\-global build\.mysql \-\-with\-mysql\-config=/usr/local/mys
84
247
  .IP "" 0
85
248
  .P
86
249
  After running this command, every time bundler needs to install the \fBmysql\fR gem, it will pass along the flags you specified\.
87
- .SH "CONFIGURATION KEYS"
88
- Configuration keys in bundler have two forms: the canonical form and the environment variable form\.
89
- .P
90
- For instance, passing the \fB\-\-without\fR flag to bundle install(1) \fIbundle\-install\.1\.html\fR prevents Bundler from installing certain groups specified in the Gemfile(5)\. Bundler persists this value in \fBapp/\.bundle/config\fR so that calls to \fBBundler\.setup\fR do not try to find gems from the \fBGemfile\fR that you didn't install\. Additionally, subsequent calls to bundle install(1) \fIbundle\-install\.1\.html\fR remember this setting and skip those groups\.
91
- .P
92
- The canonical form of this configuration is \fB"without"\fR\. To convert the canonical form to the environment variable form, capitalize it, and prepend \fBBUNDLE_\fR\. The environment variable form of \fB"without"\fR is \fBBUNDLE_WITHOUT\fR\.
93
- .P
94
- 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\.
95
- .SH "LIST OF AVAILABLE KEYS"
96
- 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\.
97
- .IP "\(bu" 4
98
- \fBallow_offline_install\fR (\fBBUNDLE_ALLOW_OFFLINE_INSTALL\fR): Allow Bundler to use cached data when installing without network access\.
99
- .IP "\(bu" 4
100
- \fBauto_clean_without_path\fR (\fBBUNDLE_AUTO_CLEAN_WITHOUT_PATH\fR): Automatically run \fBbundle clean\fR after installing when an explicit \fBpath\fR has not been set and Bundler is not installing into the system gems\.
101
- .IP "\(bu" 4
102
- \fBauto_install\fR (\fBBUNDLE_AUTO_INSTALL\fR): Automatically run \fBbundle install\fR when gems are missing\.
103
- .IP "\(bu" 4
104
- \fBbin\fR (\fBBUNDLE_BIN\fR): Install executables from gems in the bundle to the specified directory\. Defaults to \fBfalse\fR\.
105
- .IP "\(bu" 4
106
- \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\.
107
- .IP "\(bu" 4
108
- \fBcache_all_platforms\fR (\fBBUNDLE_CACHE_ALL_PLATFORMS\fR): Cache gems for all platforms\.
109
- .IP "\(bu" 4
110
- \fBcache_path\fR (\fBBUNDLE_CACHE_PATH\fR): The directory that bundler will place cached gems in when running \fBbundle package\fR, and that bundler will look in when installing gems\. Defaults to \fBvendor/cache\fR\.
111
- .IP "\(bu" 4
112
- \fBclean\fR (\fBBUNDLE_CLEAN\fR): Whether Bundler should run \fBbundle clean\fR automatically after \fBbundle install\fR\.
113
- .IP "\(bu" 4
114
- \fBconsole\fR (\fBBUNDLE_CONSOLE\fR): The console that \fBbundle console\fR starts\. Defaults to \fBirb\fR\.
115
- .IP "\(bu" 4
116
- \fBdefault_install_uses_path\fR (\fBBUNDLE_DEFAULT_INSTALL_USES_PATH\fR): Whether a \fBbundle install\fR without an explicit \fB\-\-path\fR argument defaults to installing gems in \fB\.bundle\fR\.
117
- .IP "\(bu" 4
118
- \fBdeployment\fR (\fBBUNDLE_DEPLOYMENT\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\.
119
- .IP "\(bu" 4
120
- \fBdisable_checksum_validation\fR (\fBBUNDLE_DISABLE_CHECKSUM_VALIDATION\fR): Allow installing gems even if they do not match the checksum provided by RubyGems\.
121
- .IP "\(bu" 4
122
- \fBdisable_exec_load\fR (\fBBUNDLE_DISABLE_EXEC_LOAD\fR): Stop Bundler from using \fBload\fR to launch an executable in\-process in \fBbundle exec\fR\.
123
- .IP "\(bu" 4
124
- \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\.
125
- .IP "\(bu" 4
126
- \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\.
127
- .IP "\(bu" 4
128
- \fBdisable_shared_gems\fR (\fBBUNDLE_DISABLE_SHARED_GEMS\fR): Stop Bundler from accessing gems installed to RubyGems' normal location\.
129
- .IP "\(bu" 4
130
- \fBdisable_version_check\fR (\fBBUNDLE_DISABLE_VERSION_CHECK\fR): Stop Bundler from checking if a newer Bundler version is available on rubygems\.org\.
131
- .IP "\(bu" 4
132
- \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\.
133
- .IP "\(bu" 4
134
- \fBfrozen\fR (\fBBUNDLE_FROZEN\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\. Defaults to \fBtrue\fR when \fB\-\-deployment\fR is used\.
135
- .IP "\(bu" 4
136
- \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 \fBbundle gem\fR command\. It can be overridden by passing an explicit \fB\-\-github\-username\fR flag to \fBbundle gem\fR\.
137
- .IP "\(bu" 4
138
- \fBgem\.push_key\fR (\fBBUNDLE_GEM__PUSH_KEY\fR): Sets the \fB\-\-key\fR parameter for \fBgem push\fR when using the \fBrake release\fR command with a private gemstash server\.
139
- .IP "\(bu" 4
140
- \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\.
141
- .IP "\(bu" 4
142
- \fBglobal_gem_cache\fR (\fBBUNDLE_GLOBAL_GEM_CACHE\fR): Whether Bundler should cache all gems globally, rather than locally to the installing Ruby installation\.
143
- .IP "\(bu" 4
144
- \fBignore_funding_requests\fR (\fBBUNDLE_IGNORE_FUNDING_REQUESTS\fR): When set, no funding requests will be printed\.
145
- .IP "\(bu" 4
146
- \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\.httparty true\fR\.
147
- .IP "\(bu" 4
148
- \fBinit_gems_rb\fR (\fBBUNDLE_INIT_GEMS_RB\fR): Generate a \fBgems\.rb\fR instead of a \fBGemfile\fR when running \fBbundle init\fR\.
149
- .IP "\(bu" 4
150
- \fBjobs\fR (\fBBUNDLE_JOBS\fR): The number of gems Bundler can install in parallel\. Defaults to the number of available processors\.
151
- .IP "\(bu" 4
152
- \fBlockfile_checksums\fR (\fBBUNDLE_LOCKFILE_CHECKSUMS\fR): Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources\.
153
- .IP "\(bu" 4
154
- \fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR): Whether \fBbundle package\fR should skip installing gems\.
155
- .IP "\(bu" 4
156
- \fBno_prune\fR (\fBBUNDLE_NO_PRUNE\fR): Whether Bundler should leave outdated gems unpruned when caching\.
157
- .IP "\(bu" 4
158
- \fBonly\fR (\fBBUNDLE_ONLY\fR): A space\-separated list of groups to install only gems of the specified groups\.
159
- .IP "\(bu" 4
160
- \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 \fBbundle install\fR\. Defaults to \fBGem\.dir\fR\. When \-\-deployment is used, defaults to vendor/bundle\.
161
- .IP "\(bu" 4
162
- \fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR): Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
163
- .IP "\(bu" 4
164
- \fBpath_relative_to_cwd\fR (\fBBUNDLE_PATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\.
165
- .IP "\(bu" 4
166
- \fBplugins\fR (\fBBUNDLE_PLUGINS\fR): Enable Bundler's experimental plugin system\.
167
- .IP "\(bu" 4
168
- \fBprefer_patch\fR (BUNDLE_PREFER_PATCH): Prefer updating only to next patch version during updates\. Makes \fBbundle update\fR calls equivalent to \fBbundler update \-\-patch\fR\.
169
- .IP "\(bu" 4
170
- \fBprint_only_version_number\fR (\fBBUNDLE_PRINT_ONLY_VERSION_NUMBER\fR): Print only version number from \fBbundler \-\-version\fR\.
171
- .IP "\(bu" 4
172
- \fBredirect\fR (\fBBUNDLE_REDIRECT\fR): The number of redirects allowed for network requests\. Defaults to \fB5\fR\.
173
- .IP "\(bu" 4
174
- \fBretry\fR (\fBBUNDLE_RETRY\fR): The number of times to retry failed network requests\. Defaults to \fB3\fR\.
175
- .IP "\(bu" 4
176
- \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\.
177
- .IP "\(bu" 4
178
- \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\.
179
- .IP "\(bu" 4
180
- \fBsilence_deprecations\fR (\fBBUNDLE_SILENCE_DEPRECATIONS\fR): Whether Bundler should silence deprecation warnings for behavior that will be changed in the next major version\.
181
- .IP "\(bu" 4
182
- \fBsilence_root_warning\fR (\fBBUNDLE_SILENCE_ROOT_WARNING\fR): Silence the warning Bundler prints when installing gems as root\.
183
- .IP "\(bu" 4
184
- \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\.
185
- .IP "\(bu" 4
186
- \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\.
187
- .IP "\(bu" 4
188
- \fBssl_verify_mode\fR (\fBBUNDLE_SSL_VERIFY_MODE\fR): The SSL verification mode Bundler uses when making HTTPS requests\. Defaults to verify peer\.
189
- .IP "\(bu" 4
190
- \fBsystem_bindir\fR (\fBBUNDLE_SYSTEM_BINDIR\fR): The location where RubyGems installs binstubs\. Defaults to \fBGem\.bindir\fR\.
191
- .IP "\(bu" 4
192
- \fBtimeout\fR (\fBBUNDLE_TIMEOUT\fR): The seconds allowed before timing out for network requests\. Defaults to \fB10\fR\.
193
- .IP "\(bu" 4
194
- \fBupdate_requires_all_flag\fR (\fBBUNDLE_UPDATE_REQUIRES_ALL_FLAG\fR): Require passing \fB\-\-all\fR to \fBbundle update\fR when everything should be updated, and disallow passing no options to \fBbundle update\fR\.
195
- .IP "\(bu" 4
196
- \fBuser_agent\fR (\fBBUNDLE_USER_AGENT\fR): The custom user agent fragment Bundler includes in API requests\.
197
- .IP "\(bu" 4
198
- \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\.
199
- .IP "\(bu" 4
200
- \fBwith\fR (\fBBUNDLE_WITH\fR): A \fB:\fR\-separated list of groups whose gems bundler should install\.
201
- .IP "\(bu" 4
202
- \fBwithout\fR (\fBBUNDLE_WITHOUT\fR): A \fB:\fR\-separated list of groups whose gems bundler should not install\.
203
- .IP "" 0
204
250
  .SH "LOCAL GIT REPOS"
205
251
  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:
206
252
  .IP "" 4
@@ -52,66 +52,6 @@ only from the local application.
52
52
  Executing bundle with the `BUNDLE_IGNORE_CONFIG` environment variable set will
53
53
  cause it to ignore all configuration.
54
54
 
55
- ## REMEMBERING OPTIONS
56
-
57
- Flags passed to `bundle install` or the Bundler runtime, such as `--path foo` or
58
- `--without production`, are remembered between commands and saved to your local
59
- application's configuration (normally, `./.bundle/config`).
60
-
61
- However, this will be changed in bundler 3, so it's better not to rely on this
62
- behavior. If these options must be remembered, it's better to set them using
63
- `bundle config` (e.g., `bundle config set --local path foo`).
64
-
65
- The options that can be configured are:
66
-
67
- * `bin`:
68
- Creates a directory (defaults to `~/bin`) and place any executables from the
69
- gem there. These executables run in Bundler's context. If used, you might add
70
- this directory to your environment's `PATH` variable. For instance, if the
71
- `rails` gem comes with a `rails` executable, this flag will create a
72
- `bin/rails` executable that ensures that all referred dependencies will be
73
- resolved using the bundled gems.
74
-
75
- * `deployment`:
76
- In deployment mode, Bundler will 'roll-out' the bundle for
77
- `production` use. Please check carefully if you want to have this option
78
- enabled in `development` or `test` environments.
79
-
80
- * `only`:
81
- A space-separated list of groups to install only gems of the specified groups.
82
-
83
- * `path`:
84
- The location to install the specified gems to. This defaults to Rubygems'
85
- setting. Bundler shares this location with Rubygems, `gem install ...` will
86
- have gem installed there, too. Therefore, gems installed without a
87
- `--path ...` setting will show up by calling `gem list`. Accordingly, gems
88
- installed to other locations will not get listed.
89
-
90
- * `without`:
91
- A space-separated list of groups referencing gems to skip during installation.
92
-
93
- * `with`:
94
- A space-separated list of **optional** groups referencing gems to include during installation.
95
-
96
- ## BUILD OPTIONS
97
-
98
- You can use `bundle config` to give Bundler the flags to pass to the gem
99
- installer every time bundler tries to install a particular gem.
100
-
101
- A very common example, the `mysql` gem, requires Snow Leopard users to
102
- pass configuration flags to `gem install` to specify where to find the
103
- `mysql_config` executable.
104
-
105
- gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
106
-
107
- 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
-
110
- bundle config set --global build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
111
-
112
- After running this command, every time bundler needs to install the
113
- `mysql` gem, it will pass along the flags you specified.
114
-
115
55
  ## CONFIGURATION KEYS
116
56
 
117
57
  Configuration keys in bundler have two forms: the canonical form and the
@@ -139,9 +79,6 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
139
79
 
140
80
  * `allow_offline_install` (`BUNDLE_ALLOW_OFFLINE_INSTALL`):
141
81
  Allow Bundler to use cached data when installing without network access.
142
- * `auto_clean_without_path` (`BUNDLE_AUTO_CLEAN_WITHOUT_PATH`):
143
- Automatically run `bundle clean` after installing when an explicit `path`
144
- has not been set and Bundler is not installing into the system gems.
145
82
  * `auto_install` (`BUNDLE_AUTO_INSTALL`):
146
83
  Automatically run `bundle install` when gems are missing.
147
84
  * `bin` (`BUNDLE_BIN`):
@@ -149,7 +86,7 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
149
86
  Defaults to `false`.
150
87
  * `cache_all` (`BUNDLE_CACHE_ALL`):
151
88
  Cache all gems, including path and git gems. This needs to be explicitly
152
- configured on bundler 1 and bundler 2, but will be the default on bundler 3.
89
+ before bundler 4, but will be the default on bundler 4.
153
90
  * `cache_all_platforms` (`BUNDLE_CACHE_ALL_PLATFORMS`):
154
91
  Cache gems for all platforms.
155
92
  * `cache_path` (`BUNDLE_CACHE_PATH`):
@@ -158,15 +95,16 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
158
95
  Defaults to `vendor/cache`.
159
96
  * `clean` (`BUNDLE_CLEAN`):
160
97
  Whether Bundler should run `bundle clean` automatically after
161
- `bundle install`.
98
+ `bundle install`. Defaults to `true` in Bundler 4, as long as `path` is not
99
+ explicitly configured.
162
100
  * `console` (`BUNDLE_CONSOLE`):
163
101
  The console that `bundle console` starts. Defaults to `irb`.
164
- * `default_install_uses_path` (`BUNDLE_DEFAULT_INSTALL_USES_PATH`):
165
- Whether a `bundle install` without an explicit `--path` argument defaults
166
- to installing gems in `.bundle`.
102
+ * `default_cli_command` (`BUNDLE_DEFAULT_CLI_COMMAND`):
103
+ The command that running `bundle` without arguments should run. Defaults to
104
+ `cli_help` since Bundler 4, but can also be `install` which was the previous
105
+ default.
167
106
  * `deployment` (`BUNDLE_DEPLOYMENT`):
168
- Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the
169
- lockfile has not been updated, running Bundler commands will be blocked.
107
+ Equivalent to setting `frozen` to `true` and `path` to `vendor/bundle`.
170
108
  * `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`):
171
109
  Allow installing gems even if they do not match the checksum provided by
172
110
  RubyGems.
@@ -188,12 +126,13 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
188
126
  Ignore the current machine's platform and install only `ruby` platform gems.
189
127
  As a result, gems with native extensions will be compiled from source.
190
128
  * `frozen` (`BUNDLE_FROZEN`):
191
- Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the
192
- lockfile has not been updated, running Bundler commands will be blocked.
193
- Defaults to `true` when `--deployment` is used.
129
+ Disallow any automatic changes to `Gemfile.lock`. Bundler commands will
130
+ be blocked unless the lockfile can be installed exactly as written.
131
+ Usually this will happen when changing the `Gemfile` manually and forgetting
132
+ to update the lockfile through `bundle lock` or `bundle install`.
194
133
  * `gem.github_username` (`BUNDLE_GEM__GITHUB_USERNAME`):
195
- Sets a GitHub username or organization to be used in `README` file when you
196
- create a new gem via `bundle gem` command. It can be overridden by passing an
134
+ Sets a GitHub username or organization to be used in the `README` and `.gemspec` files
135
+ when you create a new gem via `bundle gem` command. It can be overridden by passing an
197
136
  explicit `--github-username` flag to `bundle gem`.
198
137
  * `gem.push_key` (`BUNDLE_GEM__PUSH_KEY`):
199
138
  Sets the `--key` parameter for `gem push` when using the `rake release`
@@ -205,8 +144,8 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
205
144
  will search up from the current working directory until it finds a
206
145
  `Gemfile`.
207
146
  * `global_gem_cache` (`BUNDLE_GLOBAL_GEM_CACHE`):
208
- Whether Bundler should cache all gems globally, rather than locally to the
209
- installing Ruby installation.
147
+ Whether Bundler should cache all gems and compiled extensions globally,
148
+ rather than locally to the configured installation path.
210
149
  * `ignore_funding_requests` (`BUNDLE_IGNORE_FUNDING_REQUESTS`):
211
150
  When set, no funding requests will be printed.
212
151
  * `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`):
@@ -228,25 +167,19 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
228
167
  * `path` (`BUNDLE_PATH`):
229
168
  The location on disk where all gems in your bundle will be located regardless
230
169
  of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location
231
- will be installed by `bundle install`. Defaults to `Gem.dir`. When --deployment
232
- is used, defaults to vendor/bundle.
170
+ will be installed by `bundle install`. Defaults to `.bundle` relative to
171
+ repository root in Bundler 4, and to the default system path (`Gem.dir`)
172
+ before Bundler 4.
233
173
  * `path.system` (`BUNDLE_PATH__SYSTEM`):
234
174
  Whether Bundler will install gems into the default system path (`Gem.dir`).
235
- * `path_relative_to_cwd` (`BUNDLE_PATH_RELATIVE_TO_CWD`)
236
- Makes `--path` relative to the CWD instead of the `Gemfile`.
237
175
  * `plugins` (`BUNDLE_PLUGINS`):
238
176
  Enable Bundler's experimental plugin system.
239
177
  * `prefer_patch` (BUNDLE_PREFER_PATCH):
240
178
  Prefer updating only to next patch version during updates. Makes `bundle update` calls equivalent to `bundler update --patch`.
241
- * `print_only_version_number` (`BUNDLE_PRINT_ONLY_VERSION_NUMBER`):
242
- Print only version number from `bundler --version`.
243
179
  * `redirect` (`BUNDLE_REDIRECT`):
244
180
  The number of redirects allowed for network requests. Defaults to `5`.
245
181
  * `retry` (`BUNDLE_RETRY`):
246
182
  The number of times to retry failed network requests. Defaults to `3`.
247
- * `setup_makes_kernel_gem_public` (`BUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC`):
248
- Have `Bundler.setup` make the `Kernel#gem` method public, even though
249
- RubyGems declares it as private.
250
183
  * `shebang` (`BUNDLE_SHEBANG`):
251
184
  The program name that should be invoked for generated binstubs. Defaults to
252
185
  the ruby install name used to generate the binstub.
@@ -255,6 +188,10 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
255
188
  be changed in the next major version.
256
189
  * `silence_root_warning` (`BUNDLE_SILENCE_ROOT_WARNING`):
257
190
  Silence the warning Bundler prints when installing gems as root.
191
+ * `simulate_version` (`BUNDLE_SIMULATE_VERSION`):
192
+ The virtual version Bundler should use for activating feature flags. Can be
193
+ used to simulate all the new functionality that will be enabled in a future
194
+ major version.
258
195
  * `ssl_ca_cert` (`BUNDLE_SSL_CA_CERT`):
259
196
  Path to a designated CA certificate file or folder containing multiple
260
197
  certificates for trusted CAs in PEM format.
@@ -273,6 +210,9 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
273
210
  and disallow passing no options to `bundle update`.
274
211
  * `user_agent` (`BUNDLE_USER_AGENT`):
275
212
  The custom user agent fragment Bundler includes in API requests.
213
+ * `verbose` (`BUNDLE_VERBOSE`):
214
+ Whether Bundler should print verbose output. Defaults to `false`, unless the
215
+ `--verbose` CLI flag is used.
276
216
  * `version` (`BUNDLE_VERSION`):
277
217
  The version of Bundler to use when running under Bundler environment.
278
218
  Defaults to `lockfile`. You can also specify `system` or `x.y.z`.
@@ -280,9 +220,74 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
280
220
  `system` will use the system version of Bundler, and `x.y.z` will use
281
221
  the specified version of Bundler.
282
222
  * `with` (`BUNDLE_WITH`):
283
- A `:`-separated list of groups whose gems bundler should install.
223
+ A space-separated or `:`-separated list of groups whose gems bundler should install.
284
224
  * `without` (`BUNDLE_WITHOUT`):
285
- A `:`-separated list of groups whose gems bundler should not install.
225
+ A space-separated or `:`-separated list of groups whose gems bundler should not install.
226
+
227
+ ## REMEMBERING OPTIONS
228
+
229
+ Flags passed to `bundle install` or the Bundler runtime, such as `--path foo` or
230
+ `--without production`, are remembered between commands and saved to your local
231
+ application's configuration (normally, `./.bundle/config`).
232
+
233
+ However, this will be changed in bundler 4, so it's better not to rely on this
234
+ behavior. If these options must be remembered, it's better to set them using
235
+ `bundle config` (e.g., `bundle config set --local path foo`).
236
+
237
+ The flags that can be configured are:
238
+
239
+ * `--bin`:
240
+ Creates a directory (defaults to `~/bin`) and place any executables from the
241
+ gem there. These executables run in Bundler's context. If used, you might add
242
+ this directory to your environment's `PATH` variable. For instance, if the
243
+ `rails` gem comes with a `rails` executable, this flag will create a
244
+ `bin/rails` executable that ensures that all referred dependencies will be
245
+ resolved using the bundled gems.
246
+
247
+ * `--deployment`:
248
+ In deployment mode, Bundler will 'roll-out' the bundle for
249
+ `production` use. Please check carefully if you want to have this option
250
+ enabled in `development` or `test` environments.
251
+
252
+ * `--only`:
253
+ A space-separated list of groups to install only gems of the specified groups.
254
+ Please check carefully if you want to install also gems without a group, cause
255
+ they get put inside `default` group. For example `only test:default` will install
256
+ all gems specified in test group and without one.
257
+
258
+ * `--path`:
259
+ The location to install the specified gems to. This defaults to Rubygems'
260
+ setting. Bundler shares this location with Rubygems, `gem install ...` will
261
+ have gem installed there, too. Therefore, gems installed without a
262
+ `--path ...` setting will show up by calling `gem list`. Accordingly, gems
263
+ installed to other locations will not get listed.
264
+
265
+ * `--without`:
266
+ A space-separated or `:`-separated list of groups referencing gems to skip during
267
+ installation.
268
+
269
+ * `--with`:
270
+ A space-separated or `:`-separated list of **optional** groups referencing gems to
271
+ include during installation.
272
+
273
+ ## BUILD OPTIONS
274
+
275
+ You can use `bundle config` to give Bundler the flags to pass to the gem
276
+ installer every time bundler tries to install a particular gem.
277
+
278
+ A very common example, the `mysql` gem, requires Snow Leopard users to
279
+ pass configuration flags to `gem install` to specify where to find the
280
+ `mysql_config` executable.
281
+
282
+ gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
283
+
284
+ Since the specific location of that executable can change from machine
285
+ to machine, you can specify these flags on a per-machine basis.
286
+
287
+ bundle config set --global build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
288
+
289
+ After running this command, every time bundler needs to install the
290
+ `mysql` gem, it will pass along the flags you specified.
286
291
 
287
292
  ## LOCAL GIT REPOS
288
293