h3(#arv-ws). arv ws
+This is a frontend to @arv-ws@.
+
@arv ws@ provides access to the websockets event stream.
<notextile>
h3(#arv-keep). arv keep
-@arv keep@ provides access to the Keep storage service.
+@arv keep@ commands for accessing the Keep storage service.
<notextile>
<pre>
h3(#arv-keep-ls). arv keep ls
+This is a frontend to @arv-ls@.
+
<notextile>
<pre>
$ <code class="userinput">arv keep ls --help</code>
h3(#arv-keep-get). arv keep get
+This is a frontend to @arv-get@.
+
<notextile>
<pre>
$ <code class="userinput">arv keep get --help</code>
-usage: arv-get [-h] [--retries RETRIES]
+usage: arv-get [-h] [--retries RETRIES] [--version]
[--progress | --no-progress | --batch-progress]
- [--hash HASH | --md5sum] [-n] [-r] [-f | --skip-existing]
+ [--hash HASH | --md5sum] [-n] [-r]
+ [-f | -v | --skip-existing | --strip-manifest] [--threads N]
locator [destination]
Copy data from Keep to a local file or pipe.
locator Collection locator, optionally with a file path or
prefix.
destination Local file or directory where the data is to be written.
- Default: /dev/stdout.
+ Default: stdout.
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.
+ encounter temporary failures (e.g., server down).
+ Default 3.
+ --version Print version and exit.
--progress Display human-readable progress on stderr (bytes and, if
possible, percentage of total data size). This is the
default behavior when it is not expected to interfere
with the output: specifically, stderr is a tty _and_
- either stdout is not a tty, or output is being written to
- named files rather than stdout.
+ either stdout is not a tty, or output is being written
+ to named files rather than stdout.
--no-progress Do not display human-readable progress on stderr.
--batch-progress Display machine-readable progress on stderr (bytes and,
if known, total data size).
-f Overwrite existing files while writing. The default
behavior is to refuse to write *anything* if any of the
output files already exist. As a special case, -f is not
- needed to write to /dev/stdout.
- --skip-existing Skip files that already exist. The default behavior is to
- refuse to write *anything* if any files exist that would
- have to be overwritten. This option causes even devices,
- sockets, and fifos to be skipped.
+ needed to write to stdout.
+ -v Once for verbose mode, twice for debug mode.
+ --skip-existing Skip files that already exist. The default behavior is
+ to refuse to write *anything* if any files exist that
+ would have to be overwritten. This option causes even
+ devices, sockets, and fifos to be skipped.
+ --strip-manifest When getting a collection manifest, strip its access
+ tokens before writing it.
+ --threads N Set the number of download threads to be used. Take into
+ account that using lots of threads will increase the RAM
+ requirements. Default is to use 4 threads. On high
+ latency installations, using a greater number will
+ improve overall throughput.
</pre>
</notextile>
h3(#arv-keep-put). arv keep put
+This is a frontend to @arv-put@.
+
<notextile>
<pre>
$ <code class="userinput">arv keep put --help</code>
Default 3.
</pre>
</notextile>
-
-
-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.
-
-<notextile>
-<pre>
-$ <code class="userinput">arv pipeline run --help</code>
-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
-</pre>
-</notextile>
-
-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.
-
-<notextile>
-<pre>
-$ <code class="userinput">arv run --help</code>
-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'
-</pre>
-</notextile>
projects / arvados.git / blobdiff