modal volume

[Beta] Read and edit modal.Volume volumes.

This command is in preview and may change in the future.

Previous users of modal.NetworkFileSystem should replace their usage with the modal nfs command instead.

Usage:

modal volume [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• create: Create a named, persistent modal.Volume.
• get: Download files from a modal.Volume.
• ls: List files and directories in a modal.Volume volume.
• put: Upload a file or directory to a volume.

modal volume create

Create a named, persistent modal.Volume.

Usage:

modal volume create [OPTIONS] NAME

Arguments:

• NAME: [required]

Options:

• --env TEXT: Environment to interact with

If none is specified, Modal will use the default environment of your current profile (can also be specified via the environment variable MODAL_ENVIRONMENT). If neither is set, Modal will assume there is only one environment in the active workspace and use that one, or raise an error if there are multiple environments.

• --help: Show this message and exit.

modal volume get

Download files from a modal.Volume.

Specifying a glob pattern (using any * or ** patterns) as the remote_path will download all matching files, preserving the source directory structure for the matched files.

Example

modal volume get <volume-name> logs/april-12-1.txt .
modal volume get <volume-name> "**" dump_volume

Use ”-” (a hyphen) as LOCAL_DESTINATION to write contents of file to stdout (only for non-glob paths).

Usage:

modal volume get [OPTIONS] VOLUME_NAME REMOTE_PATH [LOCAL_DESTINATION]

Arguments:

• VOLUME_NAME: [required]
• REMOTE_PATH: [required]
• [LOCAL_DESTINATION]: [default: .]

Options:

• --force / --no-force: [default: no-force]
• --env TEXT: Environment to interact with

If none is specified, Modal will use the default environment of your current profile (can also be specified via the environment variable MODAL_ENVIRONMENT). If neither is set, Modal will assume there is only one environment in the active workspace and use that one, or raise an error if there are multiple environments.

• --help: Show this message and exit.

modal volume ls

List files and directories in a modal.Volume volume.

Usage:

modal volume ls [OPTIONS] VOLUME_NAME [PATH]

Arguments:

• VOLUME_NAME: [required]
• [PATH]: [default: /]

Options:

• --env TEXT: Environment to interact with

If none is specified, Modal will use the default environment of your current profile (can also be specified via the environment variable MODAL_ENVIRONMENT). If neither is set, Modal will assume there is only one environment in the active workspace and use that one, or raise an error if there are multiple environments.

• --help: Show this message and exit.

modal volume put

Upload a file or directory to a volume.

Remote parent directories will be created as needed.

Ending the REMOTE_PATH with a forward slash (/), it’s assumed to be a directory and the file will be uploaded with its current name under that directory.

Usage:

modal volume put [OPTIONS] VOLUME_NAME LOCAL_PATH [REMOTE_PATH]

Arguments:

• VOLUME_NAME: [required]
• LOCAL_PATH: [required]
• [REMOTE_PATH]: [default: /]

Options:

• --env TEXT: Environment to interact with

If none is specified, Modal will use the default environment of your current profile (can also be specified via the environment variable MODAL_ENVIRONMENT). If neither is set, Modal will assume there is only one environment in the active workspace and use that one, or raise an error if there are multiple environments.

• --help: Show this message and exit.