doc/sdk/cli/index.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: sdk
   4 navmenu: CLI
   5 title: "Overview"
   6
   7 ...
   8
   9 The @arv@ CLI tool provide provides a convenient interface to manipulate API resources. Additionally, it provides access to a number of subcommands.
  10
  11 h3. Syntax
  12
  13 The @arv@ command takes the following arguments:
  14
  15 <pre>
  16 Arvados command line client
  17 Usage: arv [--flags] subcommand|resource [method] [--parameters]
  18
  19 Available flags:
  20   -n, --dry-run       Don't actually do anything
  21   -v, --verbose       Print some things on stderr
  22   -f, --format=<s>    Set the output format. Must be one of json (default),
  23                       yaml or uuid. (Default: json)
  24   -s, --short         Return only UUIDs (equivalent to --format=uuid)
  25
  26 Use 'arv subcommand|resource --help' to get more information about a particular
  27 command or resource.
  28
  29 Available subcommands: copy, create, edit, keep, pipeline, run, tag, ws
  30
  31 Available resources: api_client_authorization, api_client, authorized_key,
  32 collection, user_agreement, group, job_task, link, log, keep_disk,
  33 pipeline_instance, node, repository, specimen, pipeline_template, user,
  34 virtual_machine, trait, human, job, keep_service
  35
  36 Additional options:
  37   -e, --version       Print version and exit
  38   -h, --help          Show this message
  39 </pre>
  40
  41 h4. Flags: @--format@
  42
  43 - @--format=json@ := Output response as JSON. This is the default format.
  44
  45 - @--format=yaml@ := Output response as YAML
  46
  47 - @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
  48
  49
  50
  51 h3. Resources
  52
  53 See the "arv reference":{{site.baseurl}}/sdk/cli/reference.html page.
  54
  55 h3. Subcommands
  56
  57 See the "arv subcommands":{{site.baseurl}}/sdk/cli/subcommands.html page.