blob: 43758b70c05ce2259db8610126cd2e69dcd57982 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
<!DOCTYPE html>
<html>
<head>
<title>Bundler: The best way to manage a Ruby application's gems</title>
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
<link href='/images/favicon.png' rel='shortcut icon' type='image/png'>
<link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />
<link href="/stylesheets/sunburst.css" media="screen" rel="stylesheet" type="text/css" />
</head>
<body>
<div id='body'>
<div id='contents'>
<div id='header'>
<a href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" />
</a>
</div>
<h2>bundle install</h2>
<div class='contents'>
<div class='bullet'>
<div class='description'>
Make sure all dependencies in your Gemfile are available to your application.
</div>
<pre class='sunburst'>$ bundle install [--binstubs=PATH] [--clean] [--deployment] [--frozen]
 [--full-index] [--gemfile=FILE] [--local] [--no-cache]
 [--no-prune] [--path=PATH] [--quiet] [--shebang=STRING]
 [--standalone=ARRAY] [--system] [--without=GROUP GROUP]</pre>
<div class='notes'>
<p>
Options:
</p>
<p>
<code>--binstubs</code>: Generate bin stubs for bundled gems to ./bin
</p>
<p>
<code>--clean</code>: Run bundle clean automatically after install
</p>
<p>
<code>--deployment</code>: Install using defaults tuned for deployment environments
</p>
<p>
<code>--frozen</code>: Do not allow the Gemfile.lock to be updated after this install
</p>
<p>
<code>--full-index</code>: Use the rubygems modern index instead of the API endpoint
</p>
<p>
<code>--gemfile</code>: Use the specified gemfile instead of Gemfile
</p>
<p>
<code>--local</code>: Do not attempt to fetch gems remotely and use the gem cache instead
</p>
<p>
<code>--no-cache</code>: Don't update the existing gem cache.
</p>
<p>
<code>--no-prune</code>: Don't remove stale gems from the cache.
</p>
<p>
<code>--path</code>: Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME). Bundler will remember this value for future installs on this machine
</p>
<p>
<code>--quiet</code>: Only output warnings and errors.
</p>
<p>
<code>--shebang</code>: Specify a different shebang executable name than the default (usually 'ruby')
</p>
<p>
<code>--standalone</code>: Make a bundle that can work without the Bundler runtime
</p>
<p>
<code>--system</code>: Install to the system location ($BUNDLE_PATH or $GEM_HOME) even if the bundle was previously installed somewhere else for this application
</p>
<p>
<code>--without</code>: Exclude gems that are part of the specified named group.
</p>
</div>
<div class='notes'>
<p>
Gems will be installed to your default system location for gems. If your
system gems are stored in a root-owned location (such as in Mac OSX),
bundle will ask for your root password to install them there.
</p>
<p>
While installing gems, Bundler will check <code>vendor/cache</code> and then
your system's gems. If a gem isn't cached or installed, Bundler will try to
install it from the sources you have declared in your Gemfile.
</p>
<p>
The <code>--system</code> option is the default. Pass it to switch back after
using the <code>--path</code> option as described below.
</p>
</div>
</div>
<div class='bullet' id='path'>
<div class='description'>
Install your dependencies, even gems that are already installed
to your system gems, to a location other than your system's gem
repository. In this case, install them to <code>vendor/bundle</code>.
</div>
<div class='how'>
<pre class='sunburst'>$ bundle install --path vendor/bundle</pre>
<div class='notes'>
Further <code>bundle</code> commands or calls to <code>Bundler.setup</code> or
<code>Bundler.require</code> will remember this location.
</div>
<a href="/v1.3/bundler_setup.html">Learn More: Bundler.setup</a>
<a href="/v1.3/groups.html">Learn More: Bundler.require</a>
</div>
</div>
<div class='bullet' id='without'>
<div class='description'>
Install all dependencies except those in groups that are explicitly excluded.
</div>
<pre class='sunburst'>$ bundle install --without development test</pre>
<a href="/v1.3/groups.html">Learn More: Groups</a>
</div>
<div class='bullet' id='deployment'>
<div class='description'>
Install all dependencies on to a production server.
Do <b>not</b> use this flag on a development machine.
</div>
<pre class='sunburst'>$ bundle install --deployment</pre>
<div class='notes'>
<p>
The <code>--deployment</code> flag activates a number of deployment-friendly
conventions:
</p>
<ul>
<li>Isolate all gems into <code>vendor/bundle</code></li>
<li>Require an up-to-date <code>Gemfile.lock</code></li>
<li>
If <code>bundle package</code> was run, do not fetch gems
from rubygems.org. Instead, only use gems in the checked
in <code>vendor/cache</code>
</li>
</ul>
</div>
<a href="/v1.3/deploying.html">Learn More: Deploying</a>
</div>
<div class='bullet' id='binstubs'>
<div class='description'>
(Example with --binstubs TBD)
</div>
</div>
<div class='bullet' id='clean'>
<div class='description'>
(Example with --clean TBD)
</div>
</div>
<div class='bullet' id='frozen'>
<div class='description'>
(Example with --frozen TBD)
</div>
</div>
<div class='bullet' id='full-index'>
<div class='description'>
(Example with --full-index TBD)
</div>
</div>
<div class='bullet' id='gemfile'>
<div class='description'>
(Example with --gemfile TBD)
</div>
</div>
<div class='bullet' id='local'>
<div class='description'>
(Example with --local TBD)
</div>
</div>
<div class='bullet' id='no-cache'>
<div class='description'>
(Example with --no-cache TBD)
</div>
</div>
<div class='bullet' id='no-prune'>
<div class='description'>
(Example with --no-prune TBD)
</div>
</div>
<div class='bullet' id='quiet'>
<div class='description'>
(Example with --quiet TBD)
</div>
</div>
<div class='bullet' id='shebang'>
<div class='description'>
(Example with --shebang TBD)
</div>
</div>
<div class='bullet' id='standalone'>
<div class='description'>
(Example with --standalone TBD)
</div>
</div>
<div class='bullet' id='system'>
<div class='description'>
(Example with --system TBD)
</div>
</div>
</div>
</div>
</div>
<div id='footer'>
<img src="/images/emocow.png" />
<img src="/images/panda.jpg" />
<div class='spacer'></div>
<div id='navigation'>
<p>
<b><a href="/v1.3/commands.html">commands</a></b>
<a href="/v1.3/bundle_install.html">install</a>
/
<a href="/v1.3/bundle_update.html">update</a>
/
<a href="/v1.3/bundle_exec.html">exec</a>
/
<a href="/v1.3/bundle_config.html">config</a>
/
<a href="/v1.3/bundle_package.html">package</a>
</p>
<p>
<b>usage</b>
<a href="/v1.3/gemfile.html">gemfile</a>
/
<a href="/v1.3/git.html">git</a>
/
<a href="/v1.3/groups.html">groups</a>
/
<a href="/v1.3/bundler_setup.html">setup</a>
/
<a href="/v1.3/deploying.html">deploying</a>
</p>
<p>
<b>frameworks</b>
<a href="/v1.3/bundler_setup.html">ruby</a>
/
<a href="/v1.3/rubygems.html">rubygems</a>
/
<a href="/v1.3/rubymotion.html">rubymotion</a>
/
<a href="/v1.3/sinatra.html">sinatra</a>
/
<a href="/v1.3/rails3.html">rails 3</a>
</p>
</div>
<div class='spacer'></div>
<img src="/images/bundler-small.png" />
</div>
<div id='credits'>
<p>
Many thanks to Bundler's <a href="/contributors.html">contributors</a>
and <a href="/sponsors.html">sponsors</a>
</p>
</div>
<a href='http://github.com/carlhuda/bundler/' id='github'>
<img alt='Fork me on GitHub' src='http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png'>
</a>
<div id='prod-versions'>
Docs:
<a href="/v0.9/">v0.9</a>
<a href="/v1.0/">v1.0</a>
<a href="/v1.1/">v1.1</a>
<a href="/v1.2/">v1.2</a>
<a class="current" href="/">v1.3</a>
</div>
<script>
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-557621-9']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>
|
