Skip to Content

Wiki source code of 4.1 Command Line Tool

Version 3.2 by publicadmin on 2026/08/25 07:04
Hide last authors
publicadmin 1.1 1 = About the Command Line Tool =
2
3 (% class="wikigeneratedid" id="H" %)
4 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 =
10
11 {{children/}}
12
13
14 = Download the Command Line Tool =
15
publicadmin 3.1 16 Linux: [[Download>>https://github.com/vre-charite/command_line_tool/blob/main/app/bundled_app/linux/vrecli]]
publicadmin 1.1 17
publicadmin 3.2 18 Mac ARM: [[Download>>https://github.com/vre-charite/command_line_tool/blob/main/app/bundled_app/mac_arm/vrecli]]
19 \\Mac Intel:
publicadmin 1.1 20
21 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.
22
23 {{code language="none"}}
24 $ chmod +x ./vrecli
25
26 {{/code}}
27
28 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:
29
30 {{code language="none"}}
31 $ sudo mv vrecli /usr/local/bin
32
33 {{/code}}
34
35 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:
36
37 {{code language="none"}}
38 $ ~/Downloads/vrecli
39
40 {{/code}}
41
42 = Command Summary =
43
44 1. **User: **user related actions such as login and logout
45 1. **Project:** project related actions, including list Project Names and Codes for all Projects accessible by the logged-in user.
46 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.
47 1. **PACS: **PACS data uploading and annotation to the VRE
48
49 {{code language="none"}}
50 $ vrecli
51 Usage: vrecli [OPTIONS] COMMAND [ARGS]...
52
53 What's new (Version 1.4.0):
54
55 1. Support file annotation when uploading folder
56
57 2. Support PACS data integration with VRE
58
59
60
61 Options:
62 --help Show this message and exit.
63
64 Commands:
65 file File Actions
66 project Project Actions
67 user User Actions
68 {{/code}}
69
70 = Command line tool deployment =
71
72 * Command line tool is deployed to Guacamole VM and Jupyterhub.
73 * The deployment is done by initialization script in Guacamole VM and Jupyterhub.
74 * There is a cronjob running on the Guacamole VM and Jupyterhub to update vrecli tool every day 3 AM.
75 * 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:
76
77 {{code language="none"}}
78 $ ./vrecli_update.sh
79 {{/code}}
80
81 = =
82
83 = =
84
85 ----
86
87 **See Also: **
88
89 [[File Status>>doc:Main.user_guide.Navigating the Project Canvas.File Status.WebHome]]
90
91 [[File Processing>>doc:Main.user_guide.Managing Data.File Processing - Green Room.WebHome]]
92
93 [[Analyzing Data>>doc:Main.user_guide.Analyzing Data.WebHome]]
94
95 ----
96
97 {{box}}
publicadmin 3.2 98 [[image:https://i.creativecommons.org/l/by-sa/4.0/88x31.png||data-xwiki-image-style-alignment="center"]]
publicadmin 1.1 99
100 (% style="text-align: center;" %)
101 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.
102 {{/box}}