The Ruby SDK provides a generic set of wrappers so you can make API calls easily.


If you are logged in to an Arvados VM, the Ruby SDK should be installed.

To use it elsewhere, you can either install the arvados gem via RubyGems or build and install the package using the arvados source tree.

Prerequisites: Ruby >= 2.0.0

You can use RVM to install and manage Ruby versions.

Option 1: install with RubyGems

$ sudo -i gem install arvados

Option 2: build and install from source

$ git clone
$ cd arvados/sdk/ruby
$ gem build arvados.gemspec
$ sudo -i gem install arvados-*.gem

Test installation

If the SDK is installed, ruby -r arvados -e 'puts "OK!"' should produce no errors.

If your ARVADOS_API_HOST and ARVADOS_API_TOKEN environment variables are set up correctly (see api-tokens for details), the following test script should work:

$ ruby -r arvados <<'EOF'
arv = api_version: 'v1'
my_full_name = arv.user.current[:full_name]
puts "arvados.v1.users.current.full_name = '#{my_full_name}'"
arvados.v1.users.current.full_name = 'Your Name'

Previous: Examples Next: Examples

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.