X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ba251e274d684688217d0b1f8b1c8b14ce13feaf..a1c4ece152e1e992c18f0cb368528cd2ac843b07:/doc/sdk/cli/reference.html.textile.liquid diff --git a/doc/sdk/cli/reference.html.textile.liquid b/doc/sdk/cli/reference.html.textile.liquid index bc5cf1e6c1..cd70dfd4ae 100644 --- a/doc/sdk/cli/reference.html.textile.liquid +++ b/doc/sdk/cli/reference.html.textile.liquid @@ -4,26 +4,22 @@ navsection: sdk navmenu: CLI title: "arv reference" ... +{% 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_ h3. Usage -@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 -@arv --resources@ +@arv --help@ Get list of resource methods for the "user" resource type @arv user --help@ @@ -38,7 +34,7 @@ Get entire record for some specific user @arv user get --uuid 6dnxa-tpzed-iimd25zhzh84gbk@ Update user record -@arv user update --uuid 6dnxa-tpzed-iimd25zhzh84gbk --first-name "Bob"@ +@arv user update --uuid 6dnxa-tpzed-iimd25zhzh84gbk --user '{"first_name":"Bob"}'@ Get list of groups @arv group list@ @@ -63,12 +59,13 @@ h4. @list@ Arguments accepted by the @list@ subcommand include:
-    --limit, -l :     Maximum number of resources to return.
-   --offset, -o :     Number of users to skip before first returned record.
-  --filters, -f :     Conditions for filtering users.
-    --order, -r :     Order in which to return matching users.
-   --select, -s :     Select which fields to return
-     --distinct, -d:     Return each distinct object
+  -l, --limit=        Maximum number of items to return. (Default: 100)
+  -o, --offset=       Number of items to skip before first returned record. (Default: 0)
+  -f, --filters=      Conditions for filtering items.
+  -r, --order=        Order in which to return matching items.
+  -s, --select=       Select which fields to return.
+  -d, --distinct         Return each distinct object.
+  -c, --count=        Type of count to return in items_available ('none' or 'exact'). (Default: exact)
 
The @--filters@ option takes a string describing a JSON list of filters on which the returned resources should be returned. Each filter is a three-element list of _[field, operator, value]_, where the _operator_ may be one of @=@, @<@, @<=@, @>@, @>=@, @!=@, @like@, or @ilike@.