bundler 2.6.9 → 4.0.11
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 +2229 -1879
- data/README.md +11 -11
- data/bundler.gemspec +5 -5
- data/lib/bundler/build_metadata.rb +10 -11
- data/lib/bundler/capistrano.rb +1 -19
- data/lib/bundler/checksum.rb +6 -0
- data/lib/bundler/cli/add.rb +10 -0
- data/lib/bundler/cli/cache.rb +1 -12
- data/lib/bundler/cli/common.rb +21 -4
- data/lib/bundler/cli/config.rb +1 -2
- data/lib/bundler/cli/console.rb +5 -0
- data/lib/bundler/cli/exec.rb +29 -4
- data/lib/bundler/cli/gem.rb +90 -64
- data/lib/bundler/cli/install.rb +15 -90
- data/lib/bundler/cli/issue.rb +2 -2
- data/lib/bundler/cli/list.rb +33 -2
- data/lib/bundler/cli/lock.rb +5 -5
- data/lib/bundler/cli/outdated.rb +1 -1
- data/lib/bundler/cli/plugin.rb +5 -1
- data/lib/bundler/cli/pristine.rb +5 -1
- data/lib/bundler/cli/show.rb +3 -7
- data/lib/bundler/cli/update.rb +5 -5
- data/lib/bundler/cli.rb +162 -127
- data/lib/bundler/compact_index_client.rb +1 -6
- data/lib/bundler/current_ruby.rb +17 -5
- data/lib/bundler/definition.rb +201 -117
- data/lib/bundler/dependency.rb +1 -1
- data/lib/bundler/deployment.rb +1 -64
- data/lib/bundler/digest.rb +1 -1
- data/lib/bundler/dsl.rb +48 -48
- data/lib/bundler/environment_preserver.rb +1 -0
- data/lib/bundler/errors.rb +1 -5
- data/lib/bundler/feature_flag.rb +5 -35
- data/lib/bundler/fetcher/compact_index.rb +1 -1
- data/lib/bundler/fetcher/dependency.rb +9 -2
- data/lib/bundler/fetcher/downloader.rb +33 -8
- data/lib/bundler/fetcher/gem_remote_fetcher.rb +6 -0
- data/lib/bundler/fetcher.rb +49 -19
- data/lib/bundler/friendly_errors.rb +4 -3
- data/lib/bundler/index.rb +7 -9
- data/lib/bundler/injector.rb +1 -2
- data/lib/bundler/inline.rb +9 -1
- data/lib/bundler/installer/gem_installer.rb +14 -11
- data/lib/bundler/installer/parallel_installer.rb +74 -36
- data/lib/bundler/installer.rb +6 -19
- data/lib/bundler/lazy_specification.rb +47 -20
- data/lib/bundler/lockfile_generator.rb +17 -2
- data/lib/bundler/lockfile_parser.rb +19 -6
- data/lib/bundler/man/bundle-add.1 +1 -1
- data/lib/bundler/man/bundle-binstubs.1 +3 -6
- data/lib/bundler/man/bundle-binstubs.1.ronn +4 -6
- data/lib/bundler/man/bundle-cache.1 +2 -14
- data/lib/bundler/man/bundle-cache.1.ronn +1 -14
- data/lib/bundler/man/bundle-check.1 +2 -5
- data/lib/bundler/man/bundle-check.1.ronn +0 -5
- data/lib/bundler/man/bundle-clean.1 +1 -1
- data/lib/bundler/man/bundle-config.1 +206 -148
- data/lib/bundler/man/bundle-config.1.ronn +136 -119
- data/lib/bundler/man/bundle-console.1 +1 -1
- data/lib/bundler/man/bundle-doctor.1 +43 -4
- data/lib/bundler/man/bundle-doctor.1.ronn +48 -4
- data/lib/bundler/man/bundle-env.1 +1 -1
- data/lib/bundler/man/bundle-exec.1 +2 -5
- data/lib/bundler/man/bundle-exec.1.ronn +1 -5
- data/lib/bundler/man/bundle-fund.1 +1 -1
- data/lib/bundler/man/bundle-gem.1 +64 -44
- data/lib/bundler/man/bundle-gem.1.ronn +10 -9
- data/lib/bundler/man/bundle-help.1 +1 -1
- data/lib/bundler/man/bundle-info.1 +1 -1
- data/lib/bundler/man/bundle-init.1 +1 -1
- data/lib/bundler/man/bundle-install.1 +16 -59
- data/lib/bundler/man/bundle-install.1.ronn +27 -108
- data/lib/bundler/man/bundle-issue.1 +1 -1
- data/lib/bundler/man/bundle-licenses.1 +1 -1
- data/lib/bundler/man/bundle-list.1 +6 -1
- data/lib/bundler/man/bundle-list.1.ronn +5 -0
- data/lib/bundler/man/bundle-lock.1 +1 -1
- data/lib/bundler/man/bundle-open.1 +1 -1
- data/lib/bundler/man/bundle-outdated.1 +1 -1
- data/lib/bundler/man/bundle-platform.1 +1 -1
- data/lib/bundler/man/bundle-plugin.1 +33 -15
- data/lib/bundler/man/bundle-plugin.1.ronn +36 -15
- data/lib/bundler/man/bundle-pristine.1 +1 -1
- data/lib/bundler/man/bundle-remove.1 +2 -8
- data/lib/bundler/man/bundle-remove.1.ronn +1 -8
- data/lib/bundler/man/bundle-show.1 +2 -5
- data/lib/bundler/man/bundle-show.1.ronn +0 -4
- data/lib/bundler/man/bundle-update.1 +5 -5
- data/lib/bundler/man/bundle-update.1.ronn +4 -4
- data/lib/bundler/man/bundle-version.1 +1 -1
- data/lib/bundler/man/bundle.1 +1 -10
- data/lib/bundler/man/bundle.1.ronn +0 -9
- data/lib/bundler/man/gemfile.5 +32 -1
- data/lib/bundler/man/gemfile.5.ronn +28 -0
- data/lib/bundler/man/index.txt +0 -2
- data/lib/bundler/match_platform.rb +31 -12
- data/lib/bundler/materialization.rb +3 -3
- data/lib/bundler/plugin/api/source.rb +8 -0
- data/lib/bundler/plugin/index.rb +6 -0
- data/lib/bundler/plugin/installer.rb +2 -11
- data/lib/bundler/plugin/source_list.rb +1 -1
- data/lib/bundler/plugin.rb +7 -4
- data/lib/bundler/resolver/package.rb +2 -1
- data/lib/bundler/resolver/strategy.rb +6 -3
- data/lib/bundler/resolver.rb +20 -4
- data/lib/bundler/retry.rb +30 -4
- data/lib/bundler/ruby_dsl.rb +17 -12
- data/lib/bundler/ruby_version.rb +1 -3
- data/lib/bundler/rubygems_ext.rb +117 -121
- data/lib/bundler/rubygems_gem_installer.rb +5 -4
- data/lib/bundler/rubygems_integration.rb +13 -12
- data/lib/bundler/runtime.rb +14 -3
- data/lib/bundler/self_manager.rb +34 -43
- data/lib/bundler/settings/validator.rb +5 -21
- data/lib/bundler/settings.rb +17 -32
- data/lib/bundler/shared_helpers.rb +12 -18
- data/lib/bundler/source/gemspec.rb +4 -0
- data/lib/bundler/source/git/git_proxy.rb +55 -29
- data/lib/bundler/source/git.rb +2 -3
- data/lib/bundler/source/metadata.rb +4 -0
- data/lib/bundler/source/path.rb +12 -7
- data/lib/bundler/source/rubygems.rb +59 -43
- data/lib/bundler/source/rubygems_aggregate.rb +4 -1
- data/lib/bundler/source.rb +3 -1
- data/lib/bundler/source_list.rb +5 -50
- data/lib/bundler/source_map.rb +8 -7
- data/lib/bundler/spec_set.rb +9 -14
- data/lib/bundler/stub_specification.rb +1 -0
- data/lib/bundler/templates/Executable +0 -11
- data/lib/bundler/templates/newgem/CODE_OF_CONDUCT.md.tt +7 -129
- data/lib/bundler/templates/newgem/Cargo.toml.tt +6 -0
- data/lib/bundler/templates/newgem/Rakefile.tt +5 -0
- data/lib/bundler/templates/newgem/circleci/config.yml.tt +12 -0
- data/lib/bundler/templates/newgem/ext/newgem/Cargo.toml.tt +8 -1
- data/lib/bundler/templates/newgem/ext/newgem/build.rs.tt +5 -0
- data/lib/bundler/templates/newgem/ext/newgem/extconf-go.rb.tt +11 -0
- data/lib/bundler/templates/newgem/ext/newgem/go.mod.tt +5 -0
- data/lib/bundler/templates/newgem/ext/newgem/newgem-go.c.tt +2 -0
- data/lib/bundler/templates/newgem/ext/newgem/newgem.go.tt +31 -0
- data/lib/bundler/templates/newgem/ext/newgem/src/lib.rs.tt +13 -2
- data/lib/bundler/templates/newgem/github/workflows/build-gems.yml.tt +69 -0
- data/lib/bundler/templates/newgem/github/workflows/main.yml.tt +12 -1
- data/lib/bundler/templates/newgem/gitlab-ci.yml.tt +9 -0
- data/lib/bundler/templates/newgem/lib/newgem.rb.tt +1 -1
- data/lib/bundler/templates/newgem/newgem.gemspec.tt +17 -11
- data/lib/bundler/templates/newgem/spec/newgem_spec.rb.tt +8 -0
- data/lib/bundler/templates/newgem/test/minitest/test_newgem.rb.tt +6 -0
- data/lib/bundler/ui/shell.rb +12 -8
- data/lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb +26 -23
- data/lib/bundler/vendor/connection_pool/lib/connection_pool/version.rb +1 -1
- data/lib/bundler/vendor/connection_pool/lib/connection_pool.rb +50 -6
- data/lib/bundler/vendor/fileutils/lib/fileutils.rb +57 -52
- data/lib/bundler/vendor/net-http-persistent/README.rdoc +1 -1
- data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/timed_stack_multi.rb +2 -1
- data/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb +84 -42
- data/lib/bundler/vendor/thor/lib/thor/actions/file_manipulation.rb +42 -6
- data/lib/bundler/vendor/thor/lib/thor/parser/options.rb +1 -1
- data/lib/bundler/vendor/thor/lib/thor/runner.rb +2 -2
- data/lib/bundler/vendor/thor/lib/thor/shell/basic.rb +3 -7
- data/lib/bundler/vendor/thor/lib/thor/version.rb +1 -1
- data/lib/bundler/vendor/thor/lib/thor.rb +1 -1
- data/lib/bundler/vendor/uri/lib/uri/common.rb +57 -15
- data/lib/bundler/vendor/uri/lib/uri/file.rb +1 -1
- data/lib/bundler/vendor/uri/lib/uri/generic.rb +34 -21
- data/lib/bundler/vendor/uri/lib/uri/http.rb +12 -0
- data/lib/bundler/vendor/uri/lib/uri/rfc2396_parser.rb +9 -8
- data/lib/bundler/vendor/uri/lib/uri/version.rb +2 -2
- data/lib/bundler/version.rb +10 -2
- data/lib/bundler/vlad.rb +1 -14
- data/lib/bundler/worker.rb +12 -4
- data/lib/bundler.rb +20 -40
- metadata +13 -25
- data/lib/bundler/cli/inject.rb +0 -60
- data/lib/bundler/cli/viz.rb +0 -31
- data/lib/bundler/gem_helpers.rb +0 -144
- data/lib/bundler/graph.rb +0 -152
- data/lib/bundler/man/bundle-inject.1 +0 -31
- data/lib/bundler/man/bundle-inject.1.ronn +0 -32
- data/lib/bundler/man/bundle-viz.1 +0 -30
- data/lib/bundler/man/bundle-viz.1.ronn +0 -36
- data/lib/bundler/similarity_detector.rb +0 -63
- data/lib/bundler/templates/Executable.bundler +0 -109
- data/lib/bundler/vendor/connection_pool/.document +0 -1
- data/lib/bundler/vendor/fileutils/.document +0 -1
- data/lib/bundler/vendor/net-http-persistent/.document +0 -1
- data/lib/bundler/vendor/pub_grub/.document +0 -1
- data/lib/bundler/vendor/securerandom/.document +0 -1
- data/lib/bundler/vendor/thor/.document +0 -1
- data/lib/bundler/vendor/tsort/.document +0 -1
- data/lib/bundler/vendor/uri/.document +0 -1
|
@@ -15,9 +15,6 @@ use the gems in the cache in preference to the ones on `rubygems.org`.
|
|
|
15
15
|
|
|
16
16
|
## OPTIONS
|
|
17
17
|
|
|
18
|
-
* `--all`:
|
|
19
|
-
Include all sources (including path and git).
|
|
20
|
-
|
|
21
18
|
* `--all-platforms`:
|
|
22
19
|
Include gems for all platforms present in the lockfile, not only the current one.
|
|
23
20
|
|
|
@@ -30,23 +27,13 @@ use the gems in the cache in preference to the ones on `rubygems.org`.
|
|
|
30
27
|
* `--no-install`:
|
|
31
28
|
Don't install the gems, only update the cache.
|
|
32
29
|
|
|
33
|
-
* `--no-prune`:
|
|
34
|
-
Don't remove stale gems from the cache.
|
|
35
|
-
|
|
36
|
-
* `--path=PATH`:
|
|
37
|
-
Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME).
|
|
38
|
-
|
|
39
30
|
* `--quiet`:
|
|
40
31
|
Only output warnings and errors.
|
|
41
32
|
|
|
42
|
-
* `--frozen`:
|
|
43
|
-
Do not allow the Gemfile.lock to be updated after this bundle cache operation's install.
|
|
44
|
-
|
|
45
33
|
## GIT AND PATH GEMS
|
|
46
34
|
|
|
47
35
|
The `bundle cache` command can also package `:git` and `:path` dependencies
|
|
48
|
-
besides .gem files. This
|
|
49
|
-
Once used, the `--all` option will be remembered.
|
|
36
|
+
besides .gem files. This can be disabled setting `cache_all` to false.
|
|
50
37
|
|
|
51
38
|
## SUPPORT FOR MULTIPLE PLATFORMS
|
|
52
39
|
|
|
@@ -1,10 +1,10 @@
|
|
|
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" "April 2026" ""
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBbundle\-check\fR \- Verifies if dependencies are satisfied by installed gems
|
|
6
6
|
.SH "SYNOPSIS"
|
|
7
|
-
\fBbundle check\fR [\-\-dry\-run] [\-\-gemfile=FILE]
|
|
7
|
+
\fBbundle check\fR [\-\-dry\-run] [\-\-gemfile=FILE]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
9
|
\fBcheck\fR searches the local machine for each of the gems requested in the Gemfile\. If all gems are found, Bundler prints a success message and exits with a status of 0\.
|
|
10
10
|
.P
|
|
@@ -18,7 +18,4 @@ Locks the [\fBGemfile(5)\fR][Gemfile(5)] before running the command\.
|
|
|
18
18
|
.TP
|
|
19
19
|
\fB\-\-gemfile=GEMFILE\fR
|
|
20
20
|
Use the specified gemfile instead of the [\fBGemfile(5)\fR][Gemfile(5)]\.
|
|
21
|
-
.TP
|
|
22
|
-
\fB\-\-path=PATH\fR
|
|
23
|
-
Specify a different path than the system default (\fB$BUNDLE_PATH\fR or \fB$GEM_HOME\fR)\. Bundler will remember this value for future installs on this machine\.
|
|
24
21
|
|
|
@@ -5,7 +5,6 @@ bundle-check(1) -- Verifies if dependencies are satisfied by installed gems
|
|
|
5
5
|
|
|
6
6
|
`bundle check` [--dry-run]
|
|
7
7
|
[--gemfile=FILE]
|
|
8
|
-
[--path=PATH]
|
|
9
8
|
|
|
10
9
|
## DESCRIPTION
|
|
11
10
|
|
|
@@ -25,7 +24,3 @@ installed on the local machine, if they satisfy the requirements.
|
|
|
25
24
|
|
|
26
25
|
* `--gemfile=GEMFILE`:
|
|
27
26
|
Use the specified gemfile instead of the [`Gemfile(5)`][Gemfile(5)].
|
|
28
|
-
|
|
29
|
-
* `--path=PATH`:
|
|
30
|
-
Specify a different path than the system default (`$BUNDLE_PATH` or `$GEM_HOME`).
|
|
31
|
-
Bundler will remember this value for future installs on this machine.
|
|
@@ -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" "April 2026" ""
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBbundle\-clean\fR \- Cleans up unused gems in your bundler directory
|
|
6
6
|
.SH "SYNOPSIS"
|
|
@@ -1,16 +1,16 @@
|
|
|
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" "April 2026" ""
|
|
4
4
|
.SH "NAME"
|
|
5
5
|
\fBbundle\-config\fR \- Set bundler configuration options
|
|
6
6
|
.SH "SYNOPSIS"
|
|
7
|
-
\fBbundle config\fR list
|
|
7
|
+
\fBbundle config\fR [list]
|
|
8
8
|
.br
|
|
9
|
-
\fBbundle config\fR [get] NAME
|
|
9
|
+
\fBbundle config\fR [get [\-\-local|\-\-global]] NAME
|
|
10
10
|
.br
|
|
11
|
-
\fBbundle config\fR [set] NAME VALUE
|
|
11
|
+
\fBbundle config\fR [set [\-\-local|\-\-global]] NAME VALUE
|
|
12
12
|
.br
|
|
13
|
-
\fBbundle config\fR unset NAME
|
|
13
|
+
\fBbundle config\fR unset [\-\-local|\-\-global] NAME
|
|
14
14
|
.SH "DESCRIPTION"
|
|
15
15
|
This command allows you to interact with Bundler's configuration system\.
|
|
16
16
|
.P
|
|
@@ -25,47 +25,206 @@ Global config (\fB~/\.bundle/config\fR)
|
|
|
25
25
|
Bundler default config
|
|
26
26
|
.IP "" 0
|
|
27
27
|
.P
|
|
28
|
+
Executing \fBbundle\fR with the \fBBUNDLE_IGNORE_CONFIG\fR environment variable set will cause it to ignore all configuration\.
|
|
29
|
+
.SH "SUB\-COMMANDS"
|
|
30
|
+
.SS "list (default command)"
|
|
28
31
|
Executing \fBbundle config list\fR will print a list of all bundler configuration for the current bundle, and where that configuration was set\.
|
|
32
|
+
.SS "get"
|
|
33
|
+
Executing \fBbundle config get <name>\fR will print the value of that configuration setting, and all locations where it was set\.
|
|
29
34
|
.P
|
|
30
|
-
|
|
31
|
-
.
|
|
32
|
-
|
|
35
|
+
\fBOPTIONS\fR
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-local\fR
|
|
38
|
+
Get configuration from configuration file for the local application, namely, \fB<project_root>/\.bundle/config\fR, or \fB$BUNDLE_APP_CONFIG/config\fR if \fBBUNDLE_APP_CONFIG\fR is set\.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-global\fR
|
|
41
|
+
Get configuration from configuration file global to all bundles executed as the current user, namely, from \fB~/\.bundle/config\fR\.
|
|
42
|
+
.SS "set"
|
|
43
|
+
Executing \fBbundle config set <name> <value>\fR defaults to setting \fBlocal\fR configuration if executing from within a local application, otherwise it will set \fBglobal\fR configuration\.
|
|
33
44
|
.P
|
|
45
|
+
\fBOPTIONS\fR
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-local\fR
|
|
34
48
|
Executing \fBbundle config set \-\-local <name> <value>\fR will set that configuration in the directory for the local application\. The configuration will be stored in \fB<project_root>/\.bundle/config\fR\. If \fBBUNDLE_APP_CONFIG\fR is set, the configuration will be stored in \fB$BUNDLE_APP_CONFIG/config\fR\.
|
|
35
|
-
.
|
|
49
|
+
.TP
|
|
50
|
+
\fB\-\-global\fR
|
|
36
51
|
Executing \fBbundle config set \-\-global <name> <value>\fR will set that configuration to the value specified for all bundles executed as the current user\. The configuration will be stored in \fB~/\.bundle/config\fR\. If \fIname\fR already is set, \fIname\fR will be overridden and user will be warned\.
|
|
37
|
-
.
|
|
52
|
+
.SS "unset"
|
|
38
53
|
Executing \fBbundle config unset <name>\fR will delete the configuration in both local and global sources\.
|
|
39
54
|
.P
|
|
40
|
-
|
|
41
|
-
.
|
|
55
|
+
\fBOPTIONS\fR
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-local\fR
|
|
42
58
|
Executing \fBbundle config unset \-\-local <name>\fR will delete the configuration only from the local application\.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-global\fR
|
|
61
|
+
Executing \fBbundle config unset \-\-global <name>\fR will delete the configuration only from the user configuration\.
|
|
62
|
+
.SH "CONFIGURATION KEYS"
|
|
63
|
+
Configuration keys in bundler have two forms: the canonical form and the environment variable form\.
|
|
43
64
|
.P
|
|
44
|
-
|
|
45
|
-
.SH "REMEMBERING OPTIONS"
|
|
46
|
-
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)\.
|
|
65
|
+
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\.
|
|
47
66
|
.P
|
|
48
|
-
|
|
67
|
+
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\.
|
|
49
68
|
.P
|
|
50
|
-
|
|
69
|
+
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\.
|
|
70
|
+
.SH "LIST OF AVAILABLE KEYS"
|
|
71
|
+
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\.
|
|
72
|
+
.TP
|
|
73
|
+
\fBapi_request_size\fR (\fBBUNDLE_API_REQUEST_SIZE\fR)
|
|
74
|
+
Configure how many dependencies to fetch when resolving the specifications\. This configuration is only used when fetchig specifications from RubyGems servers that didn't implement the Compact Index API\. Defaults to 100\.
|
|
75
|
+
.TP
|
|
76
|
+
\fBauto_install\fR (\fBBUNDLE_AUTO_INSTALL\fR)
|
|
77
|
+
Automatically run \fBbundle install\fR when gems are missing\.
|
|
78
|
+
.TP
|
|
79
|
+
\fBbin\fR (\fBBUNDLE_BIN\fR)
|
|
80
|
+
If configured, \fBbundle binstubs\fR will install executables from gems in the bundle to the specified directory\. Otherwise it will create them in a \fBbin\fR directory relative to the Gemfile directory\. 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, \fBbundle binstubs\fR will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
|
|
81
|
+
.TP
|
|
82
|
+
\fBcache_all\fR (\fBBUNDLE_CACHE_ALL\fR)
|
|
83
|
+
Cache all gems, including path and git gems\. This needs to be explicitly before bundler 4, but will be the default on bundler 4\.
|
|
84
|
+
.TP
|
|
85
|
+
\fBcache_all_platforms\fR (\fBBUNDLE_CACHE_ALL_PLATFORMS\fR)
|
|
86
|
+
Cache gems for all platforms\.
|
|
87
|
+
.TP
|
|
88
|
+
\fBcache_path\fR (\fBBUNDLE_CACHE_PATH\fR)
|
|
89
|
+
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\.
|
|
90
|
+
.TP
|
|
91
|
+
\fBclean\fR (\fBBUNDLE_CLEAN\fR)
|
|
92
|
+
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\.
|
|
93
|
+
.TP
|
|
94
|
+
\fBconsole\fR (\fBBUNDLE_CONSOLE\fR)
|
|
95
|
+
The console that \fBbundle console\fR starts\. Defaults to \fBirb\fR\.
|
|
96
|
+
.TP
|
|
97
|
+
\fBdefault_cli_command\fR (\fBBUNDLE_DEFAULT_CLI_COMMAND\fR)
|
|
98
|
+
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\.
|
|
99
|
+
.TP
|
|
100
|
+
\fBdeployment\fR (\fBBUNDLE_DEPLOYMENT\fR)
|
|
101
|
+
Equivalent to setting \fBfrozen\fR to \fBtrue\fR and \fBpath\fR to \fBvendor/bundle\fR\.
|
|
102
|
+
.TP
|
|
103
|
+
\fBdisable_checksum_validation\fR (\fBBUNDLE_DISABLE_CHECKSUM_VALIDATION\fR)
|
|
104
|
+
Allow installing gems even if they do not match the checksum provided by RubyGems\.
|
|
105
|
+
.TP
|
|
106
|
+
\fBdisable_exec_load\fR (\fBBUNDLE_DISABLE_EXEC_LOAD\fR)
|
|
107
|
+
Stop Bundler from using \fBload\fR to launch an executable in\-process in \fBbundle exec\fR\.
|
|
108
|
+
.TP
|
|
109
|
+
\fBdisable_local_branch_check\fR (\fBBUNDLE_DISABLE_LOCAL_BRANCH_CHECK\fR)
|
|
110
|
+
Allow Bundler to use a local git override without a branch specified in the Gemfile\.
|
|
111
|
+
.TP
|
|
112
|
+
\fBdisable_local_revision_check\fR (\fBBUNDLE_DISABLE_LOCAL_REVISION_CHECK\fR)
|
|
113
|
+
Allow Bundler to use a local git override without checking if the revision present in the lockfile is present in the repository\.
|
|
114
|
+
.TP
|
|
115
|
+
\fBdisable_shared_gems\fR (\fBBUNDLE_DISABLE_SHARED_GEMS\fR)
|
|
116
|
+
Stop Bundler from accessing gems installed to RubyGems' normal location\.
|
|
117
|
+
.TP
|
|
118
|
+
\fBdisable_version_check\fR (\fBBUNDLE_DISABLE_VERSION_CHECK\fR)
|
|
119
|
+
Stop Bundler from checking if a newer Bundler version is available on rubygems\.org\.
|
|
51
120
|
.TP
|
|
52
|
-
\
|
|
53
|
-
|
|
121
|
+
\fBforce_ruby_platform\fR (\fBBUNDLE_FORCE_RUBY_PLATFORM\fR)
|
|
122
|
+
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\.
|
|
54
123
|
.TP
|
|
55
|
-
\
|
|
56
|
-
|
|
124
|
+
\fBfrozen\fR (\fBBUNDLE_FROZEN\fR)
|
|
125
|
+
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\.
|
|
57
126
|
.TP
|
|
58
|
-
\
|
|
59
|
-
|
|
127
|
+
\fBgem\.github_username\fR (\fBBUNDLE_GEM__GITHUB_USERNAME\fR)
|
|
128
|
+
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\.
|
|
60
129
|
.TP
|
|
61
|
-
\
|
|
62
|
-
|
|
130
|
+
\fBgem\.push_key\fR (\fBBUNDLE_GEM__PUSH_KEY\fR)
|
|
131
|
+
Sets the \fB\-\-key\fR parameter for \fBgem push\fR when using the \fBrake release\fR command with a private gemstash server\.
|
|
63
132
|
.TP
|
|
64
|
-
\
|
|
65
|
-
|
|
133
|
+
\fBgemfile\fR (\fBBUNDLE_GEMFILE\fR)
|
|
134
|
+
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\.
|
|
66
135
|
.TP
|
|
67
|
-
\
|
|
68
|
-
|
|
136
|
+
\fBglobal_gem_cache\fR (\fBBUNDLE_GLOBAL_GEM_CACHE\fR)
|
|
137
|
+
Whether Bundler should cache all gems and compiled extensions globally, rather than locally to the configured installation path\.
|
|
138
|
+
.TP
|
|
139
|
+
\fBignore_funding_requests\fR (\fBBUNDLE_IGNORE_FUNDING_REQUESTS\fR)
|
|
140
|
+
When set, no funding requests will be printed\.
|
|
141
|
+
.TP
|
|
142
|
+
\fBignore_messages\fR (\fBBUNDLE_IGNORE_MESSAGES\fR)
|
|
143
|
+
When set, no post install messages will be printed\. To silence a single gem, use dot notation like \fBignore_messages\.httparty true\fR\.
|
|
144
|
+
.TP
|
|
145
|
+
\fBinit_gems_rb\fR (\fBBUNDLE_INIT_GEMS_RB\fR)
|
|
146
|
+
Generate a \fBgems\.rb\fR instead of a \fBGemfile\fR when running \fBbundle init\fR\.
|
|
147
|
+
.TP
|
|
148
|
+
\fBjobs\fR (\fBBUNDLE_JOBS\fR)
|
|
149
|
+
The number of gems Bundler can download and install in parallel\. Defaults to the number of available processors\.
|
|
150
|
+
.TP
|
|
151
|
+
\fBlockfile\fR (\fBBUNDLE_LOCKFILE\fR)
|
|
152
|
+
The path to the lockfile that bundler should use\. By default, Bundler adds \fB\.lock\fR to the end of the \fBgemfile\fR entry\. Can be set to \fBfalse\fR in the Gemfile to disable lockfile creation entirely (see gemfile(5))\.
|
|
153
|
+
.TP
|
|
154
|
+
\fBlockfile_checksums\fR (\fBBUNDLE_LOCKFILE_CHECKSUMS\fR)
|
|
155
|
+
Whether Bundler should include a checksums section in new lockfiles, to protect from compromised gem sources\. Defaults to true\.
|
|
156
|
+
.TP
|
|
157
|
+
\fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR)
|
|
158
|
+
Whether \fBbundle package\fR should skip installing gems\.
|
|
159
|
+
.TP
|
|
160
|
+
\fBno_prune\fR (\fBBUNDLE_NO_PRUNE\fR)
|
|
161
|
+
Whether Bundler should leave outdated gems unpruned when caching\.
|
|
162
|
+
.TP
|
|
163
|
+
\fBonly\fR (\fBBUNDLE_ONLY\fR)
|
|
164
|
+
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, because they get put inside \fBdefault\fR group\. For example \fBonly test:default\fR will install all gems specified in test group and without one\.
|
|
165
|
+
.TP
|
|
166
|
+
\fBpath\fR (\fBBUNDLE_PATH\fR)
|
|
167
|
+
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\. When not set, Bundler install by default to a \fB\.bundle\fR directory relative to repository root in Bundler 4, and to the default system path (\fBGem\.dir\fR) before Bundler 4\. That means that before Bundler 4, Bundler shares this location with Rubygems, and \fBgem install \|\.\|\.\|\.\fR will have gems installed in the same location and therefore, gems installed without \fBpath\fR set will show up by calling \fBgem list\fR\. This will not be the case in Bundler 4\.
|
|
168
|
+
.TP
|
|
169
|
+
\fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR)
|
|
170
|
+
Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
|
|
171
|
+
.TP
|
|
172
|
+
\fBplugins\fR (\fBBUNDLE_PLUGINS\fR)
|
|
173
|
+
Enable Bundler's experimental plugin system\.
|
|
174
|
+
.TP
|
|
175
|
+
\fBprefer_patch\fR (\fBBUNDLE_PREFER_PATCH\fR)
|
|
176
|
+
Prefer updating only to next patch version during updates\. Makes \fBbundle update\fR calls equivalent to \fBbundler update \-\-patch\fR\.
|
|
177
|
+
.TP
|
|
178
|
+
\fBredirect\fR (\fBBUNDLE_REDIRECT\fR)
|
|
179
|
+
The number of redirects allowed for network requests\. Defaults to \fB5\fR\.
|
|
180
|
+
.TP
|
|
181
|
+
\fBretry\fR (\fBBUNDLE_RETRY\fR)
|
|
182
|
+
The number of times to retry failed network requests\. Defaults to \fB3\fR\.
|
|
183
|
+
.TP
|
|
184
|
+
\fBshebang\fR (\fBBUNDLE_SHEBANG\fR)
|
|
185
|
+
The program name that should be invoked for generated binstubs\. Defaults to the ruby install name used to generate the binstub\.
|
|
186
|
+
.TP
|
|
187
|
+
\fBsilence_deprecations\fR (\fBBUNDLE_SILENCE_DEPRECATIONS\fR)
|
|
188
|
+
Whether Bundler should silence deprecation warnings for behavior that will be changed in the next major version\.
|
|
189
|
+
.TP
|
|
190
|
+
\fBsilence_root_warning\fR (\fBBUNDLE_SILENCE_ROOT_WARNING\fR)
|
|
191
|
+
Silence the warning Bundler prints when installing gems as root\.
|
|
192
|
+
.TP
|
|
193
|
+
\fBsimulate_version\fR (\fBBUNDLE_SIMULATE_VERSION\fR)
|
|
194
|
+
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\.
|
|
195
|
+
.TP
|
|
196
|
+
\fBssl_ca_cert\fR (\fBBUNDLE_SSL_CA_CERT\fR)
|
|
197
|
+
Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format\.
|
|
198
|
+
.TP
|
|
199
|
+
\fBssl_client_cert\fR (\fBBUNDLE_SSL_CLIENT_CERT\fR)
|
|
200
|
+
Path to a designated file containing a X\.509 client certificate and key in PEM format\.
|
|
201
|
+
.TP
|
|
202
|
+
\fBssl_verify_mode\fR (\fBBUNDLE_SSL_VERIFY_MODE\fR)
|
|
203
|
+
The SSL verification mode Bundler uses when making HTTPS requests\. Defaults to verify peer\.
|
|
204
|
+
.TP
|
|
205
|
+
\fBsystem_bindir\fR (\fBBUNDLE_SYSTEM_BINDIR\fR)
|
|
206
|
+
The location where RubyGems installs binstubs\. Defaults to \fBGem\.bindir\fR\.
|
|
207
|
+
.TP
|
|
208
|
+
\fBtimeout\fR (\fBBUNDLE_TIMEOUT\fR)
|
|
209
|
+
The seconds allowed before timing out for network requests\. Defaults to \fB10\fR\.
|
|
210
|
+
.TP
|
|
211
|
+
\fBupdate_requires_all_flag\fR (\fBBUNDLE_UPDATE_REQUIRES_ALL_FLAG\fR)
|
|
212
|
+
Require passing \fB\-\-all\fR to \fBbundle update\fR when everything should be updated, and disallow passing no options to \fBbundle update\fR\.
|
|
213
|
+
.TP
|
|
214
|
+
\fBuser_agent\fR (\fBBUNDLE_USER_AGENT\fR)
|
|
215
|
+
The custom user agent fragment Bundler includes in API requests\.
|
|
216
|
+
.TP
|
|
217
|
+
\fBverbose\fR (\fBBUNDLE_VERBOSE\fR)
|
|
218
|
+
Whether Bundler should print verbose output\. Defaults to \fBfalse\fR, unless the \fB\-\-verbose\fR CLI flag is used\.
|
|
219
|
+
.TP
|
|
220
|
+
\fBversion\fR (\fBBUNDLE_VERSION\fR)
|
|
221
|
+
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\.
|
|
222
|
+
.TP
|
|
223
|
+
\fBwith\fR (\fBBUNDLE_WITH\fR)
|
|
224
|
+
A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should install\.
|
|
225
|
+
.TP
|
|
226
|
+
\fBwithout\fR (\fBBUNDLE_WITHOUT\fR)
|
|
227
|
+
A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should not install\.
|
|
69
228
|
.SH "BUILD OPTIONS"
|
|
70
229
|
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
230
|
.P
|
|
@@ -84,123 +243,6 @@ bundle config set \-\-global build\.mysql \-\-with\-mysql\-config=/usr/local/mys
|
|
|
84
243
|
.IP "" 0
|
|
85
244
|
.P
|
|
86
245
|
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
246
|
.SH "LOCAL GIT REPOS"
|
|
205
247
|
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
248
|
.IP "" 4
|
|
@@ -209,7 +251,16 @@ bundle config set \-\-local local\.GEM_NAME /path/to/local/git/repository
|
|
|
209
251
|
.fi
|
|
210
252
|
.IP "" 0
|
|
211
253
|
.P
|
|
212
|
-
|
|
254
|
+
Important: This feature only works for gems that are specified with a git source in your Gemfile\. It does not work for gems installed from RubyGems or other sources\. The gem must be defined with \fBgit:\fR option pointing to a remote repository\.
|
|
255
|
+
.P
|
|
256
|
+
For example, if your Gemfile contains:
|
|
257
|
+
.IP "" 4
|
|
258
|
+
.nf
|
|
259
|
+
gem "rack", git: "https://github\.com/rack/rack\.git", branch: "main"
|
|
260
|
+
.fi
|
|
261
|
+
.IP "" 0
|
|
262
|
+
.P
|
|
263
|
+
Then you can use a local Rack repository by running:
|
|
213
264
|
.IP "" 4
|
|
214
265
|
.nf
|
|
215
266
|
bundle config set \-\-local local\.rack ~/Work/git/rack
|
|
@@ -221,6 +272,13 @@ Now instead of checking out the remote git repository, the local override will b
|
|
|
221
272
|
Bundler does many checks to ensure a developer won't work with invalid references\. Particularly, we force a developer to specify a branch in the \fBGemfile\fR in order to use this feature\. If the branch specified in the \fBGemfile\fR and the current branch in the local git repository do not match, Bundler will abort\. This ensures that a developer is always working against the correct branches, and prevents accidental locking to a different branch\.
|
|
222
273
|
.P
|
|
223
274
|
Finally, Bundler also ensures that the current revision in the \fBGemfile\.lock\fR exists in the local git repository\. By doing this, Bundler forces you to fetch the latest changes in the remotes\.
|
|
275
|
+
.P
|
|
276
|
+
If you need to temporarily use a local version of a gem that is normally installed from RubyGems (not from git), use a path source instead:
|
|
277
|
+
.IP "" 4
|
|
278
|
+
.nf
|
|
279
|
+
gem "rack", path: "~/Work/git/rack"
|
|
280
|
+
.fi
|
|
281
|
+
.IP "" 0
|
|
224
282
|
.SH "MIRRORS OF GEM SOURCES"
|
|
225
283
|
Bundler supports overriding gem sources with mirrors\. This allows you to configure rubygems\.org as the gem source in your Gemfile while still using your mirror to fetch gems\.
|
|
226
284
|
.IP "" 4
|
|
@@ -276,7 +334,7 @@ export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
|
|
|
276
334
|
For gems with a git source with HTTP(S) URL you can specify credentials like so:
|
|
277
335
|
.IP "" 4
|
|
278
336
|
.nf
|
|
279
|
-
bundle config set \-\-global https://github\.com/
|
|
337
|
+
bundle config set \-\-global https://github\.com/ruby/rubygems\.git username:password
|
|
280
338
|
.fi
|
|
281
339
|
.IP "" 0
|
|
282
340
|
.P
|