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.basedoc}}/user/getting_started/ssh-access.html#login, and have a "working environment.":{{site.basedoc}}/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
  19 - @--format=yaml@ := Output response as YAML
  20 - @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
  21
  22
  23 h3. Resource types and methods
  24
  25 Get list of resource types
  26 @arv --resources@
  27
  28 Get list of resource methods for the "user" resource type
  29 @arv user --help@
  30
  31
  32 h3. Basic examples
  33
  34 Get record for current user
  35 @arv -h user current@
  36
  37 Get entire record for some specific user
  38 @arv -h user get --uuid 6dnxa-tpzed-iimd25zhzh84gbk@
  39
  40 Update user record
  41 @arv user update --uuid 6dnxa-tpzed-iimd25zhzh84gbk --first-name "Bob"@
  42
  43 Get list of groups
  44 @arv group list@
  45
  46 Delete a group
  47 @arv group delete --uuid 6dnxa-j7d0g-iw7i6n43d37jtog@