---
layout: default
navsection: sdk
-navmenu: CLI
+navmenu: Command line tools (CLI SDK)
title: "Overview"
...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
-The @arv@ CLI tool provides a set of wrappers to make API calls. Additionally, it provides access to a number of subcommands.
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
-h3. Wrappers for API calls
+The @arv@ CLI tool provide provides a convenient interface to manipulate API resources. Additionally, it provides access to a number of subcommands.
+
+h3. Syntax
+
+The @arv@ command takes the following arguments:
+
+<pre>
+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, run, tag, ws
+
+Available resources: api_client_authorization, api_client,
+authorized_key, collection, container, container_request,
+user_agreement, group, keep_service, link, log, user, virtual_machine,
+workflow
+
+Additional options:
+ -e, --version Print version and exit
+ -h, --help Show this message
+</pre>
+
+h4. Flags: @--format@
+
+- @--format=json@ := Output response as JSON. This is the default format.
+
+- @--format=yaml@ := Output response as YAML
+
+- @--format=uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
+
+
+
+h3. Resources
See the "arv reference":{{site.baseurl}}/sdk/cli/reference.html page.
projects / arvados.git / blobdiff