X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/44ff73fa397095d69819761e66933783a5f6d541..18b8c3b584a9337977df997624176b5a66b256e9:/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 ef9882fdc6..e1d25aaa23 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_ @@ -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@. @@ -68,4 +74,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@.: 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)