CLI Reference

This page lists every MASV Agent CLI command and its parameters. For detailed usage examples, see the linked guide pages.

Server

Manage the MASV Agent local server. See Getting Started for details.

Command	Description
masv server start	Start the local MASV Agent server.
masv server shutdown	Gracefully stop the local server.
masv version	Display the installed version and available updates.
masv -h	List all available commands and flags.

masv server start parameters

Flag	Type	Default	Description
--api-key	String	—	MASV API key for authentication.
--auto-finalize	Boolean	true	Automatically finalize uploads when they reach 100% progress.
--auto-resume	Boolean	true	Automatically resume transfers when the server starts.
--chunk-size	String	100MB	Target chunk size for uploads and downloads, formatted as {number}{unit}.
--config-dir	String	$HOME/.masvsrv	Storage location for configuration files and the database.
--listen	String	http://localhost:8080	Listen address and port (port 0 for system-assigned).
--log-format	String	[%lvl%] %time%: %msg%	Log format string.
--log-level	String	debug	Log level: debug, info, warning, error.
--log-out	String	stdout	Log output destination: stdout, stderr, or a filename.
--log-timestamp-format	String	15:04:05	Timestamp format for log entries.
--memory-cache	Boolean	true	Use RAM to boost transfer performance.
--transfer-cleanup-days	Integer	—	Automatically delete transfers older than this many days (minimum 1).
--version	—	—	Display the current version and available updates.

---

User

Manage user sessions. See Authentication for details.

Command	Description
masv user login	Log in with email and password.
masv user status	Show the currently authenticated user and their Teams.
masv user teams	List Teams the current user belongs to.

masv user login parameters

Flag	Type	Required	Description
--email	String	Yes	User email address.
--password	String	Yes	User password.

---

Upload

Create, monitor, and manage uploads. See Uploads for details.

Command	Description
masv upload start email	Send a Package to email recipients.
masv upload start link	Send a Package as a shareable download Link.
masv upload start portal	Upload a Package to a Portal.
masv upload link {upload_id}	Create an additional shareable Link for an existing upload.
masv upload finalize {upload_id}	Finalize an upload and notify recipients.
masv upload ls	List all uploads.
masv upload status {upload_id}	View details for a specific upload.
masv upload pause {upload_id}	Pause a specific upload.
masv upload pause all	Pause all uploads.
masv upload resume {upload_id}	Resume a specific upload.
masv upload resume all	Resume all uploads.
masv upload rm {upload_id}	Delete a specific upload.
masv upload rm all	Delete all uploads.
masv upload update {upload_id}	Update upload properties (e.g., FIFO rank).

Common upload parameters

These parameters apply to all upload types (email, link, portal).

Flag	Type	Required	Default	Description
--chunk-size	String	No	""	Custom chunk size. Overrides the server-level chunk-size flag.
--description	String	No	""	Package description.
--name	String	No	—	Package name.
--priority	Integer	No	0	Upload priority. Higher values mean higher priority.

masv upload start email parameters

Includes all common upload parameters plus:

Flag	Type	Required	Description
--emails	String	Yes	Comma-separated list of email recipients.
--team-id	String	Yes	Team ID to associate with this upload.
--password	String	No	Default password for download Links.
--delete-after	Integer	No	Days to keep the Package in MASV storage.
--download-limit	Integer	No	Default access limit for download Links.
--tag-name	String	No	Name of the Package tag. Created if it doesn’t exist.
--tag-id	String	No	ID of an existing Package tag.
--teamspace-id	String	No	Teamspace ID to associate with this upload.
--unlimited-storage	Boolean	No	Enable unlimited storage for the Package.

masv upload start link parameters

Includes all common upload parameters plus:

Flag	Type	Required	Description
--team-id	String	Yes	Team ID to associate with this upload.
--password	String	No	Default password for download Links.
--delete-after	Integer	No	Days to keep the Package in MASV storage.
--download-limit	Integer	No	Default access limit for download Links.
--tag-name	String	No	Name of the Package tag. Created if it doesn’t exist.
--tag-id	String	No	ID of an existing Package tag.
--teamspace-id	String	No	Teamspace ID to associate with this upload.
--unlimited-storage	Boolean	No	Enable unlimited storage for the Package.

masv upload start portal parameters

Includes all common upload parameters plus:

Flag	Type	Required	Description
--subdomain	String	Yes	Target Portal subdomain.
--sender	String	Yes	Sender email address.
--password	String	No	Portal access code; required for password-protected Portals.
--metadata	String	No	Key-value pairs for Portal metadata: key1=value1,key2=value2.

masv upload update parameters

Flag	Type	Required	Description
--fifo-rank	Integer	No	Set the FIFO rank for this upload.

---

Download

Initiate, monitor, and manage downloads. See Downloads for details.

