doc/user/reference/sdk-cli.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 navmenu: Reference
   5 title: "Command line interface"
   6 ...
   7
   8 h1. Reference: Command Line Interface
   9
  10 *First, you should be "logged into an Arvados VM instance":{{site.baseurl}}/user/getting_started/ssh-access.html#login, and have a "working environment.":{{site.baseurl}}/user/getting_started/check-environment.html*
  11
  12 h3. Usage
  13
  14 @arv [global_options] resource_type resource_method [method_parameters]@
  15
  16 h4. Global options
  17
  18 - @--format=json@ := Output response as JSON. This is the default format.
  19
  20 - @--format=yaml@ := Output response as YAML
  21
  22 - @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
  23
  24
  25 h3. Resource types and methods
  26
  27 Get list of resource types
  28 @arv --resources@
  29
  30 Get list of resource methods for the "user" resource type
  31 @arv user --help@
  32
  33
  34 h3. Basic examples
  35
  36 Get record for current user
  37 @arv user current@
  38
  39 Get entire record for some specific user
  40 @arv user get --uuid 6dnxa-tpzed-iimd25zhzh84gbk@
  41
  42 Update user record
  43 @arv user update --uuid 6dnxa-tpzed-iimd25zhzh84gbk --first-name "Bob"@
  44
  45 Get list of groups
  46 @arv group list@
  47
  48 Delete a group
  49 @arv group delete --uuid 6dnxa-j7d0g-iw7i6n43d37jtog@