X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/da2803a65e696bf85883e82a0bda6ef81dda5429..c29fc69a571bc2e4a4e450a09d94adbb305633bd:/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 f8d3a431a7..e696250888 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" +title: "Command line reference" ... -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.