X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/df9e166a5ffc4aa79658bec1a5d552a3b413f0d8..cd3bab6f91b89073c9b5646a69110a8b1a5e9e66:/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..cd70dfd4ae 100644 --- a/doc/sdk/cli/reference.html.textile.liquid +++ b/doc/sdk/cli/reference.html.textile.liquid @@ -4,6 +4,11 @@ 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_ @@ -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@ @@ -54,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, -fThe @--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@.: 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)