xplr/README.md
2021-04-06 13:24:56 +05:30

54 lines
2.0 KiB
Markdown

<h1 align="center">xplr</h1>
<p align="center">
A hackable, minimal, fast TUI file explorer, stealing ideas from <a href="https://github.com/jarun/nnn">nnn</a> and <a href="https://github.com/junegunn/fzf">fzf</a>.
</p>
<p align="center">
<a href="https://crates.io/crates/xplr" target="_blank">
<img src="https://img.shields.io/crates/v/xplr.svg" />
</a>
<a href="https://github.com/sayanarijit/xplr/actions/workflows/ci.yml" target="_blank">
<img src="https://github.com/sayanarijit/xplr/actions/workflows/ci.yml/badge.svg" />
</a>
<a href="https://github.com/sayanarijit/xplr/actions/workflows/cd.yml" target="_blank">
<img src="https://github.com/sayanarijit/xplr/actions/workflows/cd.yml/badge.svg" />
</a>
</p>
<p align="center">
<a href="https://asciinema.org/a/3THQPXNVi801Yu8nWxO6qfUa4" target="_blank">
<img src="https://s4.gifyu.com/images/xplr.gif" />
</a>
</p>
<h3 align="center">
[<a href="https://github.com/sayanarijit/xplr/wiki/Quickstart">Quickstart</a>]
[<a href="https://github.com/sayanarijit/xplr/wiki/Features">Features</a>]
[<a href="https://github.com/sayanarijit/xplr/wiki/Plugins">Plugins</a>]
[<a href="https://github.com/sayanarijit/xplr/wiki">Documentation</a>]
[<a href="https://github.com/sayanarijit/xplr/wiki/Upgrade-Guide">Upgrade Guide</a>]
[<a href="https://github.com/sayanarijit/xplr/wiki/TODO">TODO</a>]
</h3>
<br>
Though [xplr](https://github.com/sayanarijit/xplr) strives to be fast and minimalist, its speciality is its hackability.
Once you read the [documentation](https://github.com/sayanarijit/xplr/wiki), you should be able to configure the key bindings,
different run modes, and also the way it looks by modifying one single configuration file.
<p align="center">
<a href="https://asciinema.org/a/404815" target="_blank">
<img src="https://s4.gifyu.com/images/xplr9d8b7b05c6bc39ae.gif" />
</a>
</p>
If you come up with something cool, or if you feel it's lacking somewhere in portability, flexibility or performance, don't hesitate to
[start a conversation](https://github.com/sayanarijit/xplr/discussions/2).