summaryrefslogtreecommitdiff
path: root/commands.html
blob: 30b04db575fc58711480117432bfcbc4eb59355e (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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
<!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'>
    <meta content='276VSYOko8B8vIu1i8i5qbj7_ql5PXo0dU69XQy-SL' name='globalsign-domain-verification'>
    <link href='/images/favicon.png' rel='shortcut icon' type='image/png'>
    <link href="/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />
  </head>
  <body>
    <div id='body'>
      <div id='header'>
        <a class="image" href="/"><img width="725" alt="The best way to manage your application's dependencies" src="/images/gembundler.png" /></a>
      </div>
      <div id='container'>
        <div id='contents'>
          <h2>Command Line Reference</h2>
          <div id='command_reference'>
            <table cellspacing='0'>
              <tr>
                <th>
                  command
                </th>
                <th>
                  applicable options
                </th>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_check.html">bundle check</a>
                  </div>
                  <div class='cli_desc'>
                    Checks if the dependencies listed in Gemfile are satisfied by currently installed gems
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_check.html#gemfile">--gemfile</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_check.html#path">--path</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_clean.html">bundle clean</a>
                  </div>
                  <div class='cli_desc'>
                    Cleans up unused gems in your bundler directory
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_clean.html#force">--force</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_config.html">bundle config</a>
                  </div>
                  <div class='cli_desc'>
                    Retrieve or set a configuration value
                  </div>
                </td>
                <td>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_console.html">bundle console</a>
                  </div>
                  <div class='cli_desc'>
                    Opens an IRB session with the bundle pre-loaded
                  </div>
                </td>
                <td>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_exec.html">bundle exec</a>
                  </div>
                  <div class='cli_desc'>
                    Run the command in context of the bundle
                  </div>
                </td>
                <td>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_gem.html">bundle gem</a>
                  </div>
                  <div class='cli_desc'>
                    Creates a skeleton for creating a rubygem
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_gem.html#bin">--bin or -b</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_help.html">bundle help</a>
                  </div>
                  <div class='cli_desc'>
                    Displays detailed help for each subcommand
                  </div>
                </td>
                <td>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_init.html">bundle init</a>
                  </div>
                  <div class='cli_desc'>
                    Generates a Gemfile into the current working directory
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_init.html#gemspec">--gemspec</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_install.html">bundle install</a>
                  </div>
                  <div class='cli_desc'>
                    Install the current environment to the system
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#binstubs">--binstubs</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#clean">--clean</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#deployment">--deployment</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#frozen">--frozen</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#full-index">--full-index</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#gemfile">--gemfile</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#local">--local</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#no-cache">--no-cache</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#no-prune">--no-prune</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#path">--path</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#quiet">--quiet</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#shebang">--shebang</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#standalone">--standalone</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#system">--system</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_install.html#without">--without</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_open.html">bundle open</a>
                  </div>
                  <div class='cli_desc'>
                    Opens the source directory of the given bundled gem
                  </div>
                </td>
                <td>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_outdated.html">bundle outdated</a>
                  </div>
                  <div class='cli_desc'>
                    List installed gems with newer versions available
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_outdated.html#local">--local</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_outdated.html#pre">--pre</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_outdated.html#source">--source</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_package.html">bundle package</a>
                  </div>
                  <div class='cli_desc'>
                    Locks and then caches all of the gems into vendor/cache
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_package.html#no-prune">--no-prune</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_package.html#all">--all</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_platform.html">bundle platform</a>
                  </div>
                  <div class='cli_desc'>
                    Displays platform compatibility information
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_platform.html#ruby">--ruby</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_show.html">bundle show</a>
                  </div>
                  <div class='cli_desc'>
                    Shows all gems that are part of the bundle, or the path to a given gem
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_show.html#paths">--paths</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_update.html">bundle update</a>
                  </div>
                  <div class='cli_desc'>
                    Update the current environment
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_update.html#local">--local</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_update.html#source">--source</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_version.html">bundle version</a>
                  </div>
                  <div class='cli_desc'>
                    Prints version information
                  </div>
                </td>
                <td>
                  <div class='clear'></div>
                </td>
              </tr>
              <tr>
                <td>
                  <div class='cli_name'>
                    <a href="/bundle_viz.html">bundle viz</a>
                  </div>
                  <div class='cli_desc'>
                    Generates a visual dependency graph
                  </div>
                </td>
                <td>
                  <div class='cli_option'>
                    <a href="/bundle_viz.html#file">--file or -f</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_viz.html#format">--format or -F</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_viz.html#requirements">--requirements or -r</a>
                  </div>
                  <div class='cli_option'>
                    <a href="/bundle_viz.html#version">--version or -v</a>
                  </div>
                  <div class='clear'></div>
                </td>
              </tr>
            </table>
          </div>
        </div>
        <div id='sidebar'>
          <h2>Would you like to</h2>
          <ul>
            <li><a href="/#getting-started">Get started</a></li>
            <li><a href="/issues.html">Report a bug</a></li>
            <li><a href="/v1.6/whats_new.html">See what's new</a></li>
            <li><a href="/v1.6/man/bundle.1.html">Read documentation</a></li>
            <li><a href="/#get-involved">Discuss and Contribute</a></li>
            <li><a href="/v1.6/faq.html">View FAQs</a></li>
          </ul>
          <div class='shirts'>
            <div class='content'>
              <p>
                Bundler is developed entirely by a team of volunteers.
                <a href="http://www.gittip.com/bundler">Support their work</a>
                and help make Bundler better for everyone.
              </p>
              <p>
                <script data-gittip-username='bundler' src='//gttp.co/v1.js'></script>
                <br>
                <br>
              </p>
            </div>
          </div>
          <h2>Bundler Commands</h2>
          <ul>
            <li><a href="/v1.6/bundle_install.html">bundle install</a></li>
            <li><a href="/v1.6/bundle_update.html">bundle update</a></li>
            <div class='buttons'>
              <a href="/v1.6/commands.html">View all commands</a>
            </div>
          </ul>
          <h2>Help With</h2>
          <ul>
            <li><a href="/v1.6/gemfile.html">Gemfiles</a></li>
            <li><a href="/v1.6/groups.html">Groups</a></li>
            <li><a href="/v1.6/git.html">Gems from git</a></li>
            <li><a href="/v1.6/bundler_setup.html">Bundler.setup</a></li>
            <li><a href="/v1.6/deploying.html">Deploying</a></li>
            <li><a href="/v1.6/bundler_sharing.html">Sharing</a></li>
            <li><a href="/v1.6/updating_gems.html">Updating Gems</a></li>
            <li><a href="/compatibility.html">Compatible versions</a></li>
          </ul>
          <h2>Use Bundler with</h2>
          <ul>
            <li><a href="/v1.6/rails3.html">Rails 3</a></li>
            <li><a href="/v1.6/rails23.html">Rails 2.3</a></li>
            <li><a href="/v1.6/sinatra.html">Sinatra</a></li>
            <li><a href="/v1.6/rubygems.html">Rubygems</a></li>
            <li><a href="/v1.6/rubymotion.html">RubyMotion</a></li>
          </ul>
          <div class='shirts'>
            <div class='content'>
                            <a class="image" onclick="ga('send', 'devswag');" href="http://www.devswag.com/collections/bundler"><img src="/images/bundler-shirt.png" />
              </a>

              <p>
                <a onclick="ga('send', 'devswag');" href="http://www.devswag.com/collections/bundler">Buy Bundler Shirts & Stickers!</a>
              </p>
            </div>
          </div>
        </div>
      </div>
    </div>
    <div id='footer'>
      <img src="/images/emocow.png" />
      <img src="/images/panda.jpg" />
      <div class='spacer'></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>
      <div class='spacer'></div>
      <img src="/images/bundler-small.png" />
    </div>
    <a href='http://github.com/bundler/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 href="/v1.3/">v1.3</a>
      <a href="/v1.5/index.html">v1.5</a>
      <a class="current" href="/">v1.6</a>
    </div>
    <script>
      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
      ga('create', 'UA-39559982-1', 'bundler.io');
      ga('send', 'pageview');
    </script>
  </body>
</html>