1BUNDLE-CACHE(1) BUNDLE-CACHE(1)
2
3
4
6 bundle-cache - Package your needed .gem files into your application
7
9 bundle cache
10
12 Copy all of the .gem files needed to run the application into the ven‐
13 dor/cache directory. In the future, when running [bundle
14 install(1)][bundle-install], use the gems in the cache in preference to
15 the ones on rubygems.org.
16
18 The bundle cache command can also package :git and :path dependencies
19 besides .gem files. This needs to be explicitly enabled via the --all
20 option. Once used, the --all option will be remembered.
21
23 When using gems that have different packages for different platforms,
24 Bundler supports caching of gems for other platforms where the Gemfile
25 has been resolved (i.e. present in the lockfile) in vendor/cache. This
26 needs to be enabled via the --all-platforms option. This setting will
27 be remembered in your local bundler configuration.
28
30 By default, if you run bundle install(1)](bundle-install.1.html) after
31 running bundle cache(1) bundle-cache.1.html, bundler will still connect
32 to rubygems.org to check whether a platform-specific gem exists for any
33 of the gems in vendor/cache.
34
35 For instance, consider this Gemfile(5):
36
37
38
39 source "https://rubygems.org"
40
41 gem "nokogiri"
42
43
44
45 If you run bundle cache under C Ruby, bundler will retrieve the version
46 of nokogiri for the "ruby" platform. If you deploy to JRuby and run
47 bundle install, bundler is forced to check to see whether a "java"
48 platformed nokogiri exists.
49
50 Even though the nokogiri gem for the Ruby platform is technically
51 acceptable on JRuby, it has a C extension that does not run on JRuby.
52 As a result, bundler will, by default, still connect to rubygems.org to
53 check whether it has a version of one of your gems more specific to
54 your platform.
55
56 This problem is also not limited to the "java" platform. A similar
57 (common) problem can happen when developing on Windows and deploying to
58 Linux, or even when developing on OSX and deploying to Linux.
59
60 If you know for sure that the gems packaged in vendor/cache are appro‐
61 priate for the platform you are on, you can run bundle install --local
62 to skip checking for more appropriate gems, and use the ones in ven‐
63 dor/cache.
64
65 One way to be sure that you have the right platformed versions of all
66 your gems is to run bundle cache on an identical machine and check in
67 the gems. For instance, you can run bundle cache on an identical stag‐
68 ing box during your staging process, and check in the vendor/cache
69 before deploying to production.
70
71 By default, bundle cache(1) bundle-cache.1.html fetches and also
72 installs the gems to the default location. To package the dependencies
73 to vendor/cache without installing them to the local install location,
74 you can run bundle cache --no-install.
75
76
77
78 January 2020 BUNDLE-CACHE(1)