3 This plugin adds completion for basic bundler commands, as well as aliases and helper functions for
4 an easier experience with bundler.
6 To use it, add `bundler` to the plugins array in your zshrc file:
14 | Alias | Command | Description |
15 |--------|--------------------------------------|------------------------------------------------------------------------------------------|
16 | `ba` | `bundle add` | Add gem to the Gemfile and run bundle install |
17 | `bck` | `bundle check` | Verifies if dependencies are satisfied by installed gems |
18 | `bcn` | `bundle clean` | Cleans up unused gems in your bundler directory |
19 | `be` | `bundle exec` | Execute a command in the context of the bundle |
20 | `bi` | `bundle install --jobs=<core_count>` | Install the dependencies specified in your Gemfile (using all cores in bundler >= 1.4.0) |
21 | `bl` | `bundle list` | List all the gems in the bundle |
22 | `bo` | `bundle open` | Opens the source directory for a gem in your bundle |
23 | `bout` | `bundle outdated` | List installed gems with newer versions available |
24 | `bp` | `bundle package` | Package your needed .gem files into your application |
25 | `bu` | `bundle update` | Update your gems to the latest available versions |
29 The plugin adds a wrapper for common gems, which:
31 - Looks for a binstub under `./bin/` and executes it if present.
32 - Calls `bundle exec <gem>` otherwise.
34 Common gems wrapped by default (by name of the executable):
36 `annotate`, `cap`, `capify`, `cucumber`, `foodcritic`, `guard`, `hanami`, `irb`, `jekyll`, `kitchen`, `knife`, `middleman`, `nanoc`, `pry`, `puma`, `rackup`, `rainbows`, `rake`, `rspec`, `rubocop`, `shotgun`, `sidekiq`, `spec`, `spork`, `spring`, `strainer`, `tailor`, `taps`, `thin`, `thor`, `unicorn` and `unicorn_rails`.
40 You can add or remove gems from the list of wrapped commands.
41 Please **use the exact name of the executable** and not the gem name.
43 #### Include gems to be wrapped (`BUNDLED_COMMANDS`)
45 Add this before the plugin list in your `.zshrc`:
48 BUNDLED_COMMANDS=(rubocop)
49 plugins=(... bundler ...)
52 This will add the wrapper for the `rubocop` gem (i.e. the executable).
54 #### Exclude gems from being wrapped (`UNBUNDLED_COMMANDS`)
56 Add this before the plugin list in your `.zshrc`:
59 UNBUNDLED_COMMANDS=(foreman spin)
60 plugins=(... bundler ...)
63 This will exclude the `foreman` and `spin` gems (i.e. their executable) from being wrapped.
67 These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/ohmyzsh/ohmyzsh/pull/2923) on GitHub for clarification: