Modal logo
Changelog API Reference modal.Appmodal.Clientmodal.CloudBucketMountmodal.Clsmodal.Cronmodal.Dictmodal.Errormodal.FilePatternMatchermodal.Functionmodal.FunctionCallmodal.Imagemodal.Periodmodal.Proxymodal.Queuemodal.Retriesmodal.Sandboxmodal.SandboxSnapshotmodal.Secretmodal.Tunnelmodal.Volumemodal.asgi_appmodal.batchedmodal.call_graphmodal.concurrentmodal.container_processmodal.current_function_call_idmodal.current_input_idmodal.enable_outputmodal.entermodal.exitmodal.fastapi_endpointmodal.file_iomodal.forwardmodal.gpumodal.interactmodal.io_streamsmodal.is_localmodal.methodmodal.parametermodal.web_endpointmodal.web_servermodal.wsgi_appmodal.exceptionmodal.config CLI Reference modal appmodal billingmodal configmodal containermodal dashboardmodal deploymodal dictmodal environmentmodal launchmodal profilemodal queuemodal runmodal secretmodal servemodal setupmodal shellmodal tokenmodal volume

modal volume

Read and edit modal.Volume volumes.

Note: users of modal.NetworkFileSystem should use the modal nfs command instead.

Usage:

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a named, persistent modal.Volume.
  • get: Download files from a modal.Volume object.
  • list: List the details of all modal.Volume volumes in an Environment.
  • ls: List files and directories in a modal.Volume volume.
  • put: Upload a file or directory to a modal.Volume.
  • rm: Delete a file or directory from a modal.Volume.
  • cp: Copy within a modal.Volume.
  • delete: Delete a named Volume and all of its data.
  • rename: Rename a modal.Volume.
  • dashboard: Open the Volume’s dashboard page in your web browser.

Create a named, persistent modal.Volume.

Usage:

Arguments:

  • NAME: [required]

Options:

  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --version INTEGER: VolumeFS version. (Experimental)
  • --help: Show this message and exit.

Download files from a modal.Volume object.

If a folder is passed for REMOTE_PATH, the contents of the folder will be downloaded recursively, including all subdirectories.

Example

Use ”-” as LOCAL_DESTINATION to write file contents to standard output.

Usage:

Arguments:

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

Options:

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

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --help: Show this message and exit.

List the details of all modal.Volume volumes in an Environment.

Usage:

Options:

  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --json / --no-json: [default: no-json]
  • --help: Show this message and exit.

List files and directories in a modal.Volume volume.

Usage:

Arguments:

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

Options:

  • --json / --no-json: [default: no-json]
  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --help: Show this message and exit.

Upload a file or directory to a modal.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:

Arguments:

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

Options:

  • -f, --force: Overwrite existing files.
  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --help: Show this message and exit.

Delete a file or directory from a modal.Volume.

Usage:

Arguments:

  • VOLUME_NAME: [required]
  • REMOTE_PATH: [required]

Options:

  • -r, --recursive: Delete directory recursively
  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --help: Show this message and exit.

Copy within a modal.Volume. Copy source file to destination file or multiple source files to destination directory.

Usage:

Arguments:

  • VOLUME_NAME: [required]
  • PATHS...: [required]

Options:

  • -r, --recursive: Copy directories recursively
  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --help: Show this message and exit.

Delete a named Volume and all of its data.

Usage:

Arguments:

  • NAME: Name of the modal.Volume to be deleted. Case sensitive [required]

Options:

  • --allow-missing: Don’t error if the Volume doesn’t exist.
  • -y, --yes: Run without pausing for confirmation.
  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --help: Show this message and exit.

Rename a modal.Volume.

Usage:

Arguments:

  • OLD_NAME: [required]
  • NEW_NAME: [required]

Options:

  • -y, --yes: Run without pausing for confirmation.
  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --help: Show this message and exit.

Open the Volume’s dashboard page in your web browser.

Usage:

Arguments:

  • VOLUME_NAME: Name of the Volume to view in the dashboard. [required]

Options:

  • -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

  • --help: Show this message and exit.