Add some basic documentation for the arv subcommands.
[arvados.git] / doc / sdk / cli / install.html.textile.liquid
1 ---
2 layout: default
3 navsection: sdk
4 navmenu: CLI
5 title: "Installation"
6
7 ...
8
9 If you are logged in to an Arvados VM, the @arv@ tool should be installed.
10
11 To use @arv@ elsewhere, you can either install the @arvados-cli@ gem via RubyGems or build and install the package from source.
12
13 h4. Prerequisites: Ruby >= 2.1.0 and curl libraries
14
15 Make sure you have "Ruby and bundler":/install/install-manual-prerequisites-ruby.html installed.
16
17 Install curl libraries with your system's package manager. For example, on Debian or Ubuntu:
18
19 <notextile>
20 <pre>
21 $ <code class="userinput">sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev</code>
22 </pre>
23 </notextile>
24
25 h4. Option 1: install with RubyGems
26
27 <notextile>
28 <pre>
29 $ <code class="userinput">sudo gem install arvados-cli</code>
30 </pre>
31 </notextile>
32
33 h4. Option 2: build and install from source
34
35 <notextile>
36 <pre>
37 $ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
38 $ <code class="userinput">cd arvados/sdk/cli</code>
39 $ <code class="userinput">gem build arvados-cli.gemspec</code>
40 $ <code class="userinput">sudo gem install arvados-cli-*.gem</code>
41 </pre>
42 </notextile>