Requirements
Your system must have Python 3.6.x or greater installed, and boto3 if accessing S3 resources such as acacia or aws.
A prepackaged python executable for pshell is available from here.
Running
From the command line, you can start pshell as follows:
python3 pshell
Remotes
pshell maintains a list of registered remote servers and the current connection state. The active remote is shown in the left part of pshell's command prompt:
portal:> remote portal [ not connected ] * public [ not connected ] aws [ not connected ]
You can query the configuration of a particular remote as follows:
portal:/>remote portal --info name = portal type = mflux protocol = https server = data.pawsey.org.au port = 443 domain = ivec
New remotes can be added for an additional Mediaflux server (similar to the default portal and public) or for an S3 resource. For further information, see: pshell and S3 remotes.
Logging in
Authenticate to a remote using the appropriate credentials. In the case of the data portal it will be your Pawsey credentials. In the case of an S3 resource it will be your key and secret pair.
portal:>login Username: sean Password: portal:/>remote portal [ authenticated ] * public [ not connected ] aws [ not connected ]
You can now navigate (cd, ls) and transfer files (put, get) between your local filesystem and your remote storage resource.
Command syntax
The command line client implements a subset of the standard SFTP commands.
Remote filesystem commands: cd, ls, pwd, mkdir, rmdir
Local filesystem commands: lcd, lls, lpwd
Transfer commands: get, put
portal:/projects/Data Team>mkdir remotefolder portal:/projects/Data Team>cd remotefolder/ portal:/projects/Data Team/remotefolder/>ls 200032136 | 12 MB | remotefile portal:/projects/Data Team/remotefolder/>lcd localfolder Local: /Users/sean/localfolder portal:/projects/Data Team/remotefolder/>lls Local folder: /Users/sean/localfolder 3 MB | localfile portal:/projects/Data Team/remotefolder/>put localfile put: 1/1 files, errors=0, skipped=0, progress: 100.0% at 1.51 MB/s portal:/projects/Data Team/remotefolder/>get remotefile get: 1/1 files, errors=0, skipped=0, progress=100.0% at 3.1 MB/s portal:/projects/Data Team/remotefolder/>ls 200032136 | 12 MB | remotefile 200032137 | 3 MB | localfile portal:/projects/Data Team/remotefolder/>lls Local folder: /Users/sean/localfolder 12 MB | remotefile 3 MB | localfile
Finding out more
To see an overview of the available commands, type "help" at the prompt. You can also type "help <command>" to obtain specific help on the named command.
Standard commands ================= cd help lcd logout mkdir put remote unpublish exit import lls lpwd processes pwd rm whoami get info login ls publish quit rmdir Specialised commands ==================== delegate lifecycle policy