doc/user/getting_started/setup-cli.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Getting started at the command line
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 Many operations in Arvados can be performed using either the web Workbench or through command line tools.  Some operations can only be done using the command line.
  13
  14 To use the command line tools, you can either log into an Arvados virtual machine where those tools are pre-installed, or install the Arvados tools on your own system.
  15
  16 h2. Option 1: Using an Arvados virtual machine
  17
  18 This is the command line interface we recommend for most day-to-day work, because the tools are all preinstalled and preconfigured for you. You can log in to any virtual machine where you have permission by using:
  19
  20 * "the Webshell client":{{site.baseurl}}/user/getting_started/vm-login-with-webshell.html accessible through Arvados Workbench
  21 * "Unix SSH clients":{{site.baseurl}}/user/getting_started/ssh-access-unix.html
  22 * "Windows SSH clients":{{site.baseurl}}/user/getting_started/ssh-access-windows.html
  23
  24 h2. Option 2: Installing Arvados tools on your own system
  25
  26 This option gives you more flexibility in your work, but takes more time to set up.
  27
  28 h3. Install client tools on Red Hat, AlmaLinux, and Rocky Linux
  29
  30 {% assign modules_to_enable = "python39:3.9" %}
  31 {% assign packages_to_install = "arvados-client python3-arvados-python-client python3-arvados-cwl-runner python3-arvados-fuse python3-crunchstat-summary" %}
  32 {% include 'setup_redhat_repo' %}
  33
  34 Proceed to build and install the Arvados CLI tools:
  35
  36 <notextile>
  37 <pre><code># <span class="userinput">dnf module enable ruby:3.1</span>
  38 # <span class="userinput">dnf install ruby ruby-devel gcc-c++ make redhat-rpm-config glibc-devel glibc-headers curl-devel openssl-devel zlib-devel</span>
  39 # <span class="userinput">gem install arvados-cli</span>
  40 </code></pre>
  41 </notextile>
  42
  43 h3. Install client tools on Debian and Ubuntu
  44
  45 {% include 'setup_debian_repo' %}
  46
  47 Proceed to build and install the Arvados CLI tools:
  48
  49 <notextile>
  50 <pre><code># <span class="userinput">apt install ruby ruby-dev gcc g++ make libc-dev libcurl4-openssl-dev zlib1g-dev</span>
  51 # <span class="userinput">gem install arvados-cli</span>
  52 </code></pre>
  53 </notextile>
  54
  55 h3. Proceed to configuration
  56
  57 Once you have the command line tools installed, proceed to "getting an API token":{{site.baseurl}}/user/reference/api-tokens.html.