Plugins

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
• gem-ctags
• gem_info
• gem-init
• gem-man
• gem-orphan
• gem-toolbox
• graph
• maven-gem
• open-gem
• PushSafety
• rbenv-rehash
• rubygems-desc
• rubygems-sandbox
• rubygems_snapshot

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

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.

gem_info

https://github.com/oggy/gem_info

Adds a gem info command with fuzzy matching on name and version. Designed for scripting use.

gem-init

https://github.com/mwhuss/gem-init

Adds gem init to create a barebones gem.

gem-man

https://github.com/defunkt/gem-man

The gem man command lets you view a gem’s man page.

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.

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

graph

https://github.com/seattlerb/graph

Adds a gem graph command to output a gem dependency graph in graphviz’s dot format.

maven_gem

https://github.com/jruby/maven_gem

Adds gem maven to install any Maven-published Java library as though it were a gem.

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

PushSafety

https://github.com/jdleesmiller/push_safety

Applies a whitelist to gem push to prevent accidentally pushing private gems to the public RubyGems repository.

rbenv-rehash

https://github.com/scoz/rbenv-rehash

Automatically runs rbenv rehash after installing or uninstalling gems.

rubygems-desc

https://github.com/chad/rubygems-desc

Adds gem desc to describe a gem by name.

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.

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.