doc/sdk/cli/subcommands.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: sdk
   4 navmenu: CLI
   5 title: "arv subcommands"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 _In order to use the @arv@ command, make sure that you have a "working environment.":{{site.baseurl}}/user/getting_started/check-environment.html_
  15
  16 h3(#arv-create). arv create
  17
  18 @arv create@ can be used to create Arvados objects from the command line. Arv create opens up the editor of your choice (set the EDITOR environment variable) and allows you to type or paste a json or yaml description. When saved the object will be created on the API server, if it passes validation.
  19
  20 <notextile>
  21 <pre>
  22 $ <code class="userinput">arv create --help</code>
  23 Options:
  24   --project-uuid, -p &lt;s&gt;:   Project uuid in which to create the object
  25               --help, -h:   Show this message
  26 </pre>
  27 </notextile>
  28
  29 h3(#arv-get). arv get
  30
  31 @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.
  32
  33 <notextile>
  34 <pre>
  35 $ <code class="userinput">arv get --help</code>
  36 Usage: arv [--format json|yaml] get [uuid] [fields...]
  37
  38 Fetch the specified Arvados object, select the specified fields,
  39 and print a text representation.
  40 </pre>
  41 </notextile>
  42
  43 h3(#arv-edit). arv edit
  44
  45 @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.
  46
  47 <notextile>
  48 <pre>
  49 $ <code class="userinput">arv edit --help</code>
  50 Arvados command line client
  51 Usage: arv edit [uuid] [fields...]
  52
  53 Fetch the specified Arvados object, select the specified fields,
  54 open an interactive text editor on a text representation (json or
  55 yaml, use --format) and then update the object.  Will use 'nano'
  56 by default, customize with the EDITOR or VISUAL environment variable.
  57 </pre>
  58 </notextile>
  59
  60 h3(#arv-copy). arv copy
  61
  62 @arv copy@ can be used to copy a pipeline instance, template or collection from one Arvados instance to another. It takes care of copying the object and all its dependencies.
  63
  64 <notextile>
  65 <pre>
  66 $ <code class="userinput">arv copy --help</code>
  67 usage: arv_copy.py [-h] [-v] [--progress] [--no-progress] [-f] --src
  68                    SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
  69                    [--no-recursive] [--dst-git-repo DST_GIT_REPO]
  70                    [--project-uuid PROJECT_UUID] [--retries RETRIES]
  71                    object_uuid
  72
  73 Copy a pipeline instance, template or collection from one Arvados instance to
  74 another.
  75
  76 positional arguments:
  77   object_uuid           The UUID of the object to be copied.
  78
  79 optional arguments:
  80   -h, --help            show this help message and exit
  81   -v, --verbose         Verbose output.
  82   --progress            Report progress on copying collections. (default)
  83   --no-progress         Do not report progress on copying collections.
  84   -f, --force           Perform copy even if the object appears to exist at
  85                         the remote destination.
  86   --src SOURCE_ARVADOS  The name of the source Arvados instance (required) -
  87                         points at an Arvados config file. May be either a
  88                         pathname to a config file, or (for example) "foo" as
  89                         shorthand for $HOME/.config/arvados/foo.conf.
  90   --dst DESTINATION_ARVADOS
  91                         The name of the destination Arvados instance
  92                         (required) - points at an Arvados config file. May be
  93                         either a pathname to a config file, or (for example)
  94                         "foo" as shorthand for $HOME/.config/arvados/foo.conf.
  95   --recursive           Recursively copy any dependencies for this object.
  96                         (default)
  97   --no-recursive        Do not copy any dependencies. NOTE: if this option is
  98                         given, the copied object will need to be updated
  99                         manually in order to be functional.
 100   --dst-git-repo DST_GIT_REPO
 101                         The name of the destination git repository. Required
 102                         when copying a pipeline recursively.
 103   --project-uuid PROJECT_UUID
 104                         The UUID of the project at the destination to which
 105                         the pipeline should be copied.
 106   --retries RETRIES     Maximum number of times to retry server requests that
 107                         encounter temporary failures (e.g., server down).
 108                         Default 3.
 109 </pre>
 110 </notextile>
 111
 112 h3(#arv-tag). arv tag
 113
 114 @arv tag@ is used to tag Arvados objects.
 115
 116 <notextile>
 117 <pre>
 118 $ <code class="userinput">arv tag --help</code>
 119
 120 Usage:
 121 arv tag add tag1 [tag2 ...] --object object_uuid1 [object_uuid2...]
 122 arv tag remove tag1 [tag2 ...] --object object_uuid1 [object_uuid2...]
 123 arv tag remove --all
 124
 125   --dry-run, -n:   Don't actually do anything
 126   --verbose, -v:   Print some things on stderr
 127      --uuid, -u:   Return the UUIDs of the objects in the response, one per
 128                    line (default)
 129      --json, -j:   Return the entire response received from the API server, as
 130                    a JSON object
 131     --human, -h:   Return the response received from the API server, as a JSON
 132                    object with whitespace added for human consumption
 133    --pretty, -p:   Synonym of --human
 134      --yaml, -y:   Return the response received from the API server, in YAML
 135                    format
 136      --help, -e:   Show this message
 137 </pre>
 138 </notextile>
 139
 140
 141 h3(#arv-ws). arv ws
 142
 143 This is a frontend to @arv-ws@.
 144
 145 @arv ws@ provides access to the websockets event stream.
 146
 147 <notextile>
 148 <pre>
 149 $ <code class="userinput">arv ws --help</code>
 150 usage: arv-ws [-h] [-u UUID] [-f FILTERS]
 151               [--poll-interval POLL_INTERVAL | --no-poll]
 152               [-p PIPELINE | -j JOB]
 153
 154 optional arguments:
 155   -h, --help            show this help message and exit
 156   -u UUID, --uuid UUID  Filter events on object_uuid
 157   -f FILTERS, --filters FILTERS
 158                         Arvados query filter to apply to log events (JSON
 159                         encoded)
 160   --poll-interval POLL_INTERVAL
 161                         If websockets is not available, specify the polling
 162                         interval, default is every 15 seconds
 163   --no-poll             Do not poll if websockets are not available, just fail
 164   -p PIPELINE, --pipeline PIPELINE
 165                         Supply pipeline uuid, print log output from pipeline
 166                         and its jobs
 167   -j JOB, --job JOB     Supply job uuid, print log output from jobs
 168 </pre>
 169 </notextile>
 170
 171 h3(#arv-keep). arv keep
 172
 173 @arv keep@ commands for accessing the Keep storage service.
 174
 175 <notextile>
 176 <pre>
 177 $ <code class="userinput">arv keep --help</code>
 178 Usage: arv keep [method] [--parameters]
 179 Use 'arv keep [method] --help' to get more information about specific methods.
 180
 181 Available methods: ls, get, put, docker
 182 </pre>
 183 </notextile>
 184
 185 h3(#arv-keep-ls). arv keep ls
 186
 187 This is a frontend to @arv-ls@.
 188
 189 <notextile>
 190 <pre>
 191 $ <code class="userinput">arv keep ls --help</code>
 192 usage: arv-ls [-h] [--retries RETRIES] [-s] locator
 193
 194 List contents of a manifest
 195
 196 positional arguments:
 197   locator            Collection UUID or locator
 198
 199 optional arguments:
 200   -h, --help         show this help message and exit
 201   --retries RETRIES  Maximum number of times to retry server requests that
 202                      encounter temporary failures (e.g., server down). Default
 203                      3.
 204   -s                 List file sizes, in KiB.
 205 </pre>
 206 </notextile>
 207
 208 h3(#arv-keep-get). arv keep get
 209
 210 This is a frontend to @arv-get@.
 211
 212 <notextile>
 213 <pre>
 214 $ <code class="userinput">arv keep get --help</code>
 215 usage: arv-get [-h] [--retries RETRIES]
 216                [--progress | --no-progress | --batch-progress]
 217                [--hash HASH | --md5sum] [-n] [-r] [-f | --skip-existing]
 218                locator [destination]
 219
 220 Copy data from Keep to a local file or pipe.
 221
 222 positional arguments:
 223   locator            Collection locator, optionally with a file path or
 224                      prefix.
 225   destination        Local file or directory where the data is to be written.
 226                      Default: /dev/stdout.
 227
 228 optional arguments:
 229   -h, --help         show this help message and exit
 230   --retries RETRIES  Maximum number of times to retry server requests that
 231                      encounter temporary failures (e.g., server down). Default
 232                      3.
 233   --progress         Display human-readable progress on stderr (bytes and, if
 234                      possible, percentage of total data size). This is the
 235                      default behavior when it is not expected to interfere
 236                      with the output: specifically, stderr is a tty _and_
 237                      either stdout is not a tty, or output is being written to
 238                      named files rather than stdout.
 239   --no-progress      Do not display human-readable progress on stderr.
 240   --batch-progress   Display machine-readable progress on stderr (bytes and,
 241                      if known, total data size).
 242   --hash HASH        Display the hash of each file as it is read from Keep,
 243                      using the given hash algorithm. Supported algorithms
 244                      include md5, sha1, sha224, sha256, sha384, and sha512.
 245   --md5sum           Display the MD5 hash of each file as it is read from
 246                      Keep.
 247   -n                 Do not write any data -- just read from Keep, and report
 248                      md5sums if requested.
 249   -r                 Retrieve all files in the specified collection/prefix.
 250                      This is the default behavior if the "locator" argument
 251                      ends with a forward slash.
 252   -f                 Overwrite existing files while writing. The default
 253                      behavior is to refuse to write *anything* if any of the
 254                      output files already exist. As a special case, -f is not
 255                      needed to write to /dev/stdout.
 256   --skip-existing    Skip files that already exist. The default behavior is to
 257                      refuse to write *anything* if any files exist that would
 258                      have to be overwritten. This option causes even devices,
 259                      sockets, and fifos to be skipped.
 260 </pre>
 261 </notextile>
 262
 263 h3(#arv-keep-put). arv keep put
 264
 265 This is a frontend to @arv-put@.
 266
 267 <notextile>
 268 <pre>
 269 $ <code class="userinput">arv keep put --help</code>
 270 usage: arv-put [-h] [--max-manifest-depth N | --normalize]
 271                [--as-stream | --stream | --as-manifest | --in-manifest | --manifest | --as-raw | --raw]
 272                [--use-filename FILENAME] [--filename FILENAME]
 273                [--portable-data-hash] [--replication N]
 274                [--project-uuid UUID] [--name NAME]
 275                [--progress | --no-progress | --batch-progress]
 276                [--resume | --no-resume] [--retries RETRIES]
 277                [path [path ...]]
 278
 279 Copy data from the local filesystem to Keep.
 280
 281 positional arguments:
 282   path                  Local file or directory. Default: read from standard
 283                         input.
 284
 285 optional arguments:
 286   -h, --help            show this help message and exit
 287   --max-manifest-depth N
 288                         Maximum depth of directory tree to represent in the
 289                         manifest structure. A directory structure deeper than
 290                         this will be represented as a single stream in the
 291                         manifest. If N=0, the manifest will contain a single
 292                         stream. Default: -1 (unlimited), i.e., exactly one
 293                         manifest stream per filesystem directory that contains
 294                         files.
 295   --normalize           Normalize the manifest by re-ordering files and
 296                         streams after writing data.
 297   --as-stream           Synonym for --stream.
 298   --stream              Store the file content and display the resulting
 299                         manifest on stdout. Do not write the manifest to Keep
 300                         or save a Collection object in Arvados.
 301   --as-manifest         Synonym for --manifest.
 302   --in-manifest         Synonym for --manifest.
 303   --manifest            Store the file data and resulting manifest in Keep,
 304                         save a Collection object in Arvados, and display the
 305                         manifest locator (Collection uuid) on stdout. This is
 306                         the default behavior.
 307   --as-raw              Synonym for --raw.
 308   --raw                 Store the file content and display the data block
 309                         locators on stdout, separated by commas, with a
 310                         trailing newline. Do not store a manifest.
 311   --use-filename FILENAME
 312                         Synonym for --filename.
 313   --filename FILENAME   Use the given filename in the manifest, instead of the
 314                         name of the local file. This is useful when "-" or
 315                         "/dev/stdin" is given as an input file. It can be used
 316                         only if there is exactly one path given and it is not
 317                         a directory. Implies --manifest.
 318   --portable-data-hash  Print the portable data hash instead of the Arvados
 319                         UUID for the collection created by the upload.
 320   --replication N       Set the replication level for the new collection: how
 321                         many different physical storage devices (e.g., disks)
 322                         should have a copy of each data block. Default is to
 323                         use the server-provided default (if any) or 2.
 324   --project-uuid UUID   Store the collection in the specified project, instead
 325                         of your Home project.
 326   --name NAME           Save the collection with the specified name.
 327   --progress            Display human-readable progress on stderr (bytes and,
 328                         if possible, percentage of total data size). This is
 329                         the default behavior when stderr is a tty.
 330   --no-progress         Do not display human-readable progress on stderr, even
 331                         if stderr is a tty.
 332   --batch-progress      Display machine-readable progress on stderr (bytes
 333                         and, if known, total data size).
 334   --resume              Continue interrupted uploads from cached state
 335                         (default).
 336   --no-resume           Do not continue interrupted uploads from cached state.
 337   --retries RETRIES     Maximum number of times to retry server requests that
 338                         encounter temporary failures (e.g., server down).
 339                         Default 3.
 340 </pre>
 341 </notextile>
 342
 343
 344 h3(#arv-pipeline-run). arv pipeline run
 345
 346 WARNING: this uses the obsolete "job" API.  Don't use this.  You should use @arvados-cwl-runner@ instead.
 347
 348 @arv pipeline run@ can be used to start a pipeline run from the command line.
 349
 350 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.
 351
 352 <notextile>
 353 <pre>
 354 $ <code class="userinput">arv pipeline run --help</code>
 355 Options:
 356         --dry-run, -n:   Do not start any new jobs or wait for existing jobs to
 357                          finish. Just find out whether jobs are finished,
 358                          queued, or running for each component.
 359     --status-text &lt;s&gt;:   Store plain text status in given file. (Default:
 360                          /dev/stdout)
 361     --status-json &lt;s&gt;:   Store json-formatted pipeline in given file. (Default:
 362                          /dev/null)
 363             --no-wait:   Do not wait for jobs to finish. Just look up status,
 364                          submit new jobs if needed, and exit.
 365            --no-reuse:   Do not reuse existing jobs to satisfy pipeline
 366                          components. Submit a new job for every component.
 367           --debug, -d:   Print extra debugging information on stderr.
 368     --debug-level &lt;i&gt;:   Set debug verbosity level.
 369        --template &lt;s&gt;:   UUID of pipeline template, or path to local pipeline
 370                          template file.
 371        --instance &lt;s&gt;:   UUID of pipeline instance.
 372              --submit:   Submit the pipeline instance to the server, and exit.
 373                          Let the Crunch dispatch service satisfy the components
 374                          by finding/running jobs.
 375   --run-pipeline-here:   Manage the pipeline instance in-process. Submit jobs
 376                          to Crunch as needed. Do not exit until the pipeline
 377                          finishes (or fails).
 378       --run-jobs-here:   Run jobs in the local terminal session instead of
 379                          submitting them to Crunch. Implies
 380                          --run-pipeline-here. Note: this results in a
 381                          significantly different job execution environment, and
 382                          some Crunch features are not supported. It can be
 383                          necessary to modify a pipeline in order to make it run
 384                          this way.
 385            --run-here:   Synonym for --run-jobs-here.
 386     --description &lt;s&gt;:   Description for the pipeline instance.
 387         --version, -v:   Print version and exit
 388            --help, -h:   Show this message
 389 </pre>
 390 </notextile>
 391
 392 h3(#arv-run). arv run
 393
 394 WARNING: this uses the obsolete "job" API.  Don't use this.  You should use @arvados-cwl-runner@ instead.
 395
 396 The @arv-run@ command creates Arvados pipelines at the command line that fan out to multiple concurrent tasks across Arvados compute nodes.
 397
 398 The User Guide has a page on "using arv-run":{{site.baseurl}}/user/topics/arv-run.html.
 399
 400 <notextile>
 401 <pre>
 402 $ <code class="userinput">arv run --help</code>
 403 usage: arv-run [-h] [--retries RETRIES] [--dry-run] [--local]
 404                [--docker-image DOCKER_IMAGE] [--ignore-rcode] [--no-reuse]
 405                [--no-wait] [--project-uuid PROJECT_UUID] [--git-dir GIT_DIR]
 406                [--repository REPOSITORY] [--script-version SCRIPT_VERSION]
 407                ...
 408
 409 positional arguments:
 410   args
 411
 412 optional arguments:
 413   -h, --help            show this help message and exit
 414   --retries RETRIES     Maximum number of times to retry server requests that
 415                         encounter temporary failures (e.g., server down).
 416                         Default 3.
 417   --dry-run             Print out the pipeline that would be submitted and
 418                         exit
 419   --local               Run locally using arv-run-pipeline-instance
 420   --docker-image DOCKER_IMAGE
 421                         Docker image to use, otherwise use instance default.
 422   --ignore-rcode        Commands that return non-zero return codes should not
 423                         be considered failed.
 424   --no-reuse            Do not reuse past jobs.
 425   --no-wait             Do not wait and display logs after submitting command,
 426                         just exit.
 427   --project-uuid PROJECT_UUID
 428                         Parent project of the pipeline
 429   --git-dir GIT_DIR     Git repository passed to arv-crunch-job when using
 430                         --local
 431   --repository REPOSITORY
 432                         repository field of component, default 'arvados'
 433   --script-version SCRIPT_VERSION
 434                         script_version field of component, default 'master'
 435 </pre>
 436 </notextile>