X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/975e9af85c66fa710728382d1efc66816c25f368..360b5d19eb0cb595fd34d11aa6426d95b3c974d4:/doc/user/reference/sdk-cli.html.textile.liquid diff --git a/doc/user/reference/sdk-cli.html.textile.liquid b/doc/user/reference/sdk-cli.html.textile.liquid index 5effb1ddee..3f62254d20 100644 --- a/doc/user/reference/sdk-cli.html.textile.liquid +++ b/doc/user/reference/sdk-cli.html.textile.liquid @@ -1,13 +1,10 @@ --- layout: default navsection: userguide -navmenu: Reference title: "Command line interface" ... -h1. Reference: Command Line Interface - -*First, you should be "logged into an Arvados VM instance":{{site.basedoc}}/user/getting_started/ssh-access.html#login, and have a "working environment.":{{site.basedoc}}/user/getting_started/check-environment.html* +*First, you should be logged into an Arvados VM instance ("Unix":{{site.baseurl}}/user/getting_started/ssh-access-unix.html#login or "Windows":{{site.baseurl}}/user/getting_started/ssh-access-windows.html#login), and have a "working environment.":{{site.baseurl}}/user/getting_started/check-environment.html* h3. Usage @@ -15,8 +12,10 @@ h3. Usage h4. Global options -- @--format=json@ := Output response as JSON +- @--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. @@ -32,10 +31,10 @@ Get list of resource methods for the "user" resource type h3. Basic examples Get record for current user -@arv -h user current@ +@arv user current@ Get entire record for some specific user -@arv -h user get --uuid 6dnxa-tpzed-iimd25zhzh84gbk@ +@arv user get --uuid 6dnxa-tpzed-iimd25zhzh84gbk@ Update user record @arv user update --uuid 6dnxa-tpzed-iimd25zhzh84gbk --first-name "Bob"@