Last modified by Dennis Segebarth on 2024/10/02 18:38
From version 4.1
edited by Susan Evans
on 2023/07/11 13:04
Change comment: There is no comment for this version
To version 11.1
edited by Susan Evans
on 2023/09/22 18:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,10 +8,18 @@
8 8  
9 9  Users are reminded to abide by the Platform Terms of Use and any Project-specific restrictions when using the Command Line Interface to access data and code.
10 10  
11 +{{warning}}
12 +⚠ If you are using pilotcli in an environment or system where other users can access and read all your files, please make sure to always run {{code language="none"}}pilotcli user logout{{/code}} as soon as you are done using pilotcli. This could be, for instance, if you are using pilotcli on a shared computer in your local institute, with system administrators of your University or Hospital having superuser privileges. You should not use pilotcli in an environment where users with such privileges are from an entity that is not trusted.e your warning message here.
13 +{{/warning}}
14 +
11 11  = Using the Pilot Command Line Interface in JupyterHub =
12 12  
13 13  To get started with the Pilot Command Line Interface in the HDC JupyterHub workspace tool, see the article //Using JupyterHub in HDC //and refer to the remaining sections in this article for a full description of the pilotcli commands.
14 14  
19 += Using the Pilot Command Line Interface in Guacamole VMs =
20 +
21 +To get started with the Pilot Command Line Interface in the HDC Guacamole workspace tool, see //Using Guacamole in HDC// on how to launch a terminal, either in a Desktop VM or directly by establishing a connection to a Command Line VM. The Pilot Command Line Interface will be installed, configured, and ready to be used. Please refer to the remaining sections in this article for a full description of the pilotcli commands.
22 +
15 15  = Downloading the Pilot Command Line Interface =
16 16  
17 17  If you wish to use the Pilot Command Line Interface to upload large files from your local environment, it is necessary to download Pilot Command Line Interface tool on your Linux system. The recommended Linux version is Ubuntu 20.04.
... ... @@ -410,7 +410,7 @@
410 410  
411 411  * User login is required, otherwise an error is returned: "The current login session is invalid. Please login to continue."
412 412  * Project must be accessible to the user, otherwise an error is returned: "Project Code not found in list. Please verify and try again."
413 -* Requires the Project code, which can be retrieved via pilotcli project list.
421 +* Requires the Project code, which can be retrieved via {{code}}pilotcli project list{{/code}}.
414 414  )))
415 415  
416 416  {{code language="none"}}
... ... @@ -618,7 +618,7 @@
618 618  All uploading jobs have finished.
619 619  {{/code}}
620 620  
621 -(10) upload with customized manifest name
629 +Upload with customized manifest name
622 622  
623 623  When you upload a file using pilotcli, a JSON file with the details of your specific upload job will be created automatically and allows you to resume the upload at a later time, in case the process is aborted due to any reason. By default, this JSON file will be created as “manifest.json” in the current working directory (see //Command: **resume**// below for more details on how to resume the file upload). However, you can use the {{code}}--output-path{{/code}} option to specify the filepath and, thus, the filename of this JSON file:
624 624  
... ... @@ -890,6 +890,6 @@
890 890  
891 891  ----
892 892  
893 -Copyright © 2023 [[Indoc Research>>url:https://www.indocresearch.org/]].
901 +Copyright © 2023 [[Indoc Systems>>url:https://www.indocsystems.com]].
894 894  
895 -HealthDataCloud is powered by Pilot technology, a product of [[Indoc Research>>url:https://www.indocresearch.org/]].
903 +HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]].