Home

Shock Client Command Line Interface:

This is the output from the shock-client help command.

shock-client help

Usage: shock-client [options...] [args..] Global Options: -conf Config file location (default ~/.shock-client.cfg)

Commands: help This help message create [options...] -attributes= JSON formated attribute file Note: Attributes will replace all current attributes Mutualy exclusive options: -full= Path to file -parts=

Number of parts to be uploaded -virtual_file= Comma seperated list of node ids -remote_path=

Remote file path

pcreate [options...] -full= Path to file -threads= number of threads to use for uploading (default 4)

Note: parallel uploading for the whole file.

update [options...] -part=

-file= The part number to be uploaded and path to file Note: parts must be set Note: With the inclusion of part update options are the same as create.

get

download [options...] [] -index= Name of index (must be used with -parts) -parts={p} Part(s) from index, may be a range eg. 1-10 -index_options= Additional index options. Varies by index type

Note: if output is not present the download will be written to stdout.

pdownload [options...] [] -threads= number of threads to use for downloading (default 4)

Note: parallel download for the whole file. if output is not present the download will 
      be written to a file named as the shock node id.

acl <add/rm> <all/read/write/delete> Note: users are in the form of comma delimited list of email address or uuids

chown Note: user is email address or uuid

auth show Displays username of currently authenticated user set Prompts for user authentication and store credentials set-token Stores credentials from token unset Deletes stored credentials

2. Setting up the shock-client.cfg file.

There is an example shock client configuration file in the top level directory of the Shock repository.

[Cache] dir=/tmp

server is the location of the running shock server.

[Server] url=http://shock.example.com

[Auth]

defaults to local user management with basis auth

#type=basic

comment line above and uncomment below to use Globus Online as auth provider

type=globus token_url=https://nexus.api.globusonline.org/goauth/token?grant_type=client_credentials profile_url=https://nexus.api.globusonline.org/users