rubygems-update 3.6.9 → 3.7.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +853 -790
- data/CONTRIBUTING.md +9 -0
- data/Manifest.txt +4 -21
- data/README.md +1 -1
- data/SECURITY.md +7 -0
- data/bundler/CHANGELOG.md +1093 -1033
- data/bundler/README.md +7 -7
- data/bundler/bundler.gemspec +2 -2
- data/bundler/lib/bundler/build_metadata.rb +10 -11
- data/bundler/lib/bundler/cli/common.rb +1 -1
- data/bundler/lib/bundler/cli/config.rb +2 -2
- data/bundler/lib/bundler/cli/gem.rb +62 -30
- data/bundler/lib/bundler/cli/install.rb +4 -4
- data/bundler/lib/bundler/cli/outdated.rb +1 -1
- data/bundler/lib/bundler/cli/update.rb +2 -2
- data/bundler/lib/bundler/cli.rb +10 -14
- data/bundler/lib/bundler/compact_index_client.rb +1 -5
- data/bundler/lib/bundler/current_ruby.rb +27 -3
- data/bundler/lib/bundler/definition.rb +21 -22
- data/bundler/lib/bundler/dependency.rb +1 -1
- data/bundler/lib/bundler/dsl.rb +33 -23
- data/bundler/lib/bundler/feature_flag.rb +15 -12
- data/bundler/lib/bundler/fetcher/dependency.rb +2 -1
- data/bundler/lib/bundler/fetcher/downloader.rb +33 -7
- data/bundler/lib/bundler/fetcher.rb +49 -19
- data/bundler/lib/bundler/friendly_errors.rb +2 -1
- data/bundler/lib/bundler/index.rb +7 -2
- data/bundler/lib/bundler/installer.rb +5 -4
- data/bundler/lib/bundler/lazy_specification.rb +9 -7
- data/bundler/lib/bundler/lockfile_parser.rb +21 -5
- data/bundler/lib/bundler/man/bundle-add.1 +1 -1
- data/bundler/lib/bundler/man/bundle-binstubs.1 +1 -1
- data/bundler/lib/bundler/man/bundle-cache.1 +1 -1
- data/bundler/lib/bundler/man/bundle-check.1 +1 -1
- data/bundler/lib/bundler/man/bundle-clean.1 +1 -1
- data/bundler/lib/bundler/man/bundle-config.1 +172 -126
- data/bundler/lib/bundler/man/bundle-config.1.ronn +91 -91
- data/bundler/lib/bundler/man/bundle-console.1 +1 -1
- data/bundler/lib/bundler/man/bundle-doctor.1 +43 -4
- data/bundler/lib/bundler/man/bundle-doctor.1.ronn +48 -4
- data/bundler/lib/bundler/man/bundle-env.1 +1 -1
- data/bundler/lib/bundler/man/bundle-exec.1 +1 -1
- data/bundler/lib/bundler/man/bundle-fund.1 +1 -1
- data/bundler/lib/bundler/man/bundle-gem.1 +67 -44
- data/bundler/lib/bundler/man/bundle-gem.1.ronn +8 -4
- data/bundler/lib/bundler/man/bundle-help.1 +1 -1
- data/bundler/lib/bundler/man/bundle-info.1 +1 -1
- data/bundler/lib/bundler/man/bundle-init.1 +1 -1
- data/bundler/lib/bundler/man/bundle-inject.1 +2 -2
- data/bundler/lib/bundler/man/bundle-inject.1.ronn +1 -1
- data/bundler/lib/bundler/man/bundle-install.1 +1 -1
- data/bundler/lib/bundler/man/bundle-issue.1 +1 -1
- data/bundler/lib/bundler/man/bundle-licenses.1 +1 -1
- data/bundler/lib/bundler/man/bundle-list.1 +1 -1
- data/bundler/lib/bundler/man/bundle-lock.1 +1 -1
- data/bundler/lib/bundler/man/bundle-open.1 +1 -1
- data/bundler/lib/bundler/man/bundle-outdated.1 +1 -1
- data/bundler/lib/bundler/man/bundle-platform.1 +1 -1
- data/bundler/lib/bundler/man/bundle-plugin.1 +1 -1
- data/bundler/lib/bundler/man/bundle-pristine.1 +1 -1
- data/bundler/lib/bundler/man/bundle-remove.1 +1 -1
- data/bundler/lib/bundler/man/bundle-show.1 +1 -1
- data/bundler/lib/bundler/man/bundle-update.1 +1 -1
- data/bundler/lib/bundler/man/bundle-version.1 +1 -1
- data/bundler/lib/bundler/man/bundle-viz.1 +1 -1
- data/bundler/lib/bundler/man/bundle.1 +1 -1
- data/bundler/lib/bundler/man/gemfile.5 +1 -1
- data/bundler/lib/bundler/match_platform.rb +31 -12
- data/bundler/lib/bundler/materialization.rb +2 -2
- data/bundler/lib/bundler/resolver/package.rb +1 -1
- data/bundler/lib/bundler/resolver.rb +1 -3
- data/bundler/lib/bundler/rubygems_ext.rb +116 -120
- data/bundler/lib/bundler/rubygems_integration.rb +11 -6
- data/bundler/lib/bundler/runtime.rb +1 -1
- data/bundler/lib/bundler/self_manager.rb +32 -42
- data/bundler/lib/bundler/settings/validator.rb +0 -23
- data/bundler/lib/bundler/settings.rb +4 -6
- data/bundler/lib/bundler/shared_helpers.rb +6 -4
- data/bundler/lib/bundler/source/git/git_proxy.rb +3 -3
- data/bundler/lib/bundler/source/path.rb +7 -0
- data/bundler/lib/bundler/source_list.rb +1 -5
- data/bundler/lib/bundler/source_map.rb +1 -1
- data/bundler/lib/bundler/spec_set.rb +7 -3
- data/bundler/lib/bundler/templates/Executable +0 -11
- data/bundler/lib/bundler/templates/newgem/github/workflows/main.yml.tt +2 -0
- data/bundler/lib/bundler/templates/newgem/newgem.gemspec.tt +6 -5
- data/bundler/lib/bundler/ui/shell.rb +2 -2
- data/bundler/lib/bundler/vendor/net-http-persistent/README.rdoc +1 -1
- data/bundler/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/timed_stack_multi.rb +2 -1
- data/bundler/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb +81 -42
- data/bundler/lib/bundler/version.rb +10 -2
- data/bundler/lib/bundler/worker.rb +1 -1
- data/bundler/lib/bundler.rb +14 -12
- data/doc/bundler/UPGRADING.md +137 -127
- data/doc/rubygems/CONTRIBUTING.md +1 -1
- data/lib/rubygems/basic_specification.rb +7 -0
- data/lib/rubygems/commands/pristine_command.rb +9 -12
- data/lib/rubygems/commands/setup_command.rb +2 -2
- data/lib/rubygems/core_ext/kernel_require.rb +5 -2
- data/lib/rubygems/ext/cargo_builder.rb +4 -0
- data/lib/rubygems/gemcutter_utilities/webauthn_listener.rb +10 -3
- data/lib/rubygems/gemcutter_utilities.rb +1 -1
- data/lib/rubygems/installer.rb +45 -50
- data/lib/rubygems/platform.rb +142 -39
- data/lib/rubygems/remote_fetcher.rb +3 -3
- data/lib/rubygems/request_set.rb +3 -6
- data/lib/rubygems/resolver/best_set.rb +1 -1
- data/lib/rubygems/resolver/source_set.rb +1 -1
- data/lib/rubygems/resolver.rb +1 -1
- data/lib/rubygems/s3_uri_signer.rb +5 -3
- data/lib/rubygems/source.rb +28 -22
- data/lib/rubygems/specification.rb +2 -2
- data/lib/rubygems/uri_formatter.rb +2 -1
- data/lib/rubygems/util/licenses.rb +21 -0
- data/lib/rubygems/vendor/net-http/lib/net/http.rb +14 -19
- data/lib/rubygems/vendor/resolv/lib/resolv.rb +50 -22
- data/lib/rubygems.rb +65 -7
- data/rubygems-update.gemspec +2 -2
- data/setup.rb +1 -1
- metadata +7 -24
- data/bundler/lib/bundler/gem_helpers.rb +0 -144
- data/bundler/lib/bundler/templates/Executable.bundler +0 -109
- data/bundler/lib/bundler/vendor/fileutils/.document +0 -1
- data/bundler/lib/bundler/vendor/net-http-persistent/.document +0 -1
- data/bundler/lib/bundler/vendor/pub_grub/.document +0 -1
- data/bundler/lib/bundler/vendor/securerandom/.document +0 -1
- data/bundler/lib/bundler/vendor/thor/.document +0 -1
- data/bundler/lib/bundler/vendor/tsort/.document +0 -1
- data/bundler/lib/bundler/vendor/uri/.document +0 -1
- data/lib/rubygems/ssl_certs/rubygems.org/GlobalSignRootCA.pem +0 -21
- data/lib/rubygems/vendor/molinillo/.document +0 -1
- data/lib/rubygems/vendor/net-http/.document +0 -1
- data/lib/rubygems/vendor/net-protocol/.document +0 -1
- data/lib/rubygems/vendor/optparse/.document +0 -1
- data/lib/rubygems/vendor/resolv/.document +0 -1
- data/lib/rubygems/vendor/securerandom/.document +0 -1
- data/lib/rubygems/vendor/timeout/.document +0 -1
- data/lib/rubygems/vendor/tsort/.document +0 -1
- data/lib/rubygems/vendor/uri/.document +0 -1
- /data/lib/rubygems/ssl_certs/rubygems.org/{GlobalSignRootCA_R3.pem → GlobalSign.pem} +0 -0
- /data/{bundler/lib/bundler/vendor/connection_pool → lib/rubygems/vendor}/.document +0 -0
@@ -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" "
|
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" "
|
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" "
|
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" "
|
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,29 +42,192 @@ 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
|
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
|
213
|
+
The flags that can be configured are:
|
51
214
|
.TP
|
52
|
-
\
|
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
|
-
\
|
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
|
-
\
|
221
|
+
\fB\-\-only\fR
|
59
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
|
-
\
|
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
|
-
\
|
227
|
+
\fB\-\-without\fR
|
65
228
|
A space\-separated or \fB:\fR\-separated list of groups referencing gems to skip during installation\.
|
66
229
|
.TP
|
67
|
-
\
|
230
|
+
\fB\-\-with\fR
|
68
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\.
|
@@ -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 space\-separated or \fB:\fR\-separated list of groups whose gems bundler should install\.
|
201
|
-
.IP "\(bu" 4
|
202
|
-
\fBwithout\fR (\fBBUNDLE_WITHOUT\fR): A space\-separated or \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,71 +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
|
-
Please check carefully if you want to install also gems without a group, cause
|
83
|
-
they get put inside `default` group. For example `only test:default` will install
|
84
|
-
all gems specified in test group and without one.
|
85
|
-
|
86
|
-
* `path`:
|
87
|
-
The location to install the specified gems to. This defaults to Rubygems'
|
88
|
-
setting. Bundler shares this location with Rubygems, `gem install ...` will
|
89
|
-
have gem installed there, too. Therefore, gems installed without a
|
90
|
-
`--path ...` setting will show up by calling `gem list`. Accordingly, gems
|
91
|
-
installed to other locations will not get listed.
|
92
|
-
|
93
|
-
* `without`:
|
94
|
-
A space-separated or `:`-separated list of groups referencing gems to skip during
|
95
|
-
installation.
|
96
|
-
|
97
|
-
* `with`:
|
98
|
-
A space-separated or `:`-separated list of **optional** groups referencing gems to
|
99
|
-
include during installation.
|
100
|
-
|
101
|
-
## BUILD OPTIONS
|
102
|
-
|
103
|
-
You can use `bundle config` to give Bundler the flags to pass to the gem
|
104
|
-
installer every time bundler tries to install a particular gem.
|
105
|
-
|
106
|
-
A very common example, the `mysql` gem, requires Snow Leopard users to
|
107
|
-
pass configuration flags to `gem install` to specify where to find the
|
108
|
-
`mysql_config` executable.
|
109
|
-
|
110
|
-
gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
|
111
|
-
|
112
|
-
Since the specific location of that executable can change from machine
|
113
|
-
to machine, you can specify these flags on a per-machine basis.
|
114
|
-
|
115
|
-
bundle config set --global build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
|
116
|
-
|
117
|
-
After running this command, every time bundler needs to install the
|
118
|
-
`mysql` gem, it will pass along the flags you specified.
|
119
|
-
|
120
55
|
## CONFIGURATION KEYS
|
121
56
|
|
122
57
|
Configuration keys in bundler have two forms: the canonical form and the
|
@@ -144,9 +79,6 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
144
79
|
|
145
80
|
* `allow_offline_install` (`BUNDLE_ALLOW_OFFLINE_INSTALL`):
|
146
81
|
Allow Bundler to use cached data when installing without network access.
|
147
|
-
* `auto_clean_without_path` (`BUNDLE_AUTO_CLEAN_WITHOUT_PATH`):
|
148
|
-
Automatically run `bundle clean` after installing when an explicit `path`
|
149
|
-
has not been set and Bundler is not installing into the system gems.
|
150
82
|
* `auto_install` (`BUNDLE_AUTO_INSTALL`):
|
151
83
|
Automatically run `bundle install` when gems are missing.
|
152
84
|
* `bin` (`BUNDLE_BIN`):
|
@@ -154,7 +86,7 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
154
86
|
Defaults to `false`.
|
155
87
|
* `cache_all` (`BUNDLE_CACHE_ALL`):
|
156
88
|
Cache all gems, including path and git gems. This needs to be explicitly
|
157
|
-
|
89
|
+
before bundler 4, but will be the default on bundler 4.
|
158
90
|
* `cache_all_platforms` (`BUNDLE_CACHE_ALL_PLATFORMS`):
|
159
91
|
Cache gems for all platforms.
|
160
92
|
* `cache_path` (`BUNDLE_CACHE_PATH`):
|
@@ -163,15 +95,16 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
163
95
|
Defaults to `vendor/cache`.
|
164
96
|
* `clean` (`BUNDLE_CLEAN`):
|
165
97
|
Whether Bundler should run `bundle clean` automatically after
|
166
|
-
`bundle install`.
|
98
|
+
`bundle install`. Defaults to `true` in Bundler 4, as long as `path` is not
|
99
|
+
explicitly configured.
|
167
100
|
* `console` (`BUNDLE_CONSOLE`):
|
168
101
|
The console that `bundle console` starts. Defaults to `irb`.
|
169
|
-
* `
|
170
|
-
|
171
|
-
|
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.
|
172
106
|
* `deployment` (`BUNDLE_DEPLOYMENT`):
|
173
|
-
|
174
|
-
lockfile has not been updated, running Bundler commands will be blocked.
|
107
|
+
Equivalent to setting `frozen` to `true` and `path` to `vendor/bundle`.
|
175
108
|
* `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`):
|
176
109
|
Allow installing gems even if they do not match the checksum provided by
|
177
110
|
RubyGems.
|
@@ -193,12 +126,13 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
193
126
|
Ignore the current machine's platform and install only `ruby` platform gems.
|
194
127
|
As a result, gems with native extensions will be compiled from source.
|
195
128
|
* `frozen` (`BUNDLE_FROZEN`):
|
196
|
-
Disallow changes to
|
197
|
-
|
198
|
-
|
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`.
|
199
133
|
* `gem.github_username` (`BUNDLE_GEM__GITHUB_USERNAME`):
|
200
|
-
Sets a GitHub username or organization to be used in `README`
|
201
|
-
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
|
202
136
|
explicit `--github-username` flag to `bundle gem`.
|
203
137
|
* `gem.push_key` (`BUNDLE_GEM__PUSH_KEY`):
|
204
138
|
Sets the `--key` parameter for `gem push` when using the `rake release`
|
@@ -210,8 +144,8 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
210
144
|
will search up from the current working directory until it finds a
|
211
145
|
`Gemfile`.
|
212
146
|
* `global_gem_cache` (`BUNDLE_GLOBAL_GEM_CACHE`):
|
213
|
-
Whether Bundler should cache all gems
|
214
|
-
|
147
|
+
Whether Bundler should cache all gems and compiled extensions globally,
|
148
|
+
rather than locally to the configured installation path.
|
215
149
|
* `ignore_funding_requests` (`BUNDLE_IGNORE_FUNDING_REQUESTS`):
|
216
150
|
When set, no funding requests will be printed.
|
217
151
|
* `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`):
|
@@ -233,25 +167,19 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
233
167
|
* `path` (`BUNDLE_PATH`):
|
234
168
|
The location on disk where all gems in your bundle will be located regardless
|
235
169
|
of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location
|
236
|
-
will be installed by `bundle install`. Defaults to `
|
237
|
-
|
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.
|
238
173
|
* `path.system` (`BUNDLE_PATH__SYSTEM`):
|
239
174
|
Whether Bundler will install gems into the default system path (`Gem.dir`).
|
240
|
-
* `path_relative_to_cwd` (`BUNDLE_PATH_RELATIVE_TO_CWD`)
|
241
|
-
Makes `--path` relative to the CWD instead of the `Gemfile`.
|
242
175
|
* `plugins` (`BUNDLE_PLUGINS`):
|
243
176
|
Enable Bundler's experimental plugin system.
|
244
177
|
* `prefer_patch` (BUNDLE_PREFER_PATCH):
|
245
178
|
Prefer updating only to next patch version during updates. Makes `bundle update` calls equivalent to `bundler update --patch`.
|
246
|
-
* `print_only_version_number` (`BUNDLE_PRINT_ONLY_VERSION_NUMBER`):
|
247
|
-
Print only version number from `bundler --version`.
|
248
179
|
* `redirect` (`BUNDLE_REDIRECT`):
|
249
180
|
The number of redirects allowed for network requests. Defaults to `5`.
|
250
181
|
* `retry` (`BUNDLE_RETRY`):
|
251
182
|
The number of times to retry failed network requests. Defaults to `3`.
|
252
|
-
* `setup_makes_kernel_gem_public` (`BUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC`):
|
253
|
-
Have `Bundler.setup` make the `Kernel#gem` method public, even though
|
254
|
-
RubyGems declares it as private.
|
255
183
|
* `shebang` (`BUNDLE_SHEBANG`):
|
256
184
|
The program name that should be invoked for generated binstubs. Defaults to
|
257
185
|
the ruby install name used to generate the binstub.
|
@@ -260,6 +188,10 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
260
188
|
be changed in the next major version.
|
261
189
|
* `silence_root_warning` (`BUNDLE_SILENCE_ROOT_WARNING`):
|
262
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.
|
263
195
|
* `ssl_ca_cert` (`BUNDLE_SSL_CA_CERT`):
|
264
196
|
Path to a designated CA certificate file or folder containing multiple
|
265
197
|
certificates for trusted CAs in PEM format.
|
@@ -278,6 +210,9 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
278
210
|
and disallow passing no options to `bundle update`.
|
279
211
|
* `user_agent` (`BUNDLE_USER_AGENT`):
|
280
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.
|
281
216
|
* `version` (`BUNDLE_VERSION`):
|
282
217
|
The version of Bundler to use when running under Bundler environment.
|
283
218
|
Defaults to `lockfile`. You can also specify `system` or `x.y.z`.
|
@@ -289,6 +224,71 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|
289
224
|
* `without` (`BUNDLE_WITHOUT`):
|
290
225
|
A space-separated or `:`-separated list of groups whose gems bundler should not install.
|
291
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.
|
291
|
+
|
292
292
|
## LOCAL GIT REPOS
|
293
293
|
|
294
294
|
Bundler also allows you to work against a git repository locally
|
@@ -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\-CONSOLE" "1" "
|
3
|
+
.TH "BUNDLE\-CONSOLE" "1" "July 2025" ""
|
4
4
|
.SH "NAME"
|
5
5
|
\fBbundle\-console\fR \- Open an IRB session with the bundle pre\-loaded
|
6
6
|
.SH "SYNOPSIS"
|