4.1 Command Line Tool

= About the Command Line Tool =

(% class="wikigeneratedid" id="H" %)

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.

5

6

(% class="wikigeneratedid" %)

7

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

8

9

= (% id="cke_bm_66S" style="display:none" %) (%%)Command Groups =

= Download the Command Line Tool =

15

16

Linux: [[Download>>https://github.com/vre-charite/command_line_tool/blob/main/app/bundled_app/linux/vrecli]]

17

18

Mac ARM: [[Download>>https://github.com/vre-charite/command_line_tool/blob/main/app/bundled_app/mac_arm/vrecli]]

19

Mac Intel: [[Download>>https://github.com/vre-charite/command_line_tool/blob/main/app/bundled_app/mac_intel/vrecli]]

20

21

Windows: [[Download>>https://github.com/vre-charite/command_line_tool/blob/main/app/bundled_app/windows/vrecli.exe]]

22

\\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:

30

31

32

$ 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 =

1. **User: **user related actions such as login and logout

46

1. **Project:** project related actions, including list Project Names and Codes for all Projects accessible by the logged-in user.

47

1. **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.

48

1. **PACS: **PACS data uploading and annotation to the VRE

$ vrecli

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

53

54

What's new (Version 1.4.0):

55

56

1. Support file annotation when uploading folder

57

58

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 =

72

73

* Command line tool is deployed to Guacamole VM and Jupyterhub.

74

* The deployment is done by initialization script in Guacamole VM and Jupyterhub.

75

* There is a cronjob running on the Guacamole VM and Jupyterhub to update vrecli tool every day 3 AM.

76

* The VRECLI pre-deployed in Workbench Guacamole VM is stored within {{code language="none"}}/usr/local/bin/{{/code}}, the vrecli pre-deployed in JupyterHub is stored within {{code language="none"}}/opt/shared/{{/code}}. 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>>doc:Main.user_guide.Navigating the Project Canvas.File Status.WebHome]]

91

92

[[File Processing>>doc:Main.user_guide.Managing Data.File Processing - Green Room.WebHome]]

93

94

[[Analyzing Data>>doc:Main.user_guide.Analyzing Data.WebHome]]

----

[[image:https://i.creativecommons.org/l/by-sa/4.0/88x31.png||data-xwiki-image-style-alignment="center"]]

100

101

(% style="text-align: center;" %)

102

Copyright © 2022, Indoc Research. This work is licensed under a [[Creative Commons Attribution-ShareAlike 4.0>>http://creativecommons.org/licenses/by-sa/4.0/ ||rel="noopener noreferrer" target="blank"]] International License.

103

Wiki source code of 4.1 Command Line Tool