Add command line SDK page.

diff --git a/doc/_config.yml b/doc/_config.yml
index b600dda19776d7a5f9bc0b82a0fabcb1afc9c9e4..c75b0a4f5e0554c940d10db4ac5e54006c90b600 100644 (file)
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -54,6 +54,8 @@ navbar:
       - sdk/python/crunch-utility-libraries.html.textile.liquid
     - Perl:
       - sdk/perl/index.html.textile.liquid
+    - CLI:
+      - sdk/cli/index.html.textile.liquid
   api:
     - Concepts:
       - api/index.html.textile.liquid

diff --git a/doc/sdk/cli/index.html.textile.liquid b/doc/sdk/cli/index.html.textile.liquid
new file mode 100644 (file)
index 0000000..ab5a41d
--- /dev/null
+++ b/doc/sdk/cli/index.html.textile.liquid
@@ -0,0 +1,63 @@
+---
+layout: default
+navsection: sdk
+navmenu: CLI
+title: "Command line SDK"
+
+...
+
+h1. Command line SDK
+
+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.
+
+It also provides access to Keep storage services with the @arv keep@ subcommand.
+
+h3. Usage
+
+See the "command line interface":{{site.baseurl}}/user/reference/sdk-cli.html page in the user guide.
+
+h3. Installation
+
+If you are logged in to an Arvados VM, the @arv@ should be installed.
+
+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.
+
+h4. Prerequisites: Ruby >= 2.0.0 and curl libraries
+
+You can use "RVM":http://rvm.io/rvm/install to install and manage Ruby versions.
+
+<notextile>
+<pre>
+$ <code class="userinput">sudo apt-get install curl</code>
+$ <code class="userinput">sudo sh -c 'curl -sSL https://get.rvm.io | bash -s stable'</code>
+$ <code class="userinput">source /etc/profile.d/rvm.sh</code>
+</pre>
+</notextile>
+
+Install curl libraries with your system's package manager. For example, with Debian or Ubuntu:
+
+<notextile>
+<pre>
+$ <code class="userinput">sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev</code>
+</pre>
+</notextile>
+
+h4. Option 1: install with RubyGems
+
+<notextile>
+<pre>
+$ <code class="userinput">sudo gem install arvados-cli</code>
+</pre>
+</notextile>
+
+h4. Option 2: build and install from source
+
+<notextile>
+<pre>
+$ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
+$ <code class="userinput">cd arvados/sdk/cli</code>
+$ <code class="userinput">gem build arvados-cli.gemspec</code>
+$ <code class="userinput">sudo gem install arvados-cli-*.gem</code>
+</pre>
+</notextile>
+

diff --git a/doc/sdk/index.html.textile.liquid b/doc/sdk/index.html.textile.liquid
index eba8e98eaab415ccf8e1188c5555f33d039f4ef3..7a81f1dcbd48fa060ef298d1b531598b76877385 100644 (file)
--- a/doc/sdk/index.html.textile.liquid
+++ b/doc/sdk/index.html.textile.liquid
@@ -8,3 +8,4 @@ This section documents how to access the Arvados API and Keep using various prog
 
 * "Python SDK":python/sdk-python.html
 * "Perl SDK":perl/index.html
+* "Command line SDK":cli/index.html ("arv")