Arvados CLI tools are written in Ruby and Python. To use the arv command, you can either install the arvados-cli gem via RubyGems or build and install the package from source. The arv command also relies on other Arvados tools. To get those, install the arvados-python-client and arvados-cwl-runner packages, either from PyPI or source.

Prerequisites: Ruby, Bundler, and curl libraries

Ruby 2.3 is recommended; Ruby 2.1 is also known to work.

Option 1: Install with RVM

sudo gpg --keyserver hkp:// --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
\curl -sSL | sudo bash -s stable --ruby=2.3

Either log out and log back in to activate RVM, or explicitly load it in all open shells like this:

source /usr/local/rvm/scripts/rvm

Once RVM is activated in your shell, install Bundler:

~$ gem install bundler

Option 2: Install from source

Install prerequisites for Debian 8:

sudo apt-get install \
    bison build-essential gettext libcurl3 libcurl3-gnutls \
    libcurl4-openssl-dev libpcre3-dev libreadline-dev \
    libssl-dev libxslt1.1 zlib1g-dev

Install prerequisites for CentOS 7:

sudo yum install \
    libyaml-devel glibc-headers autoconf gcc-c++ glibc-devel \
    patch readline-devel zlib-devel libffi-devel openssl-devel \
    make automake libtool bison sqlite-devel tar

Install prerequisites for Ubuntu 12.04 or 14.04:

sudo apt-get install \
    gawk g++ gcc make libc6-dev libreadline6-dev zlib1g-dev libssl-dev \
    libyaml-dev libsqlite3-dev sqlite3 autoconf libgdbm-dev \
    libncurses5-dev automake libtool bison pkg-config libffi-dev curl

Build and install Ruby:

mkdir -p ~/src
cd ~/src
curl -f | tar xz
cd ruby-2.3.3
./configure --disable-install-rdoc
sudo make install

sudo -i gem install bundler

Install curl libraries with your system’s package manager. For example, on Debian or Ubuntu:

~$ sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev

Option 1: Install from RubyGems and PyPI

~$ sudo -i gem install arvados-cli
~$ pip install arvados-python-client arvados-cwl-runner

Option 2: Build and install from source

~$ git clone
~$ cd arvados/sdk/cli
~/arvados/sdk/cli$ gem build arvados-cli.gemspec
~/arvados/sdk/cli$ sudo -i gem install arvados-cli-*.gem
~/arvados/sdk/cli$ cd ../python
~/arvados/sdk/python$ python install
~/arvados/sdk/python$ cd ../cwl
~/arvados/sdk/cwl$ python install

Previous: Crunch utility libraries Next: Overview

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.