summaryrefslogtreecommitdiff
path: root/man/bundle.ronn
blob: a3a651ba3c1f4b0d9cff56907faaa16602bfef00 (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
bundle(1) -- Ruby Dependency Management
=======================================

## SYNOPSIS

`bundle` COMMAND [--no-color] [--verbose] [ARGS]

## DESCRIPTION

Bundler manages an `application's dependencies` through its entire life
across many machines systematically and repeatably.

See [the bundler website](http://bundler.io) for information on getting
started, and Gemfile(5) for more information on the `Gemfile` format.

## OPTIONS

* `--no-color`:
  Print all output without color

* `--retry`, `-r`:
  Specify the number of times you wish to attempt network commands

* `--verbose`, `-V`:
  Print out additional logging information

## BUNDLE COMMANDS

We divide `bundle` subcommands into primary commands and utilities:

## PRIMARY COMMANDS

* [`bundle install(1)`][bundle-install(1)]:
  Install the gems specified by the `Gemfile` or `Gemfile.lock`

* [`bundle update(1)`][bundle-update(1)]:
  Update dependencies to their latest versions

* [`bundle package(1)`][bundle-package(1)]:
  Package the .gem files required by your application into the
  `vendor/cache` directory

* [`bundle exec(1)`][bundle-exec(1)]:
  Execute a script in the current bundle

* [`bundle config(1)`][bundle-config(1)]:
  Specify and read configuration options for Bundler

* `bundle help(1)`:
  Display detailed help for each subcommand

## UTILITIES

* [`bundle add(1)`][bundle-add(1)]:
  Add the named gem to the Gemfile and run `bundle install`

* [`bundle binstubs(1)`][bundle-binstubs(1)]:
  Generate binstubs for executables in a gem

* [`bundle check(1)`][bundle-check(1)]:
  Determine whether the requirements for your application are installed
  and available to Bundler

* [`bundle show(1)`][bundle-show(1)]:
  Show the source location of a particular gem in the bundle

* [`bundle outdated(1)`][bundle-outdated(1)]:
  Show all of the outdated gems in the current bundle

* `bundle console(1)`:
  Start an IRB session in the current bundle

* [`bundle open(1)`][bundle-open(1)]:
  Open an installed gem in the editor

* [`bundle lock(1)`][bundle-lock]:
  Generate a lockfile for your dependencies

* [`bundle viz(1)`][bundle-viz(1)]:
  Generate a visual representation of your dependencies

* [`bundle init(1)`][bundle-init(1)]:
  Generate a simple `Gemfile`, placed in the current directory

* [`bundle gem(1)`][bundle-gem(1)]:
  Create a simple gem, suitable for development with Bundler

* [`bundle platform(1)`][bundle-platform(1)]:
  Display platform compatibility information

* [`bundle clean(1)`][bundle-clean(1)]:
  Clean up unused gems in your Bundler directory

* `bundle doctor(1)`:
  Display warnings about common problems

## PLUGINS

When running a command that isn't listed in PRIMARY COMMANDS or UTILITIES,
Bundler will try to find an executable on your path named `bundler-<command>`
and execute it, passing down any extra arguments to it.

## OBSOLETE

These commands are obsolete and should no longer be used:

* `bundle cache(1)`
* `bundle show(1)`