21654: Upgrades browserify-sign to address CVE-2023-46234
[arvados.git] / doc / sdk / cli / index.html.textile.liquid
1 ---
2 layout: default
3 navsection: sdk
4 navmenu: Command line tools (CLI SDK)
5 title: "Overview"
6
7 ...
8 {% comment %}
9 Copyright (C) The Arvados Authors. All rights reserved.
10
11 SPDX-License-Identifier: CC-BY-SA-3.0
12 {% endcomment %}
13
14 The @arv@ CLI tool provide provides a convenient interface to manipulate API resources. Additionally, it provides access to a number of subcommands.
15
16 h3. Syntax
17
18 The @arv@ command takes the following arguments:
19
20 <pre>
21 Arvados command line client
22 Usage: arv [--flags] subcommand|resource [method] [--parameters]
23
24 Available flags:
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)
30
31 Use 'arv subcommand|resource --help' to get more information about a particular
32 command or resource.
33
34 Available subcommands: copy, create, edit, keep, pipeline, run, tag, ws
35
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
40
41 Additional options:
42   -e, --version       Print version and exit
43   -h, --help          Show this message
44 </pre>
45
46 h4. Flags: @--format@
47
48 - @--format=json@ := Output response as JSON. This is the default format.
49
50 - @--format=yaml@ := Output response as YAML
51
52 - @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
53
54
55
56 h3. Resources
57
58 See the "arv reference":{{site.baseurl}}/sdk/cli/reference.html page.
59
60 h3. Subcommands
61
62 See the "arv subcommands":{{site.baseurl}}/sdk/cli/subcommands.html page.