Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Requirements


Your system must have Python 3.6.x or greater installed, and boto3 if accessing S3 resources such as acacia or aws.

Note

A prepackaged python executable for pshell is available from here.

Running


From the command line you can start the pshell as follows:

Code Block
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:

Code Block
portal:> remote
portal               not connected to: https://data.pawsey.org.au:443
public               not connected to: https://data.pawsey.org.au:443
aws                  not connected to: 'ap-southeast-2'
pawsey0002           not connected to: https://acacia.pawsey.org.au

New remotes can be added that point to either a Mediaflux server or an S3 resources, such as Acacia or AWS-S3 - see the guide for more details.

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.

Code Block
portal:>login
Username: sean
Password:

portal:> remote
portal               authenticated to: https://data.pawsey.org.au/aterm as user=ivec:sean
public               not connected to: https://data.pawsey.org.au:443

You can now navigate (cdls) and transfer files (putget) 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

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.

Code Block
portal:/>help

Documented commands (type help <topic>):
========================================
cd        exit  import  lls     lpwd   processes  pwd     rm       
delegate  get   info    login   ls     publish    quit    rmdir    
ec2       help  lcd     logout  mkdir  put        remote  unpublish

portal:/>help info

Return information for a remote file or folder

Usage: info <filename/folder>