bundle - Man Page
Ruby Dependency Management
Examples (TL;DR)
- Install all gems defined in the
Gemfile
expected in the working directory:bundle install
- Execute a command in the context of the current bundle:
bundle exec command arguments
- Update all gems by the rules defined in the
Gemfile
and regenerateGemfile.lock
:bundle update
- Update one or more specific gem(s) defined in the
Gemfile
:bundle update gem_name1 gem_name2
- Update one or more specific gems(s) defined in the
Gemfile
but only to the next patch version:bundle update --patch gem_name1 gem_name2
- Update all gems within the given group in the
Gemfile
:bundle update --group development
- List installed gems in the
Gemfile
with newer versions available:bundle outdated
- Create a new gem skeleton:
bundle gem gem_name
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 https://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.html
Install the gems specified by the Gemfile or Gemfile.lock
- bundle update(1) bundle-update.1.html
Update dependencies to their latest versions
- bundle cache(1) bundle-cache.1.html
Package the .gem files required by your application into the vendor/cache directory (aliases: bundle package, bundle pack)
- bundle exec(1) bundle-exec.1.html
Execute a script in the current bundle
- bundle config(1) bundle-config.1.html
Specify and read configuration options for Bundler
- bundle help(1) bundle-help.1.html
Display detailed help for each subcommand
Utilities
- bundle add(1) bundle-add.1.html
Add the named gem to the Gemfile and run bundle install
- bundle binstubs(1) bundle-binstubs.1.html
Generate binstubs for executables in a gem
- bundle check(1) bundle-check.1.html
Determine whether the requirements for your application are installed and available to Bundler
- bundle show(1) bundle-show.1.html
Show the source location of a particular gem in the bundle
- bundle outdated(1) bundle-outdated.1.html
Show all of the outdated gems in the current bundle
- bundle console(1) (deprecated)
Start an IRB session in the current bundle
- bundle open(1) bundle-open.1.html
Open an installed gem in the editor
- bundle lock(1) bundle-lock.1.html
Generate a lockfile for your dependencies
- bundle viz(1) bundle-viz.1.html (deprecated)
Generate a visual representation of your dependencies
- bundle init(1) bundle-init.1.html
Generate a simple Gemfile, placed in the current directory
- bundle gem(1) bundle-gem.1.html
Create a simple gem, suitable for development with Bundler
- bundle platform(1) bundle-platform.1.html
Display platform compatibility information
- bundle clean(1) bundle-clean.1.html
Clean up unused gems in your Bundler directory
- bundle doctor(1) bundle-doctor.1.html
Display warnings about common problems
- bundle remove(1) bundle-remove.1.html
Removes gems from the Gemfile
- bundle plugin(1) bundle-plugin.1.html
Manage Bundler plugins
- bundle version(1) bundle-version.1.html
Prints Bundler version information
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 inject(1)