Package Exports

splash-cli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (splash-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Splash CLI

Get stunning wallpapers from Unsplash

Splash CLI is an Unsplash client powered by NodeJS. You can use it as an Unsplash terminal client, for example you can:

Change wallpaper on your desktop
Like or download photos.
Create new collections
Edit collections
~~Upload photos~~ (See #47)

Terminal Setup

👀 Looking for maintainers! 👀

💾 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 (FAQ) can be found here

- What is Splash CLI?

Splash CLI is an Unsplash client powered by NodeJS.

You can use it to:

Change wallpaper on your desktop.

Create new collections (soon)

Like or download photos.

Download photos by ID.

Pick random photo from an user or a collection.

- Why did you make it?

When I wrote Splash CLI it was just for fun, I never tought that someone could find this tool so useful/funny 😅

🐾 Usage

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


  Get beautiful wallpapers from unsplash.

  Usage [v3.4.10]

      $ splash [command] [flags]

  Commands
      settings <get|set|restore>	GET/SET/RESTORE SETTINGS
      alias <get|set|remove>		GET/SET COLLECTION ALIASES
      collection <get|delete>		MANAGE COLLECTIONS
      dir <clean|get|count>		MANAGE THE DOWNLOAD DIRECTORY
      user <login|logout|get|...> 	MANAGE USER LOGIN/LOGOUT - GET USER INFOS
      -------------------------------------------------------------------------
      HINT: use `[command] help` for the list of all options

  Options
      -h --help			THIS MESSAGE
      -v --version			v3.4.10

      --scale <auto|fill|fit|stretch|center>  SET WALLPAPER SCALE
      --screen <all|main|monitor number>	SET AS WALLPAPER ON SELECTED MONITOR
      --orientation <landscape|portrait|squarish> SET WALLPAPER ORIENTATION (DEFAULT: 'landscape')

      -s --save [optional_path] 	DOWNLOAD WITHOUT SETTING AS WALLPAPER
      --set <path> 			SET GIVEN PHOTO AS WALLPAPER

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


  Source Filters
      -c --curated			RANDOM CURATED PHOTO
      -u --user <username>		RANDOM PHOTO FROM PROVIDED USER

      --day				GET THE PHOTO OF THE DAY
      --id <id or url>		PHOTO BY ID
      --collection <id or alias>	RANDOM PHOTO FROM PROVIDED COLLECTION

  Search Filters
      -f --featured			LIMIT TO ONLY FEATURED PHOTOS
      --query <query>			RANDOM FROM QUERY

Suggested Collections

Editorial (317099) - A collection of beautiful photos, curated by the Unsplash Team.
Wallpapers (1065976) - Free stunning HD wallpapers for your mobile and desktop screens.
Textures & Patterns (3330445) - Find your next perfect texture or pattern in high-quality.

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.

Splash CLI Website — Powered by Next.js you can take a look at the code here.
🔥StockPapers 🔥 — Looking for mobile wallpapers? StockPapers is the solution!
Unsplash — Free do whatever you want high-resolution photos.
Collections Downloader — Download Unsplash collections (written in Python)

Made with love by Federico Vitale in 🇮🇹

Twitter - Official Website - Instagram

splash-cli