4.1 Command Line Tool

Last modified by publicadmin on 2025/12/16 13:04

About the Command Line Tool

The VRE Command Line Tool is a binary executable program that provides a convenient way for users to perform file actions and platform-related tasks programmatically.

Please contact a Platform Administrator to receive a link to download the Command Line Tool and the Command Line Tool Manual.

Command Groups

Download the Command Line Tool

Linux: Download

Mac: Download

After download, user need to grand execution permission to the binary file so that command line tool could be used. User could grant permission to the binary file by using the following command in the downloaded vrecli directory.

$ chmod +x ./vrecli

If user have sudo permission, user could make command line tool more accessible in any directory by moving it to the /usr/local/bin directory:

$ sudo mv vrecli /usr/local/bin

Without sudo permission, user could still use command line tool in different directory by referring the command line tool path. For example, use a command line tool in the Downloads folder:

$ ~/Downloads/vrecli

Command Summary

User: user related actions such as login and logout
Project: project related actions, including list Project Names and Codes for all Projects accessible by the logged-in user.
File: actions on files. User could use file action commands to list files/folders, upload files/folders, list/export attribute, and download files as well.
PACS: PACS data uploading and annotation to the VRE

$ vrecli
Usage: vrecli [OPTIONS] COMMAND [ARGS]...

   What's new (Version 1.4.0):

  1. Support file annotation when uploading folder

  2. Support PACS data integration with VRE

Options:
  --help Show this message and exit.

Commands:
  file     File Actions
  project Project Actions
  user     User Actions

Command line tool deployment

Command line tool is deployed to Guacamole VM and Jupyterhub.
The deployment is done by initialization script in Guacamole VM and Jupyterhub.
There is a cronjob running on the Guacamole VM and Jupyterhub to update vrecli tool every day 3 AM.
The VRECLI pre-deployed in Workbench Guacamole VM is stored within /usr/local/bin/, the vrecli pre-deployed in JupyterHub is stored within /opt/shared/. If you want to manually update VRECLI to the latest version, please run the following command in above respective folder where stores the VRECLI:

$ ./vrecli_update.sh

See Also:

File Status

File Processing

Analyzing Data