Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 1.91 KB

README.md

File metadata and controls

54 lines (40 loc) · 1.91 KB
Raw

wallhaven-cli

A CLI tool to download images from wallhaven.cc

📦 Installation

  1. Make sure you have installed Node.js and NPM
  2. Clone this repository or download source code from release page
  3. Run npm install to install dependencies
  4. Run npm install -g . to install wallhaven-cli
  5. Run wallhaven-cli to use wallhaven-cli

⚙️ Usage

Usage: wallhaven-cli [options] [command]

A CLI tool to download images from wallhaven

Options:
  -V, --version       output the version number
  -h, --help          display help for command

Commands:
  download [options]  Download images from wallhaven
  help [command]      display help for command
Usage: wallhaven-cli download [options] <pages>

Download images from wallhaven

Arguments:
  pages                   image pagination (24 images per page)

Options:
  -a, --api [value]       api key
  -c, --category <value>  image category (options: "all", "general", "anime", "people", "ga", "gp") (default: "all")
  -p, --purity <value>    image purity (options: "all", "sfw", "sketchy", "nsfw", "ws", "wn", "sn") (default: "sfw")
  -s, --sorting <value>   image sorting method (options: "date_added", "relevance", "random", "views", "favorites", "toplist")
                          (default: "toplist")
  -o, --order <value>     image sorting order (options: desc, asc) (default: "desc")
  -t, --topRange <value>  image time range (only for toplist) (options: 1d, 3d, 1w, 1M, 3M, 6M, 1y) (default: "1M")
  -r, --ratio [value]     image ratio (options: 16x9, 16x10, 4x3, 1x1)
  -h, --help              display help for command

💝 Thanks to