4 navmenu: Command line tools (CLI SDK)
9 Copyright (C) The Arvados Authors. All rights reserved.
11 SPDX-License-Identifier: CC-BY-SA-3.0
14 The @arv@ CLI tool provide provides a convenient interface to manipulate API resources. Additionally, it provides access to a number of subcommands.
18 The @arv@ command takes the following arguments:
21 Arvados command line client
22 Usage: arv [--flags] subcommand|resource [method] [--parameters]
25 -n, --dry-run Don't actually do anything
26 -v, --verbose Print some things on stderr
27 -f, --format=<s> Set the output format. Must be one of json (default),
28 yaml or uuid. (Default: json)
29 -s, --short Return only UUIDs (equivalent to --format=uuid)
31 Use 'arv subcommand|resource --help' to get more information about a particular
34 Available subcommands: copy, create, edit, keep, pipeline, run, tag, ws
36 Available resources: api_client_authorization, api_client, authorized_key,
37 collection, user_agreement, group, job_task, link, log, keep_disk,
38 pipeline_instance, node, repository, specimen, pipeline_template, user,
39 virtual_machine, trait, human, job, keep_service
42 -e, --version Print version and exit
43 -h, --help Show this message
48 - @--format=json@ := Output response as JSON. This is the default format.
50 - @--format=yaml@ := Output response as YAML
52 - @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
58 See the "arv reference":{{site.baseurl}}/sdk/cli/reference.html page.
62 See the "arv subcommands":{{site.baseurl}}/sdk/cli/subcommands.html page.