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

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Command line interface"
   5 ...
   6
   7 *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*
   8
   9 h3. Usage
  10
  11 @arv [global_options] resource_type resource_method [method_parameters]@
  12
  13 h4. Global options
  14
  15 - @--format=json@ := Output response as JSON. This is the default format.
  16
  17 - @--format=yaml@ := Output response as YAML
  18
  19 - @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
  20
  21
  22 h3. Resource types and methods
  23
  24 Get list of resource types
  25 @arv --resources@
  26
  27 Get list of resource methods for the "user" resource type
  28 @arv user --help@
  29
  30
  31 h3. Basic examples
  32
  33 Get record for current user
  34 @arv user current@
  35
  36 Get entire record for some specific user
  37 @arv user get --uuid 6dnxa-tpzed-iimd25zhzh84gbk@
  38
  39 Update user record
  40 @arv user update --uuid 6dnxa-tpzed-iimd25zhzh84gbk --first-name "Bob"@
  41
  42 Get list of groups
  43 @arv group list@
  44
  45 Delete a group
  46 @arv group delete --uuid 6dnxa-j7d0g-iw7i6n43d37jtog@