The arv CLI tool provide provides a convenient interface to manipulate API resources. Additionally, it provides access to a number of subcommands.


The arv command takes the following arguments:

Arvados command line client
Usage: arv [--flags] subcommand|resource [method] [--parameters]

Available flags:
  -n, --dry-run       Don't actually do anything
  -v, --verbose       Print some things on stderr
  -f, --format=<s>    Set the output format. Must be one of json (default),
                      yaml or uuid. (Default: json)
  -s, --short         Return only UUIDs (equivalent to --format=uuid)

Use 'arv subcommand|resource --help' to get more information about a particular
command or resource.

Available subcommands: copy, create, edit, keep, pipeline, run, tag, ws

Available resources: api_client_authorization, api_client, authorized_key,
collection, user_agreement, group, job_task, link, log, keep_disk,
pipeline_instance, node, repository, specimen, pipeline_template, user,
virtual_machine, trait, human, job, keep_service

Additional options:
  -e, --version       Print version and exit
  -h, --help          Show this message

Flags: --format

Output response as JSON. This is the default format.
Output response as YAML
Output only the UUIDs of object(s) in the API response, one per line.


See the arv reference page.


See the arv subcommands page.

Previous: Installation Next: arv reference

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.