Skip to content

Getting Started with MASV Engine

View as Markdown

MASV Engine (formerly MASV Agent) is a cross-platform service that manages file transfers to and from the MASV network. It functions as a CLI tool backed by a local REST API server that you can also call directly.

The MASV Engine supports simultaneous upload and download of multiple Packages, handles file system interactions, and is stateful — it stores transfer metadata and user sessions to survive interruptions and shutdowns. MASV Engine is used to transfer terabytes of data every day, reliably and quickly.

Before installing, check the MASV Engine System Requirements. For the latest changes, see the MASV Engine Release Notes.

Install MASV Engine natively on Linux, macOS, or Windows. You can also run it as a Docker container.

To use MASV Engine, start the local server first:

Terminal window
masv server start

Common flags include --api-key for authentication, --listen to set the address and port, and --config-dir to change the storage location. For the full list of flags, see CLI Reference.

After the server is running, you can use the rest of the MASV Engine commands.

List all available commands and flags:

Terminal window
masv -h

Check which version of MASV Engine is installed:

Terminal window
masv version

Gracefully stop the local server:

Terminal window
masv server shutdown

The MASV Engine log helps you review activity and troubleshoot issues.

PlatformHow to view logs
DockerRun docker container ls to get the container ID, then docker logs $CONTAINER_ID
LinuxRun journalctl -u masv-engine to view systemd log output
macOSOpen $HOME/masv-engine/main.log
WindowsOpen Event Viewer → Windows Logs → Application, and filter by source masv-engine
  • Authentication — Authenticate with API keys or credentials before transferring files.
  • Uploads — Send files via team email, shareable link, or portal.
  • Downloads — Initiate, monitor, and manage file downloads.
  • Automations — Set up watch folders, portal downloads, and stream uploads.
  • Storage Gateway — Connect cloud storage providers to MASV.
  • CLI Reference — Complete list of all MASV Engine commands and parameters.
  • Settings — Configure disk, FIFO mode, multiconnect, and rate-limit options.