pxgamer/splas-runner

A cross-platform binary to change the desktop background from Unsplash.

v4.1.1 2018-11-13 11:21 UTC

README

Latest Version on Packagist Software License Build Status Style CI Code Coverage Total Downloads

A cross-platform binary to change the desktop background from Unsplash.
This package uses the splas-php composer package.

Install

Via Composer

$ composer global require pxgamer/splas-runner

Via Phive

$ phive install pxgamer/splas-runner

Usage

  • Get an API key from Unsplash
  • Either set the UNSPLASH_API_KEY environment variable, or provide a --key {key} option in the command
  • Run the binary using splasr [options]

Options

Name Description
--keep / -k Specify whether to keep or remove images. Defaults to remove any images before downloading.
--key Specify your API key. Defaults to use the environment variable.
--interval / -i Specify an integer (minutes) when running in looped mode. By default will exit after the first run.

Supported operating systems

OS Supported?
Windows
Mac OSX
Ubuntu
Linux

Note: Running in an unsupported OS will result in an ErrorException.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email owzie123@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.