picloud(1)                                                           PiCloud                                                           picloud(1)



NAME
       picloud -- PiCloud Command-Line Interface

SYNOPSIS
       picloud [options] {setup,files,volume,realtime}

OPTIONS
       -h     show this help message and exit

       --version
              Print version

       -v     Increase amount of information you are given during command execution

       -o {json,no-header}
              Format of output

       -a _API_KEY
              API key to use

       -k _API_SECRET_KEY
               API secret key that matches the API key

DESCRIPTION
       picloud has the following modules to facilitate interacting with PiCloud:

   setup
       This module is used to setup your client computer to use the cloud. Optional Arguments:

       --help,-h: show this help message and exit

       --email EMAIL, -e EMAIL:    Email used to login to your PiCloud account

       --password PASSWORD, -p PASSWORD : Password used to login to your PiCloud account

       --api-key [API_KEY], -a [API_KEY]: API Key to use. If specified without a value, a new API Key will be created without prompting

   files
       This module is used for managing files stored on PiCloud

       Optional Arguments:

       --help,-h            show this help message and exit

       Commands:  {sync-to-cloud,get,sync-from-cloud,list,put,get-md5,delete}

          delete              Delete a file stored on PiCloud
          get                 Retrieve a file from PiCloud
          get-md5             Get the md5 checksum of a file stored on PiCloud
          list                List files in PiCloud Storage
          put                 Store a file on PiCloud
          sync-from-cloud     Download file if it does not exist locally or
                              has changed
          sync-to-cloud       Upload file only if it does not exist on PiCloud                        or has changed

   volume
       This module is used for managing volumes stored on PiCloud

       Optional Arguments: --help, -h            show this help message and exit

       Commands: {create,list,sync,ls,rm,delete}

          list                List existing volumes
          create              Create a volume on PiCloud
          sync                Sync local directory to volume on PiCloud
          delete              Delete a cloud volume
          ls                  List the contents of a cloud volume [path]
          rm                  Remove contents from a cloud volume

   realtime
       This module is used for managing realtime cores on PiCloud

       Optional arguments:
        --help, -h            show this help message and exit

       Commands:  {release,request,list}

          list                List realtime reservations
          release             Release realtime cores
          request             Request realtime cores

EXAMPLES
       List files on PiCloud's storage  :   picloud files list

       List existing volumes            :   picloud volume list

       List realtime reservations       :   picloud realtime list

LICENSE
       All  files  within  the PiCloud cloud client package distribution are subject to the GNU Lesser General Public License v 2.1. Refer to the
       LICENSE file of the source distribution for the details.


AUTHOR
       This  manual  page  was  written  by  extracting  information  from  the  'picloud'  help   documentation   provided   by   PiCloud   team
       (http://www.picloud.com).

       Maintained by Amit Saha (amitsaha.in@gmail.com).


SEE ALSO
       PiCloud Documentation: http://docs.picloud.com/




2.4.1                                                              Feb 24, 2012                                                        picloud(1)