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_
</pre>
</notextile>
+h3(#arv-get). arv get
+
+@arv get@ can be used to get a textual representation of Arvados objects from the command line. The output can be limited to a subset of the object's fields. This command can be used with only the knowledge of an object's UUID.
+
+<notextile>
+<pre>
+$ <code class="userinput">arv get --help</code>
+Usage: arv [--format json|yaml] get [uuid] [fields...]
+
+Fetch the specified Arvados object, select the specified fields,
+and print a text representation.
+</pre>
+</notextile>
+
h3(#arv-edit). arv edit
@arv edit@ can be used to edit Arvados objects from the command line. Arv edit opens up the editor of your choice (set the EDITOR environment variable) with the json or yaml description of the object. Saving the file will update the Arvados object on the API server, if it passes validation.
<notextile>
<pre>
$ <code class="userinput">arv copy --help</code>
-usage: arv-copy [-h] [-v] [--progress] [--no-progress] [-f] --src
- SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
- [--no-recursive] [--dst-git-repo DST_GIT_REPO]
- [--project-uuid PROJECT_UUID] [--retries RETRIES]
- object_uuid
+usage: arv_copy.py [-h] [-v] [--progress] [--no-progress] [-f] --src
+ SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
+ [--no-recursive] [--dst-git-repo DST_GIT_REPO]
+ [--project-uuid PROJECT_UUID] [--retries RETRIES]
+ object_uuid
Copy a pipeline instance, template or collection from one Arvados instance to
another.
--no-progress Do not report progress on copying collections.
-f, --force Perform copy even if the object appears to exist at
the remote destination.
- --src SOURCE_ARVADOS The name of the source Arvados instance (required).
- May be either a pathname to a config file, or the
- basename of a file in
- $HOME/.config/arvados/instance_name.conf.
+ --src SOURCE_ARVADOS The name of the source Arvados instance (required) -
+ points at an Arvados config file. May be either a
+ pathname to a config file, or (for example) "foo" as
+ shorthand for $HOME/.config/arvados/foo.conf.
--dst DESTINATION_ARVADOS
The name of the destination Arvados instance
- (required). May be either a pathname to a config file,
- or the basename of a file in
- $HOME/.config/arvados/instance_name.conf.
+ (required) - points at an Arvados config file. May be
+ either a pathname to a config file, or (for example)
+ "foo" as shorthand for $HOME/.config/arvados/foo.conf.
--recursive Recursively copy any dependencies for this object.
(default)
--no-recursive Do not copy any dependencies. NOTE: if this option is
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>
Usage: arv keep [method] [--parameters]
Use 'arv keep [method] --help' to get more information about specific methods.
-Available methods: ls, get, put, less, check, docker
+Available methods: ls, get, put, docker
</pre>
</notextile>
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>
h3(#arv-keep-put). arv keep put
+This is a frontend to @arv-put@.
+
<notextile>
<pre>
$ <code class="userinput">arv keep put --help</code>
usage: arv-put [-h] [--max-manifest-depth N | --normalize]
[--as-stream | --stream | --as-manifest | --in-manifest | --manifest | --as-raw | --raw]
[--use-filename FILENAME] [--filename FILENAME]
- [--portable-data-hash] [--project-uuid UUID] [--name NAME]
+ [--portable-data-hash] [--replication N]
+ [--project-uuid UUID] [--name NAME]
[--progress | --no-progress | --batch-progress]
[--resume | --no-resume] [--retries RETRIES]
[path [path ...]]
a directory. Implies --manifest.
--portable-data-hash Print the portable data hash instead of the Arvados
UUID for the collection created by the upload.
+ --replication N Set the replication level for the new collection: how
+ many different physical storage devices (e.g., disks)
+ should have a copy of each data block. Default is to
+ use the server-provided default (if any) or 2.
--project-uuid UUID Store the collection in the specified project, instead
of your Home project.
--name NAME Save the collection with the specified name.
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 Arvado 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, default arvados/jobs
- --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