Wallrs Documentation

user@docs:~$ cat welcome.txt

=========================================

WALLRS DOCUMENTATION

=========================================

This terminal interface provides documentation for wallrs.

Use the navigation menu above or type commands to explore.

Available sections:

- commands: Available terminal commands

- config: Application configuration options

- demo: Demonstration of features

- friendly projects: Projects that are inspired or use wallrs

- keybindings: Keybindings configuration options

CONFIGURATION OPTIONS

user@docs:~$ config --list

wallpaper_dir

The directory for the wallpapers.

vim_motion

Enable vim motion (hjkl) for navigation.
Example: vim_motion = true

mouse_support

Enable mouse support for navigation.
Example: mouse_support = true

list_position

Position of list and wallpapers preview.
Options: top, bottom, left, right
Example: list_position = "top"

pywal

Enable pywal integration.
Example: pywal = true

hellwal

Enable hellwal integration.
Example: hellwal = true

video

Enable mpvpaper integration (IMPORTANT: turn on only for mp4 videos).
Example: video = true

image_cache_size

The dimension of the caching image.

[[tabs]]

Tag that let you set the order and which tables are visible.

Example configuration file (config.toml):

wallpaper_dir = "~/Pictures/wallpapers"

vim_motion = true

mouse_support = true

list_position = "top"

pywal = true

hellwal = false

video = false

image_cache_size = 100

[[tabs]]
name = "Wallpapers"
enabled = true

[[tabs]]
name = "Favorites"
enabled = true

[[tabs]]
name = "History"
enabled = true

KEYBINDINGS

user@docs:~$ keybindings --list

j / ↓

Move selection down

k / ↑

Move selection up

h / ←

Move selection left

l / →

Move selection right

Enter

Select/apply wallpaper

f

Toggle favorite (customizable)

v

Enter visual mode (customizable)

/

Search wallpapers (customizable)

r

Rename a wallpaper (customizable)

Esc

Quit application

Mouse bindings (if enabled):

Click

Select item

Scroll

Navigate list

Customization:

Keybindings for favorite, search, visual and rename mode can be customized in your keybindings.toml:

favorite = "f"      # Change favorite keybinding

search = "/"        # Change search keybinding  

multi_select = "v"  # Change visual mode keybinding

rename = "r"        # Change in rename mode keybinding

DEMO

user@docs:~$ demo --start

Select a demo above to see Wallrs in action!

🎥 Select a demo above to see Wallrs in action!