mirror of
https://github.com/ruby/ruby.git
synced 2025-08-24 05:25:34 +02:00
da3c47bcfc
- The `bundle plugin uninstall --all` was missing.
- The `bundle plugin install --local-git` was missing due to being
deprecated. We decided to reintroduce the doc for more clarity.
4da252945c
71 lines
2.1 KiB
Markdown
71 lines
2.1 KiB
Markdown
bundle-plugin(1) -- Manage Bundler plugins
|
|
==========================================
|
|
|
|
## SYNOPSIS
|
|
|
|
`bundle plugin` install PLUGINS [--source=<SOURCE>] [--version=<version>]
|
|
[--git=<git-url>] [--branch=<branch>|--ref=<rev>]
|
|
[--path=<path>]<br>
|
|
`bundle plugin` uninstall PLUGINS [--all]<br>
|
|
`bundle plugin` list<br>
|
|
`bundle plugin` help [COMMAND]
|
|
|
|
## DESCRIPTION
|
|
|
|
You can install, uninstall, and list plugin(s) with this command to extend functionalities of Bundler.
|
|
|
|
## SUB-COMMANDS
|
|
|
|
### install
|
|
|
|
Install the given plugin(s).
|
|
|
|
* `bundle plugin install bundler-graph`:
|
|
Install bundler-graph gem from globally configured sources (defaults to RubyGems.org). The global source, specified in source in Gemfile is ignored.
|
|
|
|
* `bundle plugin install bundler-graph --source https://example.com`:
|
|
Install bundler-graph gem from example.com. The global source, specified in source in Gemfile is not considered.
|
|
|
|
* `bundle plugin install bundler-graph --version 0.2.1`:
|
|
You can specify the version of the gem via `--version`.
|
|
|
|
* `bundle plugin install bundler-graph --git https://github.com/rubygems/bundler-graph`:
|
|
Install bundler-graph gem from Git repository. You can use standard Git URLs like:
|
|
|
|
`ssh://[user@]host.xz[:port]/path/to/repo.git`<br>
|
|
`http[s]://host.xz[:port]/path/to/repo.git`<br>
|
|
`/path/to/repo`<br>
|
|
`file:///path/to/repo`
|
|
|
|
When you specify `--git`, you can use `--branch` or `--ref` to specify any branch, tag, or commit hash (revision) to use.
|
|
|
|
* `bundle plugin install bundler-graph --path ../bundler-graph`:
|
|
Install bundler-graph gem from a local path.
|
|
|
|
* `bundle plugin install bundler-graph --local-git ../bundler-graph`:
|
|
This option is deprecated in favor of `--git`.
|
|
|
|
### uninstall
|
|
|
|
Uninstall the plugin(s) specified in PLUGINS.
|
|
|
|
**OPTIONS**
|
|
|
|
* `--all`:
|
|
Uninstall all the installed plugins. If no plugin is installed, then it does nothing.
|
|
|
|
### list
|
|
|
|
List the installed plugins and available commands.
|
|
|
|
No options.
|
|
|
|
### help
|
|
|
|
Describe subcommands or one specific subcommand.
|
|
|
|
No options.
|
|
|
|
## SEE ALSO
|
|
|
|
* [How to write a Bundler plugin](https://bundler.io/guides/bundler_plugins.html)
|