space:download#
Download files from a space to your local file system. By default, all files in the source directory will be downloaded.
Tip
You can copy the first part of this command from the CONVERGE Horizon web interface. In your space, navigate to the directory containing the files to download and click the Copy (
) button. Select horizon space:download to copy the command for downloading from that directory. The copied string will be missing the --destination option, which you must provide. You can also edit the string to add any options you want to apply.
Usage
horizon space:download [options]
Examples
# Download a case directory from My Space to the current working directory
horizon space:download --space="My Space" --source="/my/case/dir_bcb634650910/" --destination="."
# Skip files that already exist in the current working directory
horizon space:download --space="My Space" --source="/my/case/dir_bcb634650910/" --destination="." --resume
# Exclude files in the _preview directory
horizon space:download --space="My Space" --source="/my/case/dir_bcb634650910/" --destination="." --exclude="*_preview*"
# Download only .log and .out files
horizon space:download --space="My Space" --source="/my/case/dir_bcb634650910/" --destination="." --include="*.log" --include="*.out"
# Download only .h5 files, excluding files with "post0003" in the path
horizon space:download --space="My Space" --source="/my/case/dir_bcb634650910/" --destination="." --include="*.h5" --exclude="*post0003*"
Options
This command supports the general CLI options in addition to those listed below.
--space=SPACEThe name or ID of the space from which files will be downloaded. You can get the space ID by running space:list or by navigating to the space in the web interface and clicking the Copy (
) button.--source=SOURCEThe path to the directory in the space from which files will be downloaded. You can copy the path by navigating to the directory in the web interface and clicking the Copy (
) button. To download all files in the space, specify "/".--destination=DESTINATIONThe path to the directory on your local file system to which files will be downloaded (relative to the current directory).
--exclude=PATTERN, -e PATTERNExclude files with paths that match PATTERN (use * to match any character in the file path). The PATTERN is compared to the entire file path, not just the file name. If you use this option in conjunction with
--include, the included files are processed before the excluded files.Repeatable—To specify multiple patterns, pass this option once per pattern.
--include=PATTERN, -i PATTERNDownload only the files with paths that match PATTERN (use * to match any character in the file path). The PATTERN is compared to the entire file path, not just the file name. If you use this option in conjunction with
--exclude, the included files are processed before the excluded files.Repeatable—To specify multiple patterns, pass this option once per pattern.
--resume, -RDo not download files from the source that already exist (with the same file name and size) in the destination. This option is useful for resuming downloads that were not completed.