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