Last modified by Dennis Segebarth on 2024/10/02 18:38
From version 8.1
edited by Susan Evans
on 2023/07/14 17:12
Change comment: There is no comment for this version
To version 16.1
edited by Dennis Segebarth
on 2024/10/02 18:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.sgevans
1 +XWiki.dsegebarth
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.
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.
... ... @@ -102,7 +102,7 @@
102 102  
103 103  2) Grant access by clicking Yes:
104 104  
105 -[[image:Pilot CLI authentication.png||height="34%" width="40%"]]
113 +[[image:1723802541971-790.png||height="314" width="368"]]
106 106  
107 107  3) Device Login Successful message will appear and your authentication browser window can be closed.
108 108  
... ... @@ -773,6 +773,8 @@
773 773   List datasets belonging to logged in user.
774 774  
775 775  Options:
784 + --all Show also datasets that belong to projects where user has admin role
785 +
776 776   --page INTEGER The page to be listed [default: 0]
777 777   --page-size INTEGER number of objects per page [default: 10]
778 778   -d, --detached whether run in detached mode
... ... @@ -792,6 +792,19 @@
792 792  Page: 0, Number of datasets: 2
793 793  {{/code}}
794 794  
805 +If the user has the Project Administrator role in one or more Projects, they can also access all Datasets associated with those Projects, even if they were created by another user. To do so, use the "~-~-all" flag:
806 +
807 +{{code language="none"}}
808 +$ pilotcli dataset list --all
809 + Dataset Title Dataset Code
810 +---------------------------------------------------------------------------
811 + dataset2 aug24202102
812 + dataset-01 aug242021
813 + test-dataset-01 testdataset01
814 + test-dataset-02 testdataset02
815 +Page: 0, Number of datasets: 4
816 +{{/code}}
817 +
795 795  == Command: **show-detail** ==
796 796  
797 797  * **Usage**: Show the detailed information of a dataset.
... ... @@ -890,6 +890,6 @@
890 890  
891 891  ----
892 892  
893 -Copyright © 2023 [[Indoc Systems>>url:https://www.indocsystems.com]].
916 +Copyright © 2023-2024 [[Indoc Systems>>url:https://www.indocsystems.com]].
894 894  
895 895  HealthDataCloud is powered by Pilot technology, a product of [[Indoc Systems>>url:https://www.indocsystems.com]].
Pilot CLI authentication.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.sgevans
Size
... ... @@ -1,1 +1,0 @@
1 -33.6 KB
Content
1723802541971-790.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.dsegebarth
Size
... ... @@ -1,0 +1,1 @@
1 +22.2 KB
Content