Skip to content

DestinEcarma/paper-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

paper-tui

paper-tui is a terminal wallpaper picker for Linux, built with Rust and Ratatui. It lets you browse wallpapers from a folder, preview them directly inside the terminal, search by file name, and run a command after selecting one.

It is designed for setups that already use terminal-native wallpaper tools such as awww, and works best as a lightweight TUI frontend for your existing wallpaper workflow.

Preview

Terminal support

paper-tui renders image previews in the terminal, so it only works properly in terminals that support a terminal graphics protocol, such as Kitty, Ghostty, iTerm2, or Sixel-compatible terminals.

Note

Thumbnails are generated lazily and cached in your user cache directory for faster loading after the first run.

paper-tui is intended primarily for Linux desktop setups and is most useful when paired with an external wallpaper setter in post_command. It may also work with macOS; don't take my word for it.

Installation

Install from crates.io:

cargo install paper-tui

Build from source:

git clone https://github.com/DestinEcarma/paper-tui.git
cd paper-tui
cargo build --release
install -Dm755 target/release/paper-tui ~/.local/bin/paper-tui

The compiled binary will be available at:

target/release/paper-tui

Configuration

Config file location:

~/.config/paper-tui/config.toml

Example:

wallpapers_dir = "/home/user/Pictures"
post_command = "awww img {wallpaper} && matugen image {wallpaper} --source-color-index 1"

wallpapers_dir is the directory that paper-tui will scan for images. post_command is optional, and {wallpaper} will be replaced with the full path of the selected image.

Sponsor this project

 

Contributors

Languages