X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/19ae770973482257117fe8ded5619c3018c4b60f..720ac44caf998a136b64b7968253dd68972a69f4:/doc/sdk/cli/subcommands.html.textile.liquid diff --git a/doc/sdk/cli/subcommands.html.textile.liquid b/doc/sdk/cli/subcommands.html.textile.liquid index ca494fe17a..50d5d89871 100644 --- a/doc/sdk/cli/subcommands.html.textile.liquid +++ b/doc/sdk/cli/subcommands.html.textile.liquid @@ -5,6 +5,11 @@ navmenu: CLI title: "arv subcommands" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} _In order to use the @arv@ command, make sure that you have a "working environment.":{{site.baseurl}}/user/getting_started/check-environment.html_ @@ -135,6 +140,8 @@ arv tag remove --all h3(#arv-ws). arv ws +This is a frontend to @arv-ws@. + @arv ws@ provides access to the websockets event stream. @@ -163,7 +170,7 @@ optional arguments: h3(#arv-keep). arv keep -@arv keep@ provides access to the Keep storage service. +@arv keep@ commands for accessing the Keep storage service. 
@@ -177,6 +184,8 @@ Available methods: ls, get, put, docker
 
 h3(#arv-keep-ls). arv keep ls
 
+This is a frontend to @arv-ls@.
+
 
 
 $ arv keep ls --help
@@ -198,6 +207,8 @@ optional arguments:
 
 h3(#arv-keep-get). arv keep get
 
+This is a frontend to @arv-get@.
+
 
 
 $ arv keep get --help
@@ -251,6 +262,8 @@ optional arguments:
 
 h3(#arv-keep-put). arv keep put
 
+This is a frontend to @arv-put@.
+
 
 
 $ arv keep put --help
@@ -326,94 +339,3 @@ optional arguments:
                         Default 3.
 

 
-
-
-h3(#arv-pipeline-run). arv pipeline run
-
-@arv pipeline run@ can be used to start a pipeline run from the command line.
-
-The User Guide has a page with a bit more information on "using arv pipeline run":{{site.baseurl}}/user/topics/running-pipeline-command-line.html.
-
-
-
-$ arv pipeline run --help
-Options:
-        --dry-run, -n:   Do not start any new jobs or wait for existing jobs to
-                         finish. Just find out whether jobs are finished,
-                         queued, or running for each component.
-    --status-text <s>:   Store plain text status in given file. (Default:
-                         /dev/stdout)
-    --status-json <s>:   Store json-formatted pipeline in given file. (Default:
-                         /dev/null)
-            --no-wait:   Do not wait for jobs to finish. Just look up status,
-                         submit new jobs if needed, and exit.
-           --no-reuse:   Do not reuse existing jobs to satisfy pipeline
-                         components. Submit a new job for every component.
-          --debug, -d:   Print extra debugging information on stderr.
-    --debug-level <i>:   Set debug verbosity level.
-       --template <s>:   UUID of pipeline template, or path to local pipeline
-                         template file.
-       --instance <s>:   UUID of pipeline instance.
-             --submit:   Submit the pipeline instance to the server, and exit.
-                         Let the Crunch dispatch service satisfy the components
-                         by finding/running jobs.
-  --run-pipeline-here:   Manage the pipeline instance in-process. Submit jobs
-                         to Crunch as needed. Do not exit until the pipeline
-                         finishes (or fails).
-      --run-jobs-here:   Run jobs in the local terminal session instead of
-                         submitting them to Crunch. Implies
-                         --run-pipeline-here. Note: this results in a
-                         significantly different job execution environment, and
-                         some Crunch features are not supported. It can be
-                         necessary to modify a pipeline in order to make it run
-                         this way.
-           --run-here:   Synonym for --run-jobs-here.
-    --description <s>:   Description for the pipeline instance.
-        --version, -v:   Print version and exit
-           --help, -h:   Show this message
-

-
-
-h3(#arv-run). arv run
-
-The @arv-run@ command creates Arvados pipelines at the command line that fan out to multiple concurrent tasks across Arvados compute nodes.
-
-The User Guide has a page on "using arv-run":{{site.baseurl}}/user/topics/arv-run.html.
-
-
-
-$ arv run --help
-usage: arv-run [-h] [--retries RETRIES] [--dry-run] [--local]
-               [--docker-image DOCKER_IMAGE] [--ignore-rcode] [--no-reuse]
-               [--no-wait] [--project-uuid PROJECT_UUID] [--git-dir GIT_DIR]
-               [--repository REPOSITORY] [--script-version SCRIPT_VERSION]
-               ...
-
-positional arguments:
-  args
-
-optional arguments:
-  -h, --help            show this help message and exit
-  --retries RETRIES     Maximum number of times to retry server requests that
-                        encounter temporary failures (e.g., server down).
-                        Default 3.
-  --dry-run             Print out the pipeline that would be submitted and
-                        exit
-  --local               Run locally using arv-run-pipeline-instance
-  --docker-image DOCKER_IMAGE
-                        Docker image to use, otherwise use instance default.
-  --ignore-rcode        Commands that return non-zero return codes should not
-                        be considered failed.
-  --no-reuse            Do not reuse past jobs.
-  --no-wait             Do not wait and display logs after submitting command,
-                        just exit.
-  --project-uuid PROJECT_UUID
-                        Parent project of the pipeline
-  --git-dir GIT_DIR     Git repository passed to arv-crunch-job when using
-                        --local
-  --repository REPOSITORY
-                        repository field of component, default 'arvados'
-  --script-version SCRIPT_VERSION
-                        script_version field of component, default 'master'
-

-