X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a94e15cab04a19dcbb02f2e95335e337c8e55036..08297c0769ab936d55ae37a216ec65d66cbd06e1:/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 5e5f238798..307fecd9a0 100644 --- a/doc/sdk/cli/reference.html.textile.liquid +++ b/doc/sdk/cli/reference.html.textile.liquid @@ -1,9 +1,14 @@ --- layout: default navsection: sdk -navmenu: CLI +navmenu: Command line tools (CLI SDK) 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_ @@ -29,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@ @@ -37,6 +42,8 @@ Get list of groups Delete a group @arv group delete --uuid 6dnxa-j7d0g-iw7i6n43d37jtog@ +Create an empty collection +@arv collection create --collection '{"name": "test collection"}'@ h3. Common commands @@ -54,12 +61,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@. @@ -68,4 +76,4 @@ Example: @arv collection list --filters '[["name", "=", "PGP VAR inputs"], ["created_at", ">=", "2014-10-01"]]'@ -will return a list of all collections visible to the current user which are named "PGP VAR inputs" and were created on or after October 1, 2014. +will return a list of all collections visible to the current user which are named "PGP VAR inputs" and were created on or after October 1, 2014. See the "Common resource methods":{{site.baseurl}}/api/methods.html#index page for more details on using @list@ and @--filters@.