Skip to content

Getting Started with MASV Agent

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 Agent 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 Agent is used to transfer terabytes of data every day, reliably and quickly.

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

You can install MASV Agent as a native binary or run it with Docker.

The recommended way to run MASV Agent is to install it natively on your operating system:

  • Linux — Install via .deb or .rpm package on Ubuntu, Debian, CentOS, or other Linux distributions.
  • macOS — Install on macOS using the provided installer.
  • Windows — Install on Windows using the MSI installer.

MASV Agent is also available as a Docker container image, making it easy to run across different operating systems and architectures. See the Docker setup guide for image pull, volume configuration, container startup, and updating instructions.

To use MASV Agent, start the local server first:

Terminal window
masv server start

The server accepts several configuration flags:

FlagTypeDefaultDescription
api-keyStringMASV API key for authentication
auto-finalizeBooleantrueAutomatically finalize uploads when they reach 100% progress
auto-resumeBooleantrueAutomatically resume transfers when the server starts
chunk-sizeString100MBTarget chunk size for uploads and downloads, formatted as {number}{unit}
config-dirString$HOME/.masvsrvStorage location for configuration files and the database
listenStringhttp://localhost:8080Listen address and port (port 0 for system-assigned)
log-formatString[%lvl%] %time%: %msg%Log format string
log-levelStringdebugLog level: debug, info, warning, error
log-outStringstdoutLog output destination: stdout, stderr, or a filename
log-timestamp-formatString15:04:05Timestamp format for log entries
memory-cacheBooleantrueUse RAM to boost transfer performance
transfer-cleanup-daysIntegerAutomatically delete transfers older than this many days from local history (minimum 1)
versionDisplay the current version and available updates

Once the server is running, you can use the rest of the MASV Agent commands.

List all available commands and flags:

Terminal window
masv -h

Check which version of MASV Agent is installed:

Terminal window
masv version

Gracefully stop the local server:

Terminal window
masv server shutdown

The MASV Agent 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-agent to view systemd log output
macOSOpen $HOME/masv-agent/main.log
WindowsOpen Event Viewer → Windows Logs → Application, and filter by source masv-agent
  • 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 Agent commands and parameters.
  • Settings — Configure disk, FIFO mode, multiconnect, and rate-limit options.