[ARVADOS] updated: 89fb910b523686fdf725691c44cb4c63ba464487

git at public.curoverse.com git at public.curoverse.com
Mon Feb 2 14:50:26 EST 2015


Summary of changes:
 doc/sdk/cli/index.html.textile.liquid     | 44 +++++++++++++++++++++++++++++--
 doc/sdk/cli/reference.html.textile.liquid | 13 ++-------
 2 files changed, 44 insertions(+), 13 deletions(-)

       via  89fb910b523686fdf725691c44cb4c63ba464487 (commit)
      from  487dc40959c4a7a8838624c6e108236320e79c8d (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit 89fb910b523686fdf725691c44cb4c63ba464487
Author: Ward Vandewege <ward at curoverse.com>
Date:   Mon Feb 2 14:50:02 2015 -0500

    Documentation cleanup: CLI SDK:
    
    - merge some information from the wiki.
    - reorganize things a bit.
    
    No issue #

diff --git a/doc/sdk/cli/index.html.textile.liquid b/doc/sdk/cli/index.html.textile.liquid
index 3d44250..d64fb23 100644
--- a/doc/sdk/cli/index.html.textile.liquid
+++ b/doc/sdk/cli/index.html.textile.liquid
@@ -6,9 +6,49 @@ title: "Overview"
 
 ...
 
-The @arv@ CLI tool provides a set of wrappers to make API calls. Additionally, it provides access to a number of subcommands.
+The @arv@ CLI tool provide provides a convenient interface to manipulate API resources. Additionally, it provides access to a number of subcommands.
 
-h3. Wrappers for API calls
+h3. Syntax
+
+The @arv@ command takes the following arguments:
+
+<pre>
+Arvados command line client
+Usage: arv [--flags] subcommand|resource [method] [--parameters]
+
+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)
+
+Use 'arv subcommand|resource --help' to get more information about a particular
+command or resource.
+
+Available subcommands: copy, create, edit, keep, pipeline, run, tag, ws
+
+Available resources: api_client_authorization, api_client, authorized_key,
+collection, user_agreement, group, job_task, link, log, keep_disk,
+pipeline_instance, node, repository, specimen, pipeline_template, user,
+virtual_machine, trait, human, job, keep_service
+
+Additional options:
+  -e, --version       Print version and exit
+  -h, --help          Show this message
+</pre>
+
+h4. Flags: @--format@
+
+- @--format=json@ := Output response as JSON. This is the default format.
+
+- @--format=yaml@ := Output response as YAML
+
+- @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
+
+
+
+h3. Resources
 
 See the "arv reference":{{site.baseurl}}/sdk/cli/reference.html page.
 
diff --git a/doc/sdk/cli/reference.html.textile.liquid b/doc/sdk/cli/reference.html.textile.liquid
index bc5cf1e..5e5f238 100644
--- a/doc/sdk/cli/reference.html.textile.liquid
+++ b/doc/sdk/cli/reference.html.textile.liquid
@@ -9,21 +9,12 @@ _In order to use the @arv@ command, make sure that you have a "working environme
 
 h3. Usage
 
- at arv [global_options] resource_type resource_method [method_parameters]@
-
-h4. Global options
-
-- @--format=json@ := Output response as JSON. This is the default format.
-
-- @--format=yaml@ := Output response as YAML
-
-- @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
-
+See the "CLI overview":{{site.baseurl}}/sdk/cli/index.html page.
 
 h3. Resource types and methods
 
 Get list of resource types
- at arv --resources@
+ at arv --help@
 
 Get list of resource methods for the "user" resource type
 @arv user --help@

-----------------------------------------------------------------------


hooks/post-receive
-- 




More information about the arvados-commits mailing list