X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/8b7ed36ff057c4a483f4ee8a1c66929425b366c6..2160f72372422c1970a3effb9ba6961b94da318d:/doc/sdk/cli/index.html.textile.liquid diff --git a/doc/sdk/cli/index.html.textile.liquid b/doc/sdk/cli/index.html.textile.liquid index 08880b1b3c..511a41e0b8 100644 --- a/doc/sdk/cli/index.html.textile.liquid +++ b/doc/sdk/cli/index.html.textile.liquid @@ -5,12 +5,57 @@ navmenu: CLI title: "Overview" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -The @arv@ CLI tool provides a generic set of wrappers so you can make API calls easily. Additionally, it provides access to a number of subcommands. +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -h3. Wrapper 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. -See the "command line interface":{{site.baseurl}}/user/reference/sdk-cli.html page in the user guide. +h3. Syntax + +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=+ +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. h3. SubcommandsSet 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 +