fovus job download¶

Download job files from Fovus Storage.

Only new or updated files will be downloaded. If the job is running, the files will be synced to Fovus Storage before being downloaded.

JOB_DIRECTORY is the directory where the files will be downloaded.

Usage

fovus job download [OPTIONS] JOB_DIRECTORY

Options

--job-id <job_id>¶: The ID of the job to download files from. This is only required if JOB_DIRECTORY has not been initialized by the Fovus CLI.

--include-paths <include_paths>¶

Relative path(s) to files or folders inside the JOB_DIRECTORY to download.

Paths support Unix shell-style wildcards, unless the –range option is used. When downloading a byte range, only one explicit file path may be provided, and wildcards are not supported.

You can only provide either –include-paths or –exclude-paths, not both.

Supported wildcards: * - matches any number of characters ? - matches any single character

E.g. taskName/out?/*.txt matches any .txt file in folders taskName/out1, taskName/out2, etc.

E.g. taskName???/folder/file.txt matches taskName001/folder/file.txt, taskName123/folder/file.txt, etc.

To specify multiple paths, this option may be provided multiple times or deliminated by a comma (,). To escape a comma, use two commas (,,).

E.g. –include-paths “path1” –include-paths “path2”

E.g. –include-paths “path1,path2”

--exclude-paths <exclude_paths>¶

The relative paths to files or folders inside the JOB_DIRECTORY that will not be downloaded. Paths are provided with support for Unix shell-style wildcards.

You can only provide either –include-paths or –exclude-paths, not both. This option is not supported when downloading an exact byte range of a file.

Supported wildcards: * - matches any number of characters ? - matches any single character

E.g. taskName/out?/*.txt matches any .txt file in folders taskName/out1, taskName/out2, etc.

E.g. taskName???/folder/file.txt matches taskName001/folder/file.txt, taskName123/folder/file.txt, etc.

To specify multiple paths, this option may be provided multiple times or deliminated by a comma (,). To escape a comma, use two commas (,,).

E.g. –exclude-paths “path1” –exclude-paths “path2”

E.g. –exclude-paths “path1,path2”

--range <byte_range>¶: The bytes range of the file to download. For example, –range=”0-1024” downloads the first 1025 bytes (positions 0 through 1024). This option is only supported when downloading a single file.

--wait-until-status-is <JOB_STATUS>¶

Wait until the job reaches the specified status(es) before downloading the files.

Valid job statuses are:

Completed, Failed, Terminated, Walltime Reached, Uncompleted, Infrastructure Terminated, Terminate Failed, Post Processing Walltime Reached, Post Processing Failed, License Timeout

To specify multiple statuses, this option may be provided multiple times or deliminated by a comma (,).

E.g. –wait-until-status-is “Completed” –wait-until-status-is “Walltime Reached”

E.g. –wait-until-status-is “Completed,Walltime Reached”

If job completes with a status other than the specified statuses, the command will exit and no files will be downloaded.

Arguments

JOB_DIRECTORY¶: Required argument