Skip to content

r3tr0ananas/wallhaven-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🖼️ wallhaven-cli

Search and download wallpapers from wallhaven.

📦 Installation

Prerequisites

Before installing wallhaven-cli, make sure your system meets the following requirements:

  • Supported platform:
    • Linux
  • Go:
    Required to build this project from the source.
  • fzf:
    Used for the selection menu. This is required.
  • kitty:
    Currently, kitty is required as the terminal emulator.

Installing

Once all prerequisites are met, you can install wallhaven-cli using one of the following methods:

1. Install via go install

go install github.com/r3tr0ananas/wallhaven-cli/wallhaven@latest

2. AUR

You can install wallhaven-cli via the AUR:

yay -S wallhaven-cli

If you use a different AUR helper then replace yay.

3. Download the Latest Release

Alternatively, you can download the latest release and move the binary to your ~/.local/bin directory.


🚀 Usage

View Available Options

To view all available commands and options, run:

wallhaven

Edit Configuration

You can customize the settings, such as specifying the folder where downloaded wallpapers will be saved. To edit the configuration, run:

wallhaven edit

This will open the configuration file, where you can set your preferred download directory.

Search Wallpapers

To search for wallpapers on Wallhaven, use the search command followed by your query:

wallhaven search [query]

For example:

wallhaven search mashiro shiina

Download Wallpapers

To download a specific wallpaper by its Wallhaven ID, use the following command:

wallhaven download [id]

For example, to download a wallpaper with the ID l35l5l:

wallhaven download l35l5l

Download Collections

To download wallpapers from a user’s collection, use the following command:

wallhaven collection [username]

Tip

To download all wallpapers from the collection, add the -a flag:

wallhaven collection [username] -a

🛠️ Contribution

Contributions are welcome! Feel free to submit issues or pull requests to help improve the project.

📄 License

This project is licensed under the MIT License.


🛠️ Contribution

Contributions are welcome! Feel free to submit issues or pull requests to help improve the project.

📄 License

This project is licensed under the MIT License.


Notes

  • Currently, kitty is mandatory as the terminal emulator, but future versions may support other terminals.