xplr

Hackable terminal file explorer

TLDR

Start xplr

$ xplr

Start in directory

$ xplr [/path/to/dir]

Pipe selection to command

$ xplr | xargs [command]

Start with config

$ xplr --config [config.lua]

Read paths from stdin

$ find . -name "*.txt" | xplr

Print and quit (on selection)

$ xplr --print-pwd-as-result

SYNOPSIS

xplr [--config file] [--print-pwd-as-result] [options] [paths]

xplr is a hackable, minimal terminal file explorer. Written in Rust, it's fast and highly configurable.Lua configuration enables complete customization. Modes, keybindings, and UI can be redefined entirely.Selection handling pipes to stdout. This enables integration with other commands and scripts.Modes define behavior sets. Normal mode, selection mode, and custom modes provide context-aware keybindings.Plugins extend functionality. Community plugins add features like preview, bulk rename, and integration.The focus is on composition with Unix tools rather than built-in features for everything.

PARAMETERS

--config FILE

Configuration file.

--print-pwd-as-result

Print current directory on exit instead of focused path.

-C NAME=VALUE

Override config value.

--read-only

Read-only mode (disables all write operations).

--vroot PATH

Set virtual root to restrict navigation boundary.

-m MSG

Send a message to xplr for processing.

-M MSG

Send a message to xplr without quoting the value.

--version, -V

Show version.

--help, -h

Show help.

KEY BINDINGS

j/k or down/up

Navigate.

Enter

Open/select.

Quit.

Search.

space

Toggle selection.

Go to parent.

Go to path.

Toggle hidden.

ctrl-c

Cancel.

INSTALL

sudo pacman -S xplr

sudo apk add xplr

sudo zypper install xplr

brew install xplr

nix profile install nixpkgs#xplr

CAVEATS

Steep learning curve for configuration. Fewer built-in features than ranger. Lua knowledge helpful for customization.

HISTORY

xplr was created by Arijit Basu around 2021 as an extensible file explorer. It emphasizes hackability and composition over built-in features.