Ruby gems can optionally install executable files. When you run <gem_name> --help
, you're generally running the script, if any, installed by that gem, and passing it --help
as a commandline parameter. By convention, most gems with executables support this parameter and output some useful information, but it's not a requirement - and, as mentioned, there are plenty of gems that don't install any executables at all.
In this case, it appears that the gem you installed doesn't provide any scripts (or, at the very least, doesn't provide any scripts with the same name as the gem). As others have suggested, looking at the rdoc for the gem might be a good way to start; you can use the gem server
command to serve up all your local gems' rdoc content. Alternately, some gems host their rdoc at Rubyforge.
What is the gem in question?