Command	Description
masv download start	Download a Package from a Link URL.
masv download ls	List all downloads.
masv download status {download_id}	View details for a specific download.
masv download pause {download_id}	Pause a specific download.
masv download pause all	Pause all downloads.
masv download resume {download_id}	Resume a specific download.
masv download resume all	Resume all downloads.
masv download rm {download_id}	Delete a specific download.
masv download rm {download_id} --remove-files	Delete a download and its files from disk.
masv download rm all	Delete all downloads.
masv download rm all --states=complete,error	Delete downloads filtered by state.
masv download update {download_id}	Update download properties (e.g., FIFO rank).

masv download start parameters

Flag	Type	Required	Description
--url	String	Yes	Full download Link URL.
--destination	String	Yes	Path to the download destination directory.
--password	String	No	Download password, if required by the Link.
--bypass-package-quarantine	Boolean	No	Ignore malware warnings and download unaffected files only (default true).
--create-package-folder	Boolean	No	Download files inside a Package folder (default true).
--file-ids	String	No	Comma-separated list of Package file IDs to include.
--priority	Integer	No	Download priority. Higher values mean higher priority.
--gid	Integer	No	GID override to assign file ownership.
--uid	Integer	No	UID override to assign file ownership.

masv download rm parameters

Flag	Type	Required	Description
--remove-files	Boolean	No	Also delete downloaded files from the file system.
--states	String	No	Comma-separated list of states to filter deletion.

masv download update parameters

Flag	Type	Required	Description
--fifo-rank	Integer	No	Set the FIFO rank for this download.

---

Automation

Create, update, list, remove, export, and import automations. See Automations for details.

Command	Description
masv automation ls	List all automations.
masv automation add download	Create a Portal download automation.
masv automation add download --all	Create an all-Portals download automation.
masv automation add upload email	Create a Team watch folder or stream upload automation.
masv automation add upload portal	Create a Portal watch folder or stream upload automation.
masv automation update download {id}	Update a download automation.
masv automation update upload email {id}	Update a Team upload automation.
masv automation update upload team {id}	Update a Team stream automation.
masv automation update upload portal {id}	Update a Portal upload or stream automation.
masv automation rm {id}	Delete an automation.
masv automation export {id}	Export an automation as a base64 string.
masv automation import 'base64_data'	Import an automation from a base64 string.

masv automation add download parameters (Portal download)

Flag	Type	Required	Description
--name	String	Yes	Custom automation name.
--subdomain	String	Yes	Portal subdomain to monitor.
--destination	String	Yes	Destination folder for downloaded Packages.
--create-package-folder	Boolean	No	Place Package contents in dedicated subdirectories (default true).
--effective-time	String	No	RFC 3339 date/time after which Packages will be downloaded.
--enable	Boolean	No	Enable the automation immediately (default true).
--priority	Integer	No	Transfer priority for created downloads.

masv automation add download --all parameters (all-Portals download)

Includes all Portal download parameters except --subdomain, plus:

Flag	Type	Required	Description
--all	Flag	Yes	Indicates this is an all-Portals download automation.
--team-id	String	Yes	Team ID to poll for Portal Packages.
--create-portal-subfolder	Boolean	No	Place Package folders within Portal-named directories.

masv automation add upload email parameters (Team watch folder)

Flag	Type	Required	Description
--name	String	Yes	Automation name.
--enable	Boolean	Yes	Enable or disable the automation.
--path	String	Yes	Directory to watch.
--recipients	String	Yes	Comma-separated list of email recipients.
--team-id	String	Yes	Team ID from which to send Packages.
--timeout	Integer	Yes	Filesystem inactivity timeout in minutes.
--growing-files	Flag	No	Enable stream upload mode (monitors growing files instead of subfolders).
--blacklist	String	No	File patterns to exclude.
--delete-after	Integer	No	Days to keep the Package in MASV storage.
--delete-files-after-upload	Boolean	No	Delete source files after upload completes.
--download-limit	Integer	No	Default access limit for download Links.
--download-password	String	No	Default password for download Links.
--message	String	No	Message to include with the Package.
--package-name-suffix	String	No	Suffix appended to the Package name.
--priority	Integer	No	Upload priority.
--tag-id	String	No	ID of an existing Package tag.
--tag-name	String	No	Name of the Package tag.
--unlimited-storage	Boolean	No	Enable unlimited storage for the Package.
--upload-loose-files	Boolean	No	Also send top-level files as individual Packages.

masv automation add upload portal parameters (Portal watch folder)

Flag	Type	Required	Description
--name	String	Yes	Automation name.
--enable	Boolean	Yes	Enable or disable the automation.
--path	String	Yes	Directory to watch.
--subdomain	String	Yes	Portal subdomain to send Packages to.
--sender	String	Yes	Sender email address.
--timeout	Integer	Yes	Filesystem inactivity timeout in minutes.
--growing-files	Flag	No	Enable stream upload mode (monitors growing files instead of subfolders).
--blacklist	String	No	File patterns to exclude.
--delete-files-after-upload	Boolean	No	Delete source files after upload completes.
--message	String	No	Message to include with the Package.
--package-name-suffix	String	No	Suffix appended to the Package name.
--password	String	No	Portal access code.
--priority	Integer	No	Upload priority.
--upload-loose-files	Boolean	No	Also send top-level files as individual Packages.

---

Gateway

Manage Storage Gateway connections. See Storage Gateway for details.

Command	Description
masv gateway add	Register a new Storage Gateway connection.
masv gateway ls	List all Storage Gateway connections.
masv gateway rm {connection_id}	Remove a Storage Gateway connection.
masv gateway update {connection_id}	Update a Storage Gateway connection.

masv gateway add parameters

Flag	Type	Required	Description
--id	String	Yes	ID of the existing Storage Device Integration.
--secret	String	Yes	Secret key to register the connection with the MASV API.
--name	String	Yes	Descriptive connection name.
--root-path	String	Yes	Folder to share. Must be an absolute path.
--permissions	String	Yes	File permissions: r (read) or w (write).
--uid	Integer	No	Custom user ID override for file ownership on Linux.
--gid	Integer	No	Custom group ID override for file ownership on Linux.

masv gateway update parameters

Flag	Type	Required	Description
--root-path	String	No	New root folder. Must be an absolute path.
--uid	Integer	No	Custom user ID override. Use -1 to remove the override.
--gid	Integer	No	Custom group ID override. Use -1 to remove the override.

---

Settings

Configure disk I/O, FIFO mode, multiconnect, network concurrency, and rate limits. See Settings for details.

Command	Description
masv settings disk status	Query disk configurations.
masv settings disk update	Update disk configurations.
masv settings fifo status	Query FIFO mode status.
masv settings fifo update	Enable, disable, or configure FIFO mode.
masv settings multiconnect status	Query multiconnect status.
masv settings multiconnect update	Enable or disable multiconnect.
masv settings multiconnect interface {iface_id}	Enable or disable a network interface.
masv settings network concurrency status	Query network concurrency settings.
masv settings network concurrency update	Update network concurrency settings.
masv settings network rate-limit upload status	Query upload rate-limit settings.
masv settings network rate-limit download status	Query download rate-limit settings.
masv settings network rate-limit download update	Update download rate-limit settings.
masv settings network rate-limit upload update	Update upload rate-limit settings.
masv settings network rate-limit download schedule update	Enable or disable the download rate-limit schedule.
masv settings network rate-limit download schedule days	Configure schedule days and times.

masv settings disk update parameters

Flag	Type	Required	Description
--readers	Integer	No	Maximum number of concurrent readers.
--writers	Integer	No	Maximum number of concurrent writers.
--priority	String	No	Disk priority: mixed_read_writes, prioritize_writes, prioritize_reads.
--default	Flag	No	Apply changes only to the default configuration.
--ids	String	No	Comma-separated disk IDs to update.

masv settings fifo update parameters

Flag	Type	Required	Description
--enable	Flag	No	Enable FIFO mode.
--disable	Flag	No	Disable FIFO mode.
--downloads	Integer	No	Number of concurrent downloads allowed.
--uploads	Integer	No	Number of concurrent uploads allowed.

masv settings multiconnect update parameters

Flag	Type	Required	Description
--enable	Flag	No	Enable multiconnect.
--disable	Flag	No	Disable multiconnect.

masv settings multiconnect interface parameters

Flag	Type	Required	Description
--enable	Flag	No	Enable the network interface.
--disable	Flag	No	Disable the network interface.

masv settings network concurrency update parameters

Flag	Type	Required	Description
--download	Integer	No	Number of download chunk workers.
--upload	Integer	No	Number of upload chunk workers.

masv settings network rate-limit update parameters

Flag	Type	Required	Description
--bps	Integer	No	Rate limit in bits per second.
--enable	Flag	No	Enable the rate limit.
--disable	Flag	No	Disable the rate limit.
--iface-id	String	No	Network interface ID (required when multiconnect is enabled).

masv settings network rate-limit schedule parameters

Flag	Type	Required	Description
--enable	Flag	No	Enable the rate-limit schedule.
--disable	Flag	No	Disable the rate-limit schedule.
--iface-id	String	No	Network interface ID (required when multiconnect is enabled).

masv settings network rate-limit schedule days parameters

Flag	Type	Required	Description
--start	String	Yes	Schedule start time (e.g., "09:00").
--end	String	Yes	Schedule end time (e.g., "17:00").
--enable	Flag	No	Enable the selected days.
--disable	Flag	No	Disable the selected days.
--mon	Flag	No	Include Monday.
--tue	Flag	No	Include Tuesday.
--wed	Flag	No	Include Wednesday.
--thu	Flag	No	Include Thursday.
--fri	Flag	No	Include Friday.
--sat	Flag	No	Include Saturday.
--sun	Flag	No	Include Sunday.
--iface-id	String	No	Network interface ID (required when multiconnect is enabled).