Merge branch '7015-update-user-guide'

[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 c7655ba78e9a22b7068d02fba1ea9565df5f9d13..ca494fe17a570e0868af2157fcc92dda6b480cc2 100644 (file)
--- a/doc/sdk/cli/subcommands.html.textile.liquid
+++ b/doc/sdk/cli/subcommands.html.textile.liquid
@@ -21,6 +21,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.
@@ -45,11 +59,11 @@ h3(#arv-copy). arv copy
 <notextile>
 <pre>
 $ <code class="userinput">arv copy --help</code>
-usage: arv-copy [-h] [-v] [--progress] [--no-progress] [-f] --src
-                SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
-                [--no-recursive] [--dst-git-repo DST_GIT_REPO]
-                [--project-uuid PROJECT_UUID] [--retries RETRIES]
-                object_uuid
+usage: arv_copy.py [-h] [-v] [--progress] [--no-progress] [-f] --src
+                   SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
+                   [--no-recursive] [--dst-git-repo DST_GIT_REPO]
+                   [--project-uuid PROJECT_UUID] [--retries RETRIES]
+                   object_uuid
 
 Copy a pipeline instance, template or collection from one Arvados instance to
 another.
@@ -64,15 +78,15 @@ optional arguments:
   --no-progress         Do not report progress on copying collections.
   -f, --force           Perform copy even if the object appears to exist at
                         the remote destination.
-  --src SOURCE_ARVADOS  The name of the source Arvados instance (required).
-                        May be either a pathname to a config file, or the
-                        basename of a file in
-                        $HOME/.config/arvados/instance_name.conf.
+  --src SOURCE_ARVADOS  The name of the source Arvados instance (required) -
+                        points at an Arvados config file. May be either a
+                        pathname to a config file, or (for example) "foo" as
+                        shorthand for $HOME/.config/arvados/foo.conf.
   --dst DESTINATION_ARVADOS
                         The name of the destination Arvados instance
-                        (required). May be either a pathname to a config file,
-                        or the basename of a file in
-                        $HOME/.config/arvados/instance_name.conf.
+                        (required) - points at an Arvados config file. May be
+                        either a pathname to a config file, or (for example)
+                        "foo" as shorthand for $HOME/.config/arvados/foo.conf.
   --recursive           Recursively copy any dependencies for this object.
                         (default)
   --no-recursive        Do not copy any dependencies. NOTE: if this option is
@@ -157,7 +171,7 @@ $ <code class="userinput">arv keep --help</code>
 Usage: arv keep [method] [--parameters]
 Use 'arv keep [method] --help' to get more information about specific methods.
 
-Available methods: ls, get, put, less, check, docker
+Available methods: ls, get, put, docker
 </pre>
 </notextile>
 
@@ -387,7 +401,7 @@ optional arguments:
                         exit
   --local               Run locally using arv-run-pipeline-instance
   --docker-image DOCKER_IMAGE
-                        Docker image to use, default arvados/jobs
+                        Docker image to use, otherwise use instance default.
   --ignore-rcode        Commands that return non-zero return codes should not
                         be considered failed.
   --no-reuse            Do not reuse past jobs.