X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/7a537556b3503bf957ad3da2bf27885518a33230..76eaaac9fed4e74b8073ee08f99b84fc7922ac9f:/doc/sdk/cli/index.html.textile.liquid diff --git a/doc/sdk/cli/index.html.textile.liquid b/doc/sdk/cli/index.html.textile.liquid index 3b63079173..3d44250541 100644 --- a/doc/sdk/cli/index.html.textile.liquid +++ b/doc/sdk/cli/index.html.textile.liquid @@ -2,60 +2,16 @@ layout: default navsection: sdk navmenu: CLI -title: "Command line SDK" +title: "Overview" ... -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. +The @arv@ CLI tool provides a set of wrappers to make API calls. Additionally, it provides access to a number of subcommands. -It also provides access to Keep storage services with the @arv keep@ subcommand. +h3. Wrappers for API calls -h3. Usage +See the "arv reference":{{site.baseurl}}/sdk/cli/reference.html page. -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. - - -
-$ sudo apt-get install curl
-$ sudo sh -c 'curl -sSL https://get.rvm.io | bash -s stable'
-$ source /etc/profile.d/rvm.sh
-
-
- -Install curl libraries with your system's package manager. For example, with Debian or Ubuntu: - - -
-$ sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev
-
-
- -h4. Option 1: install with RubyGems - - -
-$ sudo gem install arvados-cli
-
-
- -h4. Option 2: build and install from source - - -
-$ git clone https://github.com/curoverse/arvados.git
-$ cd arvados/sdk/cli
-$ gem build arvados-cli.gemspec
-$ sudo gem install arvados-cli-*.gem
-
-
+h3. Subcommands +See the "arv subcommands":{{site.baseurl}}/sdk/cli/subcommands.html page.