doc/sdk/cli/index.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: sdk
   4 navmenu: CLI
   5 title: "Command line SDK"
   6
   7 ...
   8
   9 The @arv@ CLI tool provides a generic set of wrappers so you can make API calls easily. It performs some validation before connecting to the API server: for example, it refuses to do an API call if a required parameter is missing.
  10
  11 It also provides access to Keep storage services with the @arv keep@ subcommand.
  12
  13 h3. Usage
  14
  15 See the "command line interface":{{site.baseurl}}/user/reference/sdk-cli.html page in the user guide.
  16
  17 h3. Installation
  18
  19 If you are logged in to an Arvados VM, the @arv@ should be installed.
  20
  21 To use @arv@ elsewhere, you can either install the @arvados-cli@ gem via RubyGems or build and install the package using the arvados source tree.
  22
  23 h4. Prerequisites: Ruby &gt;= 2.0.0 and curl libraries
  24
  25 You can use "RVM":http://rvm.io/rvm/install to install and manage Ruby versions.
  26
  27 <notextile>
  28 <pre>
  29 $ <code class="userinput">sudo apt-get install curl</code>
  30 $ <code class="userinput">sudo sh -c 'curl -sSL https://get.rvm.io | bash -s stable'</code>
  31 $ <code class="userinput">source /etc/profile.d/rvm.sh</code>
  32 </pre>
  33 </notextile>
  34
  35 Install curl libraries with your system's package manager. For example, with Debian or Ubuntu:
  36
  37 <notextile>
  38 <pre>
  39 $ <code class="userinput">sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev</code>
  40 </pre>
  41 </notextile>
  42
  43 h4. Option 1: install with RubyGems
  44
  45 <notextile>
  46 <pre>
  47 $ <code class="userinput">sudo gem install arvados-cli</code>
  48 </pre>
  49 </notextile>
  50
  51 h4. Option 2: build and install from source
  52
  53 <notextile>
  54 <pre>
  55 $ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
  56 $ <code class="userinput">cd arvados/sdk/cli</code>
  57 $ <code class="userinput">gem build arvados-cli.gemspec</code>
  58 $ <code class="userinput">sudo gem install arvados-cli-*.gem</code>
  59 </pre>
  60 </notextile>