summaryrefslogtreecommitdiff
path: root/man/bundle-binstubs.ronn
blob: 11be49c72e9530202e9aca827660b1d3525cefb1 (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
bundle-binstubs(1) -- Install the binstubs of the listed gems
=============================================================

## SYNOPSIS

`bundle binstubs` <GEM_NAME> [--force] [--path PATH] [--standalone]

## DESCRIPTION

Binstubs are scripts that wrap aroung executables. Bundler creates a 
small Ruby file (a binstub) that loads Bundler, runs the command, 
and puts it into `bin/`. Binstubs are a shortcut—or alternative—
to always using `bundle exec`, with the additional benefit of linking 
the binstub inside of an application to the exact version of the gem the
application needs.

For example, if you run `bundle binstubs rspec-core`, Bundler will create 
the file `bin/rspec`. That file will contain just enough code to load Bundler, 
tell it to load the bundled gems, and then run rspec.

This command generates binstubs for executables in `GEM_NAME`.
Binstubs are put into `bin`, or the `--path` directory if one has been set.
Calling binstubs with [GEM [GEM]] will create binstubs for all given gems.

## OPTIONS

* `--force`:
  Overwrite existing binstubs if they exist.

* `--path`:
  The location to install the specified binstubs to. This defaults to `bin`.

* `--standalone`:
  Makes binstubs that can work without depending on Rubygems or Bundler at
  runtime.

## BUNDLE INSTALL --BINSTUBS

To create binstubs for all the gems in the bundle you can use the `--binstubs`
flag in [bundle install(1)][bundle-install].