Last modified by Dennis Segebarth on 2024/10/02 18:38
From version 1.7
edited by Susan Evans
on 2023/07/10 22:24
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
... ... @@ -618,10 +618,171 @@
618 618  
619 619  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:
620 620  
621 +{{code language="none"}}
622 +$ pilotcli file upload -p <path> <file> --output-path test_manifest.json
623 +{{/code}}
621 621  
625 +== Command: **resume** ==
622 622  
627 +* **Options**: -td ~-~-thread, -r ~-~-resumable-manifest
628 +* **Usage**: Resume unfinished file uploading based on the manifest file.
629 +* (((
630 +**Prerequisite**:
623 623  
632 +* User login is required, otherwise an error is returned: "The current login session is invalid. Please login to continue."
633 +* Project must be accessible to the user, otherwise an error is returned: "Project Code not found in list. Please verify and try again."
634 +* The resumable manifest JSON file is required, which is generated upon executing the {{code}}pilotcli file upload{{/code}} command.
635 +)))
624 624  
637 +=== Example: ===
638 +
639 +For instance upon disconnecting from the internet, or by accidentally closing the terminal, a currently running uploading process can be aborted. You can use the {{code}}pilotcli file resume{{/code}} command in order to resume the uploading process right where you left off. Simply point to the manifest JSON file that was created upon executing the original upload command. Please note that the source files still have to be in the same location, otherwise resuming the uploading process will fail.
640 +
641 +{{code language="none"}}
642 +$ pilotcli file resume -r ./manifest.json
643 +Resume the upload for 10 files.
644 +Resumable upload check complete.
645 +Uploading aggregated.py: |██████████████████████████████ 100% 00:00
646 +Uploading __init__.py: |██████████████████████████████ 100% 00:00
647 +Uploading service_meta_class.py: |██████████████████████████████ 100% 00:00
648 +Uploading upload_form.py: |██████████████████████████████ 100% 00:00
649 +Uploading convert_type.py: |██████████████████████████████ 100% 00:00
650 +Uploading singleton.py: |██████████████████████████████ 100% 00:00
651 +Uploading __init__.py: |██████████████████████████████ 100% 00:00
652 +Uploading base_library.zip: |██████████████████████████████ 100% 00:00 0% ?
653 +Uploading EXE-00.toc: |██████████████████████████████ 100% 00:00
654 +Uploading xref-pilotcli_test20230227_3.html: |██████████████████████████████ 100% 00:00
655 +Upload Time: 11.13s for 10 files
656 +{{/code}}
657 +
658 +== Command: **sync** ==
659 +
660 +* **Usage**: Download a file or a folder from a Project. If pilotcli is used outside of the Platform, e.g. the users local machine, users can only download from Project’s Core. When pilotcli is used within the Platform, e.g. from one of the workspace tools, users will also be able to download from the Green Room of a Project as well.
661 +* (((
662 +**Options**: -z ~-~-zone, -i ~-~-geid, ~-~-zip
663 +
664 +* To look up a file’s geid, or unique file ID, open the Project File Explorer in the Portal and inspect the File Properties for the ID.
665 +)))
666 +* (((
667 +**Prerequisite**:
668 +
669 +* User login is required, otherwise an error is returned: "The current login session is invalid. Please login to continue."
670 +* The specified file or folder must exist, otherwise an error is returned: “File does not exist or source file provided is invalid: folder_name/file_name.”
671 +* If the user has no access to the specified file or folder on the Portal, an error is returned: “Permission denied. Please verify that your role in the Project has permission to perform this action.”
672 +)))
673 +
674 +{{code language="none"}}
675 +$ pilotcli file sync --help
676 +Usage: pilotcli file sync [OPTIONS] [PATHS]... OUTPUT_PATH
677 +
678 + Download files/folders from a given Project/folder/file in core zone.
679 +
680 +Options:
681 + -z, --zone TEXT Target Zone (i.e., core/greenroom)
682 + --zip Download files as a zip.
683 + -i, --geid Enable downloading by geid.
684 + --help Show this message and exit.
685 +{{/code}}
686 +
687 +=== Examples ===
688 +
689 +Download a file or a folder from the Core zone of a Project:
690 +
691 +{{code language="none"}}
692 +$ pilotcli file sync cli/admin/sample_file2 -z core ~/Downloads/
693 +Preparing status: READY_FOR_DOWNLOADING
694 +start downloading...
695 +Downloading sample_file2 |██████████████████████████████ 100% 00:00
696 +File has been downloaded successfully and saved to: /home/uname/Downloads/sample_file2
697 +{{/code}}
698 +
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 +
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}}
709 +
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 +
625 625  ----
626 626  
627 627  -
... ... @@ -631,5 +631,4 @@
631 631  
632 632  Copyright © 2023 [[Indoc Research>>url:https://www.indocresearch.org/]].
633 633  
634 -HealthDataCloud is powered by Pilot technology, a product of [[Indoc Research>>url:https://www.indocresearch.org/]].~{~{/code}}
635 -~)~)~)
795 +HealthDataCloud is powered by Pilot technology, a product of [[Indoc Research>>url:https://www.indocresearch.org/]].