Merge branch '21535-multi-wf-delete'

[arvados.git] / 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 73acddcf1e63326e22f73c7038c196a90c36530d..827f1d08768fae86085cae8b44c35d620ffa0fff 100644 (file)
--- a/doc/sdk/cli/index.html.textile.liquid
+++ b/doc/sdk/cli/index.html.textile.liquid
@@ -1,60 +1,62 @@
 ---
 layout: default
 navsection: sdk
-navmenu: CLI
-title: "Command line SDK"
+navmenu: Command line tools (CLI SDK)
+title: "Overview"
 
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
 
-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.
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
-It also provides access to Keep storage services with the @arv keep@ subcommand.
+The @arv@ CLI tool provide provides a convenient interface to manipulate API resources. Additionally, it provides access to a number of subcommands.
 
-h3. Usage
+h3. Syntax
 
-See the "command line interface":{{site.baseurl}}/user/reference/sdk-cli.html page in the user guide.
+The @arv@ command takes the following arguments:
 
-h3. Installation
+<pre>
+Arvados command line client
+Usage: arv [--flags] subcommand|resource [method] [--parameters]
 
-If you are logged in to an Arvados VM, the @arv@ should be installed.
+Available flags:
+  -n, --dry-run       Don't actually do anything
+  -v, --verbose       Print some things on stderr
+  -f, --format=<s>    Set the output format. Must be one of json (default),
+                      yaml or uuid. (Default: json)
+  -s, --short         Return only UUIDs (equivalent to --format=uuid)
 
-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.
+Use 'arv subcommand|resource --help' to get more information about a particular
+command or resource.
 
-h4. Prerequisites: Ruby &gt;= 2.0.0 and curl libraries
+Available subcommands: copy, create, edit, keep, run, tag, ws
 
-You can use "RVM":http://rvm.io/rvm/install to install and manage Ruby versions.
+Available resources: api_client_authorization, api_client,
+authorized_key, collection, container, container_request,
+user_agreement, group, keep_service, link, log, user, virtual_machine,
+workflow
 
-<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>
+Additional options:
+  -e, --version       Print version and exit
+  -h, --help          Show this message
 </pre>
-</notextile>
 
-Install curl libraries with your system's package manager. For example, with Debian or Ubuntu:
+h4. Flags: @--format@
 
-<notextile>
-<pre>
-$ <code class="userinput">sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev</code>
-</pre>
-</notextile>
+- @--format=json@ := Output response as JSON. This is the default format.
 
-h4. Option 1: install with RubyGems
+- @--format=yaml@ := Output response as YAML
 
-<notextile>
-<pre>
-$ <code class="userinput">sudo gem install arvados-cli</code>
-</pre>
-</notextile>
+- @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
 
-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>
+
+h3. Resources
+
+See the "arv reference":{{site.baseurl}}/sdk/cli/reference.html page.
+
+h3. Subcommands
+
+See the "arv subcommands":{{site.baseurl}}/sdk/cli/subcommands.html page.