README

bsclient v0.2a

Last updated 2015-03-10

DESCRIPTION

bsclient is a simple FTP-like command-line client for accessing and downloading data from an Illumina BASESPACE account.

LATEST UPDATE

v0.2a contains numerous bug-fixes:

• Fixed bug that made navigation difficult to projects/sample names containing spaces (now replaced with underscores)
• Fixed bug that raised exception in certain directory navigation patterns
• Fixed bug that affected subsequent attempts to 'get' after a 'file exists' warning
• Fixed bug that prevented file renaming in Windows
• Fixed minor bug in POD

v0.2a also switched from LWP to HTTP::Tiny, which greatly reduced the load on the CPU during file download.

PLATFORM

bsclient is written in Perl. It is developed and tested in a Linux environment and should work with most Linux distributions with the proper modules installed. It has been tested briefly in Windows 8.1 with ActiveState Perl and is functional, although it is lacking the Term::ReadLine::Gnu library and password masking does not work (tokens and passwords entered on the command line appear as clear text).

INSTALLATION

The program is a monolithic script. On Linux, installation should be as simple as installing the necessary dependencies, copying the script to an appropriate location and making it executable. Further details are left as an exercise for the reader.

Dependencies

bsclient makes use of the following non-core modules. Some are fairly common and likely to be installed on most common Linux distros, others may need to be installed prior to using this software.

• Crypt::CBC
• File::HomeDir
• HTTP::Tiny
• JSON
• List::MoreUtils
• Term::ReadLine::Gnu (for password masking)

USAGE

See the accompanying documentation or bsclient --help.