forked from rubygems/guides
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Mike Gunderloy
authored and
Mike Gunderloy
committed
Jan 11, 2012
1 parent
cd37ab2
commit afb9dae
Showing
3 changed files
with
152 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
--- | ||
layout: default | ||
title: Plugins | ||
previous: /faqs | ||
next: / | ||
--- | ||
|
||
As of RubyGems 1.3.2, RubyGems will load plugins installed in gems or $LOAD\_PATH. Plugins must be named 'rubygems\_plugin' (.rb, .so, etc) and placed at the root of your gem's #require\_path. Plugins are discovered via Gem::find\_files then loaded. Take care when implementing a plugin as your plugin file may be loaded multiple times if multiple versions of your gem are installed. | ||
|
||
The following list of RubyGems plugins is probably not exhaustive. If you know of plugins that we missed, feel free to update this page. | ||
|
||
* [gem-browse](#gembrowse) | ||
* [gem-ctags](#gemctags) | ||
* [gem_info](#geminfo) | ||
* [gem-init](#geminit) | ||
* [gem-man](#gemman) | ||
* [gem-orphan](#gemorphan) | ||
* [gem-toolbox](#gemtoolbox) | ||
* [graph](#graph) | ||
* [maven-gem](#mavengem) | ||
* [open-gem](#opengem) | ||
* [PushSafety](#pushsafety) | ||
* [rbenv-rehash](#rbenvrehash) | ||
* [rubygems-desc](#rubygemsdesc) | ||
* [rubygems-sandbox](#rubygemssandbox) | ||
* [rubygems_snapshot](#rubygemssnapshot) | ||
|
||
<a id="gembrowse"> </a> | ||
## gem-browse | ||
|
||
[https://github.com/tpope/gem-browse](https://github.com/tpope/gem-browse) | ||
|
||
Adds four commands: | ||
|
||
- `gem edit` opens a gem in your editor | ||
- `gem open` opens a gem by name in your editor | ||
- `gem clone` clones a gem from GitHub | ||
- `gem browse` opens a gem's homepage in your browser | ||
|
||
<a id="gemctags"> </a> | ||
## gem-ctags | ||
|
||
[https://github.com/tpope/gem-ctags](https://github.com/tpope/gem-ctags) | ||
|
||
Adds a `gem ctags` command to invoke the Exuberant Ctags indexer on already-installed gems, and then automatically invokes it on gems as they are installed. | ||
|
||
<a id="geminfo"> </a> | ||
## gem_info | ||
|
||
[https://github.com/oggy/gem_info](https://github.com/oggy/gem_info) | ||
|
||
Adds a `gem info` command with fuzzy matching on name and version. Designed for scripting use. | ||
|
||
<a id="geminit"> </a> | ||
## gem-init | ||
|
||
[https://github.com/mwhuss/gem-init](https://github.com/mwhuss/gem-init) | ||
|
||
Adds `gem init` to create a barebones gem. | ||
|
||
<a id="gemman"> </a> | ||
## gem-man | ||
|
||
[https://github.com/defunkt/gem-man](https://github.com/defunkt/gem-man) | ||
|
||
The `gem man` command lets you view a gem's man page. | ||
|
||
<a id="gemorphan"> </a> | ||
## gem-orphan | ||
|
||
[https://github.com/sakuro/gem-orphan](https://github.com/sakuro/gem-orphan) | ||
|
||
Adds a `gem orphan` command that finds and lists gems on which no other gems are depending. | ||
|
||
<a id="gemtoolbox"> </a> | ||
## gem-toolbox | ||
|
||
[https://github.com/gudleik/gem-toolbox](https://github.com/gudleik/gem-toolbox) | ||
|
||
Adds six commands: | ||
|
||
- `gem open` - opens a gem in your default editor | ||
- `gem cd` - changes your working directory to the gem's source root | ||
- `gem readme` - locates and displays a gem's readme file | ||
- `gem history` - locates and display's a gem's changelog | ||
- `gem doc` - Browse a gem's documentation in your default browser | ||
- `gem visit` - Open a gem's homepage in your default browser | ||
|
||
<a id="graph"> </a> | ||
## graph | ||
|
||
[https://github.com/seattlerb/graph](https://github.com/seattlerb/graph) | ||
|
||
Adds a `gem graph` command to output a gem dependency graph in graphviz's dot format. | ||
|
||
<a id="mavengem"> </a> | ||
## maven_gem | ||
|
||
[https://github.com/jruby/maven_gem](https://github.com/jruby/maven_gem) | ||
|
||
Adds `gem maven` to install any Maven-published Java library as though it were a gem. | ||
|
||
<a id="opengem"> </a> | ||
## open_gem | ||
|
||
[https://github.com/adamsanderson/open_gem](https://github.com/adamsanderson/open_gem) | ||
|
||
Adds two commands: | ||
|
||
- `gem open` opens a gem in your default editor | ||
- `gem read` opens a gem's rdoc in your default browser | ||
|
||
<a id="pushsafety"> </a> | ||
## PushSafety | ||
|
||
[https://github.com/jdleesmiller/push_safety](https://github.com/jdleesmiller/push_safety) | ||
|
||
Applies a whitelist to `gem push` to prevent accidentally pushing private gems to the public RubyGems repository. | ||
|
||
<a id="rbenvrehash"> </a> | ||
## rbenv-rehash | ||
|
||
[https://github.com/scoz/rbenv-rehash](https://github.com/scoz/rbenv-rehash) | ||
|
||
Automatically runs `rbenv rehash` after installing or uninstalling gems. | ||
|
||
<a id="rubygemsdesc"> </a> | ||
## rubygems-desc | ||
|
||
[https://github.com/chad/rubygems-desc](https://github.com/chad/rubygems-desc) | ||
|
||
Adds `gem desc` to describe a gem by name. | ||
|
||
<a id="rubygemssandbox"> </a> | ||
## rubygems-sandbox | ||
|
||
[https://github.com/seattlerb/rubygems-sandbox](https://github.com/seattlerb/rubygems-sandbox) | ||
|
||
Manages command-line gem tools and dependencies with a `gem sandbox` command. This lets you install things like flay and rdoc outside of the global rubygems repository. | ||
|
||
<a id="rubygemssnapshot"> </a> | ||
## rubygems_snapshot | ||
|
||
[https://github.com/rogerleite/rubygems_snapshot](https://github.com/rogerleite/rubygems_snapshot) | ||
|
||
Adds `gem snapshot` to create exports of all your current gems into a single file that you can import later. |