shootproof/shootproof-cli

A command line client for interacting with the ShootProof API

1.2.1 2016-11-23 14:08 UTC

README

Command line client for interacting with the ShootProof API.

Build Status

Installation

NOTICE: Your system must have PHP 5.4 or later installed in order to use the ShootProof command line tool. This tool is not currently supported on Windows, as it makes use of POSIX functions.

Download the shootproof-cli.phar file from the latest release and place it in /usr/local/bin or wherever it's accessible from your PATH.

$ chmod +x shootproof-cli.phar
$ mv shootproof-cli.phar /usr/local/bin/shootproof-cli

Now shootproof-cli should be available for you to use from the command line.

Optionally, you may clone this repository and build the phar file yourself.

Usage

shootproof-cli <command> [options]

Supported Commands

  • help [command] - gets usage instructions for the script or for a script command
  • push - uploads photos to a ShootProof event or album
  • pull - downloads photos from a ShootProof event or album
  • accesslevel - sets the access level for a ShootProof event

Configuration

This client requires certain options to be set which may be set explicitly on the command line, or in a configuration file. The default location of the configuration file is ~/.shootproof.

The configuration file may contain some or all of the following settings:

appId=<id>
accessToken=<token>
verbosity=<level>
haltOnError=true
retryLimit=<limit>
email=<email>

See .shootproof-sample for a minimal example of the configuration file.

Required Permissions

For this script to operate properly, you must have an access token authorized for the following scopes:

  • sp.album.create
  • sp.album.get_photos
  • sp.brand.get_list
  • sp.event.create
  • sp.event.get_photos
  • sp.event.set_access_level
  • sp.photo.upload
  • sp.photo.delete

Non-expiring access tokens are available from ShootProof on request.

Contributing

We welcome any bugfixes or enhancements that you would like to offer. Please see CONTRIBUTING.md for instructions.

License

Copyright © 2014-2016 ShootProof, LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.