Skip to content

Instantly share code, notes, and snippets.

@gvalkov
Created November 10, 2012 04:52
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save gvalkov/4049959 to your computer and use it in GitHub Desktop.
Save gvalkov/4049959 to your computer and use it in GitHub Desktop.
cli
$ gem
RubyGems is a sophisticated package manager for Ruby. This is a
basic help message containing pointers to more information.
Usage:
gem -h/--help
gem -v/--version
gem command [arguments...] [options...]
Examples:
gem install rake
gem list --local
gem build package.gemspec
gem help install
Further help:
gem help commands list all 'gem' commands
gem help examples show some examples of usage
gem help platforms show information about platforms
gem help <COMMAND> show help on COMMAND
(e.g. 'gem help install')
gem server present a web page at
http://localhost:8808/
with info about installed gems
Further information:
http://rubygems.rubyforge.org
$ gem help install
Usage: gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]
Options:
--platform PLATFORM Specify the platform of gem to install
-v, --version VERSION Specify version of gem to install
--[no-]prerelease Allow prerelease versions of a gem
to be installed. (Only for listed gems)
Deprecated Options:
-u, --[no-]update-sources Update local source cache
Install/Update Options:
-i, --install-dir DIR Gem repository directory to get installed
gems
-n, --bindir DIR Directory where binary files are
located
-d, --[no-]rdoc Generate RDoc documentation for the gem on
install
--[no-]ri Generate RI documentation for the gem on
install
-E, --[no-]env-shebang Rewrite the shebang line on installed
scripts to use /usr/bin/env
-f, --[no-]force Force gem to install, bypassing dependency
checks
-w, --[no-]wrappers Use bin wrappers for executables
Not available on dosish platforms
-P, --trust-policy POLICY Specify gem trust policy
--ignore-dependencies Do not install any required dependent gems
-y, --include-dependencies Unconditionally install the required
dependent gems
--[no-]format-executable Make installed executable names match ruby.
If ruby is ruby18, foo_exec will be
foo_exec18
--[no-]user-install Install in user's home directory instead
of GEM_HOME.
--development Install any additional development
dependencies
--conservative Don't attempt to upgrade gems already
meeting version requirement
Local/Remote Options:
-l, --local Restrict operations to the LOCAL domain
-r, --remote Restrict operations to the REMOTE domain
-b, --both Allow LOCAL and REMOTE operations
-B, --bulk-threshold COUNT Threshold for switching to bulk
synchronization (default 1000)
--clear-sources Clear the gem sources
--source URL Add URL as a remote source for gems
-p, --[no-]http-proxy [URL] Use HTTP proxy for remote operations
Common Options:
-h, --help Get help on this command
-V, --[no-]verbose Set the verbose level of output
-q, --quiet Silence commands
--config-file FILE Use this config file instead of default
--backtrace Show stack backtrace on errors
--debug Turn on Ruby debugging
Arguments:
GEMNAME name of gem to install
Summary:
Install a gem into the local repository
Description:
The install command installs local or remote gem into a gem repository.
For gems with executables ruby installs a wrapper file into the executable
directory by default. This can be overridden with the --no-wrappers option.
The wrapper allows you to choose among alternate gem versions using
_version_.
For example `rake _0.7.3_ --version` will run rake version 0.7.3 if a newer
version is also installed.
If an extension fails to compile during gem installation the gem
specification is not written out, but the gem remains unpacked in the
repository. You may need to specify the path to the library's headers and
libraries to continue. You can do this by adding a -- between RubyGems'
options and the extension's build options:
$ gem install some_extension_gem
[build fails]
Gem files will remain installed in \
/path/to/gems/some_extension_gem-1.0 for inspection.
Results logged to /path/to/gems/some_extension_gem-1.0/gem_make.out
$ gem install some_extension_gem -- --with-extension-lib=/path/to/lib
[build succeeds]
$ gem list some_extension_gem
*** LOCAL GEMS ***
some_extension_gem (1.0)
$
If you correct the compilation errors by editing the gem files you will need
to write the specification by hand. For example:
$ gem install some_extension_gem
[build fails]
Gem files will remain installed in \
/path/to/gems/some_extension_gem-1.0 for inspection.
Results logged to /path/to/gems/some_extension_gem-1.0/gem_make.out
$ [cd /path/to/gems/some_extension_gem-1.0]
$ [edit files or what-have-you and run make]
$ gem spec ../../cache/some_extension_gem-1.0.gem --ruby > \
../../specifications/some_extension_gem-1.0.gemspec
$ gem list some_extension_gem
*** LOCAL GEMS ***
some_extension_gem (1.0)
$
Defaults:
--both --version '>= 0' --rdoc --ri --no-force
--install-dir /home/gv/.gem/ruby/1.9.1
$ luarocks help
LuaRocks 2.0.11, a module deployment system for Lua
NAME
luarocks - LuaRocks main command-line interface
SYNOPSIS
luarocks [--from=<server> | --only-from=<server>] [--to=<tree>] [VAR=VALUE]... <command> [<argument>]
GENERAL OPTIONS
These apply to all commands, as appropriate:
--server=<server> Fetch rocks/rockspecs from this server
(takes priority over config file)
--only-server=<server> Fetch rocks/rockspecs from this server only
(overrides any entries in the config file)
--only-sources=<url> Restrict downloads to paths matching the
given URL.
--tree=<tree> Which tree to operate on.
--local Use the tree in the user's home directory.
VARIABLES
Variables from the "variables" table of the configuration file
can be overriden with VAR=VALUE assignments.
COMMANDS
build
Build/compile a rock.
download
Download a specific rock file from a rocks server.
help
Help on commands. Type 'luarocks help <command>' for more.
install
Install a rock.
lint
Check syntax of a rockspec.
list
Lists currently installed rocks.
make
Compile package in current directory using a rockspec.
new_version
Auto-write a rockspec for a new version of a rock.
pack
Create a rock, packing sources or binaries.
path
Return the currently configured package path.
remove
Uninstall a rock.
search
Query the LuaRocks servers.
show
Shows information about an installed rock.
unpack
Unpack the contents of a rock.
CONFIGURATION
System configuration file: /etc/luarocks/config.lua (ok)
User configuration file: /home/gv//.luarocks/config.lua (not found)
LuaRocks 2.0.11, a module deployment system for Lua
$ luarocks help install
NAME
luarocks install - Install a rock.
SYNOPSIS
luarocks install {<rock>|<name> [<version>]}
DESCRIPTION
Argument may be the name of a rock to be fetched from a repository
or a filename of a locally available rock.
SEE ALSO
'luarocks help' for general options and configuration.
$ npm help
Usage: npm <command>
where <command> is one of:
add-user, adduser, apihelp, author, bin, bugs, c, cache,
completion, config, deprecate, docs, edit, explore, faq,
find, get, help, help-search, home, i, info, init, install,
la, link, list, ll, ln, login, ls, outdated, owner, pack,
prefix, prune, publish, r, rb, rebuild, remove, restart, rm,
root, run-script, s, se, search, set, show, shrinkwrap,
star, start, stop, submodule, tag, test, un, uninstall,
unlink, unpublish, unstar, up, update, version, view,
whoami
npm <cmd> -h quick help on <cmd>
npm -l display full usage info
npm faq commonly asked questions
npm help <term> search for help on <term>
npm help npm involved overview
Specify configs in the ini-formatted file:
/home/gv/.npmrc
or on the command line via: npm <command> --key value
Config info can be viewed via: npm help config
$ npm install --help
npm install <tarball file>
npm install <tarball url>
npm install <folder>
npm install <pkg>
npm install <pkg>@<tag>
npm install <pkg>@<version>
npm install <pkg>@<version range>
Can specify one or more: npm install ./foo.tgz bar@stable /some/folder
If no argument is supplied and ./npm-shrinkwrap.json is
present, installs dependencies specified in the shrinkwrap.
Otherwise, installs dependencies from ./package.json.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment