# masv_portal
masv_portal -- A command line tool to list, create, and delete MASV Portals.
masv_portal ls [ --team team-ID ] [IDs or subdomains ...]
masv_portal new --subdomain string --name string --message string --recipients email [...] [ --access_code string ] [ --download_password string ] [ --tag string ]
masv_portal rm ID [...]
To use this tool, you'll need these:
Before using masv_portal, configure your MASV credentials. You can do this with environment variables or a .env file in the same directory as the masv_portal tool. See Environment and Files.
The masv_portal tool lists, creates, and deletes MASV Portals. It gives you a way to automate your file transfer workflow.
And it's open source and extensible so you can add other commands, options, and improvements.
These options are available for all commands:
Output diagnostic information to standard error.
Output the version of this tool.
Output usage information. You can also use this option with each command.
List Portals in your team. For each matching Portal ID or subdomain, show the Portal's ID, date of creation, tag, and subdomain. With no IDs or subdomains, list all Portals in a team.
Optional. Overrides the team ID specified by MASV_TEAM. The API key that you use must give you access to this team.
Create one or more new Portals.
Required. The subdomain be unique among all subdomains in MASV, not just your Team.
Required. A human-friendly name for the Portal.
Required. A human-friendly, short description of the Portal.
Required. A list of one or more email addresses.
Optional. Overrides the team ID specified by MASV_TEAM. The API key that you use must give you access to this team.
Optional. Password to access the Portal page.
Optional. Password for downloading packages from this Portal.
Optional. Name of the tag to associate with packages that are uploaded to this Portal. If the tag doesn't exist for this Team, MASV will create it.
Deletes Portals with matching IDs.
Warning: This cannot be undone.
If the following variables aren't set in the environment, then the tool uses their definitions in the .env file.
An API key that you've created.
The default Team to use. The MASV user associated with the API must be a member of this team. The -t option overrides this variable.
An environment file in the same directory as this tool. It defines the environment variables that this tool uses.
An example .env file:
MASV_API_KEY=EXAMPLEKEY123
MASV_TEAM=EXAMPLETEAMID321
Success.
An error occurred. The tool also outputs an error message to standard error.
List all Portals:
masv_portal ls
Create a Portal named "My New Portal" with the subdomain "mynewportal" and [email protected] as the recipient. Use the Portal's tag to record a job number, JOB-2024-03:
masv_portal new \
--name "My New Portal" \
--message "Welcome to my new Portal!" \
--subdomain mynewportal \
--recipients "[email protected]" \
--tag "JOB-2024-03"
Delete a Portal:
masv_portal rm E1XSATMHPWLSESDJFQHGW4HKHJ
Delete Portals with tag JOB-2024-03:
masv_portal rm $(node . ls | awk '$3=="\"JOB-2024-03\"" { print $1 }')
Some useful links to learn more about working with MASV Portals:
Made with ♥ in Canada