Merge branch 'master' into 14965-arv-mount-py-three

[arvados.git] / doc / sdk / cli / subcommands.html.textile.liquid

diff --git a/doc/sdk/cli/subcommands.html.textile.liquid b/doc/sdk/cli/subcommands.html.textile.liquid
index aa7af94d5f9d4ac8527e7d3e238e15d19f177905..b23ec46fa75f35f1955aea204d3f01bd6407f365 100644 (file)
--- a/doc/sdk/cli/subcommands.html.textile.liquid
+++ b/doc/sdk/cli/subcommands.html.textile.liquid
@@ -5,6 +5,11 @@ navmenu: CLI
 title: "arv subcommands"
 
 ...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
 
 _In order to use the @arv@ command, make sure that you have a "working environment.":{{site.baseurl}}/user/getting_started/check-environment.html_
 
@@ -21,6 +26,20 @@ Options:
 </pre>
 </notextile>
 
+h3(#arv-get). arv get
+
+@arv get@ can be used to get a textual representation of Arvados objects from the command line. The output can be limited to a subset of the object's fields. This command can be used with only the knowledge of an object's UUID.
+
+<notextile>
+<pre>
+$ <code class="userinput">arv get --help</code>
+Usage: arv [--format json|yaml] get [uuid] [fields...]
+
+Fetch the specified Arvados object, select the specified fields,
+and print a text representation.
+</pre>
+</notextile>
+
 h3(#arv-edit). arv edit
 
 @arv edit@ can be used to edit Arvados objects from the command line. Arv edit opens up the editor of your choice (set the EDITOR environment variable) with the json or yaml description of the object. Saving the file will update the Arvados object on the API server, if it passes validation.
@@ -121,6 +140,8 @@ arv tag remove --all
 
 h3(#arv-ws). arv ws
 
+This is a frontend to @arv-ws@.
+
 @arv ws@ provides access to the websockets event stream.
 
 <notextile>
@@ -149,7 +170,7 @@ optional arguments:
 
 h3(#arv-keep). arv keep
 
-@arv keep@ provides access to the Keep storage service.
+@arv keep@ commands for accessing the Keep storage service.
 
 <notextile>
 <pre>
@@ -163,6 +184,8 @@ Available methods: ls, get, put, docker
 
 h3(#arv-keep-ls). arv keep ls
 
+This is a frontend to @arv-ls@.
+
 <notextile>
 <pre>
 $ <code class="userinput">arv keep ls --help</code>
@@ -184,6 +207,8 @@ optional arguments:
 
 h3(#arv-keep-get). arv keep get
 
+This is a frontend to @arv-get@.
+
 <notextile>
 <pre>
 $ <code class="userinput">arv keep get --help</code>
@@ -237,6 +262,8 @@ optional arguments:
 
 h3(#arv-keep-put). arv keep put
 
+This is a frontend to @arv-put@.
+
 <notextile>
 <pre>
 $ <code class="userinput">arv keep put --help</code>
@@ -316,6 +343,8 @@ optional arguments:
 
 h3(#arv-pipeline-run). arv pipeline run
 
+WARNING: this uses the obsolete "job" API.  Don't use this.  You should use @arvados-cwl-runner@ instead.
+
 @arv pipeline run@ can be used to start a pipeline run from the command line.
 
 The User Guide has a page with a bit more information on "using arv pipeline run":{{site.baseurl}}/user/topics/running-pipeline-command-line.html.
@@ -362,6 +391,8 @@ Options:
 
 h3(#arv-run). arv run
 
+WARNING: this uses the obsolete "job" API.  Don't use this.  You should use @arvados-cwl-runner@ instead.
+
 The @arv-run@ command creates Arvados pipelines at the command line that fan out to multiple concurrent tasks across Arvados compute nodes.
 
 The User Guide has a page on "using arv-run":{{site.baseurl}}/user/topics/arv-run.html.