Skip to content

prakhar64/splash-cli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Downloads Version Travis CI


Splash CLI

Get beautiful wallpapers from Unsplash

💾 Installation

To install splash-cli you must use a node package manager such as yarn or npm.

	# With NPM
	$ npm install --global splash-cli

	# With Yarn
	$ yarn global add splash-cli

FAQs

A list of Frequently Asked Questions can be found here

🐾 Usage

Splash is easy and quick to use, just run splash to get started.

  $ splash [command] [flags]

  Commands
  	settings <get|set|restore>	GET/SET/RESTORE SETTINGS
  	alias <get|set|remove>			GET/SET COLLECTION ALIASES

  Options
  	-h --help			    THIS MESSAGE
  	-v --version			3.0.1

    ** MACOS ONLY **
  	--scale <auto|fill|fit|stretch|center>    SET WALLPAPER SCALE
  	--screen <all|main|monitor number>    	  SET AS WALLPAPER ON SELECTED MONITOR

  	-s --save [optional_path] 	              DOWNLOAD WITHOUT SETTING AS WALLPAPER

  	-i --info			  SHOW EXIF
  	-q --quiet			NO OUTPUT


  Source Filters
  	-u --user <username>		  RANDOM PHOTO FROM PROVIDED USER
  	--collection <id|alias>		RANDOM PHOTO FROM PROVIDED COLLECTION
  	-c --curated			        RANDOM CURATED PHOTO
  	--id <id|url>			        PHOTO BY ID
  	--day				              GET THE PHOTO OF THE DAY
	
  Search Filters
  	-f --featured			  LIMIT TO ONLY FEATURED PHOTOS
  	--query <query>			RANDOM FROM QUERY

Usage as module

splash([flags])

flags

All the CLI flags/options (no commands, such as settings or aliases).

  import splash from 'splash-cli';

  splash({ quiet: true, screen: 'main', collection: 317099 })

Contributors

List of awesome people that have helped to keep this project alive:

How can I contribute?

Hi thank you for the interest! Here you can find all what you need to know about and here you can find some things that I'd like to improve.

👾 Related Stuff


Twitter - Official Website - Instagram

About

📸 Beautiful wallpapers from Unsplash 🖼️🛠️

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%