https://github.com/thehamkercat/wallrus
Wallrus is a simple wallpaper manager for linux.
https://github.com/thehamkercat/wallrus
cli cli-app cli-utilities feh hacktoberfest linux rust wallpaper wallpaper-changer
Last synced: 2 months ago
JSON representation
Wallrus is a simple wallpaper manager for linux.
- Host: GitHub
- URL: https://github.com/thehamkercat/wallrus
- Owner: TheHamkerCat
- License: mit
- Created: 2022-09-12T23:45:54.000Z (about 3 years ago)
- Default Branch: prod
- Last Pushed: 2022-10-01T07:22:59.000Z (about 3 years ago)
- Last Synced: 2024-05-01T18:21:55.734Z (over 1 year ago)
- Topics: cli, cli-app, cli-utilities, feh, hacktoberfest, linux, rust, wallpaper, wallpaper-changer
- Language: Rust
- Homepage:
- Size: 4.39 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wallrus
`Wallrus` is a simple and blazing-fast wallpaper manager for linux.
It wraps around [`feh`](https://github.com/derf/feh) to provide a simple, fast, feature-rich and user-friendly experience.
Quick links:
* [Features](#features)
* [Demo](#demo)
* [Usage](#usage)
* [Examples](#examples)
* [Installation](#installation)
## Features
- [x] Fetching wallpapers online.
- [x] Supports multiple monitor.
- [x] Automatically change wallpapers using [`cron`](https://crontab.guru/) expressions (wallpaper slideshow).
- [x] Supports multiple modes [center, fill, scale, tile]
- [x] Saving fetched wallpapers to a file.
- [x] Aquiring currently applied wallpaper and saving it to a file.
## Demo
## Usage
```console
$ wallrus --help
wallrus x.x.x
TheHamkerCat
A simple wallpaper manager for X11
USAGE:
wallrus
OPTIONS:
-h, --help Print help information
-V, --version Print version information
SUBCOMMANDS:
help Print this message or the help of the given subcommand(s)
set Set wallpaper by giving an image path or a query to search online.
$ wallrus set --help
Set wallpaper by giving an image path or a query to search online.
USAGE:
wallrus set [OPTIONS]
OPTIONS:
-c, --cron Add current wallpaper command to crontab to change wallpaper
automatically. (Only works with --query)
-h, --help Print help information
-m, --mode The mode to set the wallpaper. [default: fill] [possible values: center,
fill, scale, tile]
-p, --path Path to the wallpaper. Use $HOME instead of ~/
-q, --query The query to search for. Pass `trending` for trending wallpapers
-s, --save Save the newly fetched wallpaper in a new file. (Only works with --query)
-x, --noxinerama Disables Xinerama support, Making the wallpaper span across all monitors.
```
## Examples
### Set a local wallpaper
```console
$ wallrus set --path=/path/to/wallpaper.jpg
```
### Fetch & Set a wallpaper online
```console
$ wallrus set --query=batman
```
### Get trending ones instead
```console
$ wallrus set --query=trending
```
### Save wallpaper after setting
```console
$ wallrus set --query=batman --save=a.png
```
### Change wallpaper every hour
```console
$ wallrus set --query=avengers --cron="0 * * * *"
```
### Get current wallpaper and save it to a file
```console
$ wallrus get --file=wall.png
```
## Installation
```console
$ git clone https://github.com/TheHamkerCat/wallrus
$ cd wallrus
$ bash ./install.sh
```
make sure `.cargo/bin/` is in `$PATH`