Last modified by Dennis Segebarth on 2024/10/02 18:38
From version 1.9
edited by Susan Evans
on 2023/07/10 22:28
Change comment: (Autosaved)
To version 1.11
edited by Susan Evans
on 2023/07/10 22:32
Change comment: (Autosaved)

Summary

Details

Page properties
Content
... ... @@ -696,9 +696,93 @@
696 696  File has been downloaded successfully and saved to: /home/uname/Downloads/sample_file2
697 697  {{/code}}
698 698  
699 -Download multiple files or folders as a compressed zip by simply providing all source files or folders and adding the ~-~-zip option:
699 +Download multiple files or folders as a compressed zip by simply providing all source files or folders and adding the {{code}}--zip{{/code}} option:
700 700  
701 +{{code language="none"}}
702 +$ pilotcli file sync cli/admin/sample_file2 cli/admin/sample_file7 -z core ~/Downloads/ --zip
703 +Preparing downloading
704 +Preparing status: READY_FOR_DOWNLOADING
705 +start downloading...
706 +Downloading cli_1632340658.768384.zip |██████████████████████████████ 100% 00:00
707 +File has been downloaded successfully and saved to: /home/uname/Downloads/cli_1632340658.768384.zip
708 +{{/code}}
701 701  
710 +Download files or folders by their geid, instead of their location. To enable this, add {{code}}-i{{/code}} or {{code}}--geid{{/code}} to the command:
711 +
712 +{{code language="none"}}
713 +$ pilotcli file sync -i 6d89afd4-f86e-4df7-b6c5-01a9af4e828e-1627499957 7e8e2bac-97c6-4738-bc08-12139c9ba225-1627498854 ~/Downloads/
714 +Preparing status: READY_FOR_DOWNLOADING
715 +start downloading...
716 +Downloading sample_file7 |██████████████████████████████ 100% 00:00
717 +File has been downloaded successfully and saved to: /home/uname/Downloads/sample_file7
718 +Preparing status: READY_FOR_DOWNLOADING
719 +start downloading...
720 +Downloading sample_file2 |██████████████████████████████ 100% 00:00
721 +File has been downloaded successfully and saved to: /home/uname/Downloads/sample_file2
722 +{{/code}}
723 +
724 +Download a file or folder from the Green Room of a Project. This will only be possible if pilotcli is used within the Platform, e.g. in one of the Workspace tools. It works the same way as downloading from Core, including all the additional options like zipping, by either adding {{code}}-z greenroom{{/code}} or by omitting the {{code}}-z{{/code}} option entirely, as “greenroom” is the default value:
725 +
726 +{{code language="none"}}
727 +$ pilotcli file sync cli/admin/sample_file2 cli/admin/sample_file7 ~/Downloads
728 +Preparing status: READY_FOR_DOWNLOADING
729 +/home/uname/Downloads/sample_file2 already exist, file will be saved as /home/uname/Downloads/sample_file2 (1)
730 +start downloading...
731 +Downloading sample_file2 (1) |██████████████████████████████ 100% 00:00
732 +File has been downloaded successfully and saved to: /home/uname/Downloads/sample_file2 (1)
733 +Preparing status: READY_FOR_DOWNLOADING
734 +start downloading...
735 +Downloading sample_file7 |██████████████████████████████ 100% 00:00
736 +File has been downloaded successfully and saved to: /home/uname/Downloads/sample_file7
737 +{{/code}}
738 +
739 += Dataset Commands: pilotcli **dataset** =
740 +
741 +== Help ==
742 +
743 +{{code language="none"}}
744 +$ pilotcli dataset --help
745 +Usage: pilotcli dataset [OPTIONS] COMMAND [ARGS]...
746 +
747 +Options:
748 + --help Show this message and exit.
749 +
750 +Commands:
751 + download Download a dataset or a particular version of a dataset.
752 + list List datasets belonging to logged in user.
753 + show-detail Show details of a dataset.
754 +{{/code}}
755 +
756 +== Command: **list** ==
757 +
758 +* **Usage**: List all datasets for the logged in user
759 +* (((
760 +**Prerequisite**:
761 +
762 +* User login is required, otherwise an error is returned: "The current login session is invalid. Please login to continue."
763 +)))
764 +
765 +{{code language="none"}}
766 +$ pilotcli dataset list --help
767 +Usage: pilotcli dataset list [OPTIONS]
768 +
769 + List datasets belonging to logged in user.
770 +
771 +Options:
772 + --page INTEGER The page to be listed [default: 0]
773 + --page-size INTEGER number of objects per page [default: 10]
774 + -d, --detached whether run in detached mode
775 + --help Show this message and exit.
776 +{{/code}}
777 +
778 +=== Examples ===
779 +
780 +List all datasets that are accessible for the user:
781 +
782 +
783 +
784 +
785 +
702 702  ----
703 703  
704 704  -
... ... @@ -708,5 +708,4 @@
708 708  
709 709  Copyright © 2023 [[Indoc Research>>url:https://www.indocresearch.org/]].
710 710  
711 -HealthDataCloud is powered by Pilot technology, a product of [[Indoc Research>>url:https://www.indocresearch.org/]].{{/code}}
712 -
795 +HealthDataCloud is powered by Pilot technology, a product of [[Indoc Research>>url:https://www.indocresearch.org/]].