# salt.modules.rvm

Manage ruby installations and gemsets with RVM, the Ruby Version Manager.

`salt.modules.rvm.` `do`(ruby, command, runas=None)

  Execute a command in an RVM controlled environment.

  ruby:
    The ruby to use.
  command:
    The command to execute.
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.do 2.0.0 <command>

`salt.modules.rvm.` `gemset_copy`(source, destination, runas=None)

  Copy all gems from one gemset to another.

  source
    The name of the gemset to copy, complete with ruby version.
  destination
    The destination gemset.
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.gemset_copy foobar bazquo

`salt.modules.rvm.` `gemset_create`(ruby, gemset, runas=None)

  Creates a gemset.

  ruby
    The ruby version to create the gemset for.
  gemset
    The name of the gemset to create.
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.gemset_create 2.0.0 foobar

`salt.modules.rvm.` `gemset_delete`(ruby, gemset, runas=None)

  Deletes a gemset.

  ruby
    The ruby version the gemset belongs to.
  gemset
    The gemset to delete.
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.gemset_delete 2.0.0 foobar

`salt.modules.rvm.` `gemset_empty`(ruby, gemset, runas=None)

  Remove all gems from a gemset.

  ruby
    The ruby version the gemset belongs to.
  gemset
    The gemset to empty.
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.gemset_empty 2.0.0 foobar

`salt.modules.rvm.` `gemset_list`(ruby='default', runas=None)

  List all gemsets for the given ruby.

  ruby : default
    The ruby version to list the gemsets for
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.gemset_list

`salt.modules.rvm.` `gemset_list_all`(runas=None)

  List all gemsets for all installed rubies.

  Note that you must have set a default ruby before this can work.

  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.gemset_list_all

`salt.modules.rvm.` `get`(version='stable', runas=None)

  Update RVM.

  version : stable
    Which version of RVM to install, e.g. stable or head.
  ruby
    The version of ruby to reinstall.

  CLI Example:

      salt '*' rvm.get

`salt.modules.rvm.` `install`(runas=None)

  Install RVM system wide.

  CLI Example:

      salt '*' rvm.install

`salt.modules.rvm.` `install_ruby`(ruby, runas=None)

  Install a ruby implementation.

  ruby
    The version of ruby to install.
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.install_ruby 1.9.3-p385

`salt.modules.rvm.` `is_installed`(runas=None)

  Check if RVM is installed.

  CLI Example:

      salt '*' rvm.is_installed

`salt.modules.rvm.` `list_`(runas=None)

  List all rvm installed rubies.

  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.list

`salt.modules.rvm.` `reinstall_ruby`(ruby, runas=None)

  Reinstall a ruby implementation.

  ruby
    The version of ruby to reinstall.
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.reinstall_ruby 1.9.3-p385

`salt.modules.rvm.` `rubygems`(ruby, version, runas=None)

  Installs a specific rubygems version in the given ruby.

  ruby
    The ruby to install rubygems for.
  version
    The version of rubygems to install or 'remove' to use the version that ships with 1.9
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.rubygems 2.0.0 1.8.24

`salt.modules.rvm.` `set_default`(ruby, runas=None)

  Set the default ruby.

  ruby
    The version of ruby to make the default.
  runas : None
    The user to run rvm as.

  CLI Example:

      salt '*' rvm.set_default 2.0.0

`salt.modules.rvm.` `wrapper`(ruby_string, wrapper_prefix, runas=None, *binaries)

  Install RVM wrapper scripts.

  ruby_string
    Ruby/gemset to install wrappers for.
  wrapper_prefix
    What to prepend to the name of the generated wrapper binaries.
  runas : None
    The user to run rvm as.
  binaries : None
    The names of the binaries to create wrappers for. When nothing is given, wrappers for ruby, gem, rake, irb, rdoc, ri and testrb are generated.

  CLI Example:

      salt '*' rvm.wrapper <ruby_string> <wrapper_prefix>

Current Salt release: 0.17.1

#### Previous topic

salt.modules.rpm

#### Next topic

salt.modules.s3

### Quick search

Enter search terms or a module, class or function name.

### Upcoming SaltStack Events

My conferences on Lanyrd