get_modal_volume_file
Download files from a Modal volume to a local destination or output to stdout. Specify the volume name, remote path, and optional local path or force overwrite.
Instructions
Download files from a Modal volume.
Args:
volume_name: Name of the Modal volume to download from.
remote_path: Path to the file or directory in the volume to download.
local_destination: Local path to save the downloaded file(s). Defaults to current directory.
Use "-" to write file contents to stdout.
force: If True, overwrite existing files. Defaults to False.
Returns:
A dictionary containing the result of the download operation.
Raises:
Exception: If the download operation fails for any reason.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | ||
| local_destination | No | . | |
| remote_path | Yes | ||
| volume_name | Yes |
Input Schema (JSON Schema)
{
"properties": {
"force": {
"default": false,
"title": "Force",
"type": "boolean"
},
"local_destination": {
"default": ".",
"title": "Local Destination",
"type": "string"
},
"remote_path": {
"title": "Remote Path",
"type": "string"
},
"volume_name": {
"title": "Volume Name",
"type": "string"
}
},
"required": [
"volume_name",
"remote_path"
],
"title": "get_modal_volume_fileArguments",
"type": "object"
}