X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/bc4992f9e11cd0639cf6461736963d66830c5af8..1cecdfb6fabf47c921e7f422063368621619dcfb:/doc/sdk/cli/index.html.textile.liquid?ds=sidebyside diff --git a/doc/sdk/cli/index.html.textile.liquid b/doc/sdk/cli/index.html.textile.liquid index 6b0af21eb2..d64fb23df2 100644 --- a/doc/sdk/cli/index.html.textile.liquid +++ b/doc/sdk/cli/index.html.textile.liquid @@ -6,13 +6,52 @@ title: "Overview" ... -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. +The @arv@ CLI tool provide provides a convenient interface to manipulate API resources. Additionally, it provides access to a number of subcommands. -h3. Wrapper for API calls +h3. Syntax -See the "command line interface":{{site.baseurl}}/user/reference/sdk-cli.html page in the user guide. +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. Subcommands See the "arv subcommands":{{site.baseurl}}/sdk/cli/subcommands.html page. -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 +