xplr/en/awesome-hacks.html
2023-05-15 08:51:26 +00:00

648 lines
30 KiB
HTML

<!DOCTYPE HTML>
<html lang="en" class="sidebar-visible no-js dark">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Awesome Hacks - xplr book</title>
<!-- Custom HTML head -->
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<meta name="description" content="A hackable, minimal, fast TUI file explorer">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">
<!-- Custom theme stylesheets -->
<!-- EthicalAds -->
<script async src="https://media.ethicalads.io/media/client/ethicalads.min.js"></script>
</head>
<body>
<!-- Provide site root to javascript -->
<script type="text/javascript">
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "coal" : "dark";
</script>
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script type="text/javascript">
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script type="text/javascript">
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('dark')
html.classList.add(theme);
html.classList.add('js');
</script>
<!-- Hide / unhide sidebar before it is displayed -->
<script type="text/javascript">
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<div class="sidebar-scrollbox">
<ol class="chapter"><li class="chapter-item expanded "><a href="introduction.html"><strong aria-hidden="true">1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="quickstart.html"><strong aria-hidden="true">2.</strong> Quickstart</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="install.html"><strong aria-hidden="true">2.1.</strong> Install</a></li><li class="chapter-item expanded "><a href="post-install.html"><strong aria-hidden="true">2.2.</strong> Post Install</a></li></ol></li><li class="chapter-item expanded "><a href="configuration.html"><strong aria-hidden="true">3.</strong> Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="general-config.html"><strong aria-hidden="true">3.1.</strong> General</a></li><li class="chapter-item expanded "><a href="node_types.html"><strong aria-hidden="true">3.2.</strong> Node Types</a></li><li class="chapter-item expanded "><a href="layouts.html"><strong aria-hidden="true">3.3.</strong> Layouts</a></li><li class="chapter-item expanded "><a href="modes.html"><strong aria-hidden="true">3.4.</strong> Modes</a></li></ol></li><li class="chapter-item expanded "><a href="concept.html"><strong aria-hidden="true">4.</strong> Concept</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="key-bindings.html"><strong aria-hidden="true">4.1.</strong> Key Bindings</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="configure-key-bindings.html"><strong aria-hidden="true">4.1.1.</strong> Configure Key Bindings</a></li><li class="chapter-item expanded "><a href="default-key-bindings.html"><strong aria-hidden="true">4.1.2.</strong> Default Key Bindings</a></li><li class="chapter-item expanded "><a href="debug-key-bindings.html"><strong aria-hidden="true">4.1.3.</strong> Debug Key Bindings</a></li></ol></li><li class="chapter-item expanded "><a href="node-type.html"><strong aria-hidden="true">4.2.</strong> Node Type</a></li><li class="chapter-item expanded "><a href="layout.html"><strong aria-hidden="true">4.3.</strong> Layout</a></li><li class="chapter-item expanded "><a href="mode.html"><strong aria-hidden="true">4.4.</strong> Mode</a></li><li class="chapter-item expanded "><a href="message.html"><strong aria-hidden="true">4.5.</strong> Message</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="messages.html"><strong aria-hidden="true">4.5.1.</strong> Full List of Messages</a></li><li class="chapter-item expanded "><a href="input-operation.html"><strong aria-hidden="true">4.5.2.</strong> Input Operation</a></li></ol></li><li class="chapter-item expanded "><a href="borders.html"><strong aria-hidden="true">4.6.</strong> Borders</a></li><li class="chapter-item expanded "><a href="style.html"><strong aria-hidden="true">4.7.</strong> Style</a></li><li class="chapter-item expanded "><a href="searching.html"><strong aria-hidden="true">4.8.</strong> Searching</a></li><li class="chapter-item expanded "><a href="sorting.html"><strong aria-hidden="true">4.9.</strong> Sorting</a></li><li class="chapter-item expanded "><a href="filtering.html"><strong aria-hidden="true">4.10.</strong> Filtering</a></li><li class="chapter-item expanded "><a href="column-renderer.html"><strong aria-hidden="true">4.11.</strong> Column Renderer</a></li><li class="chapter-item expanded "><a href="lua-function-calls.html"><strong aria-hidden="true">4.12.</strong> Lua Function Calls</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="xplr.util.html"><strong aria-hidden="true">4.12.1.</strong> xplr.util</a></li></ol></li><li class="chapter-item expanded "><a href="environment-variables-and-pipes.html"><strong aria-hidden="true">4.13.</strong> Environment Variables and Pipes</a></li></ol></li><li class="chapter-item expanded "><a href="awesome-hacks.html" class="active"><strong aria-hidden="true">5.</strong> Awesome Hacks</a></li><li class="chapter-item expanded "><a href="plugin.html"><strong aria-hidden="true">6.</strong> Plugin</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="installing-plugins.html"><strong aria-hidden="true">6.1.</strong> Installing Plugins</a></li><li class="chapter-item expanded "><a href="writing-plugins.html"><strong aria-hidden="true">6.2.</strong> Writing Plugins</a></li><li class="chapter-item expanded "><a href="awesome-plugins.html"><strong aria-hidden="true">6.3.</strong> Awesome Plugins</a></li></ol></li><li class="chapter-item expanded "><a href="integration.html"><strong aria-hidden="true">7.</strong> Integration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="awesome-integrations.html"><strong aria-hidden="true">7.1.</strong> Awesome Integrations</a></li></ol></li><li class="chapter-item expanded "><a href="alternatives.html"><strong aria-hidden="true">8.</strong> Alternatives</a></li><li class="chapter-item expanded "><a href="upgrade-guide.html"><strong aria-hidden="true">9.</strong> Upgrade Guide</a></li><li class="chapter-item expanded "><a href="community.html"><strong aria-hidden="true">10.</strong> Community</a></li><li class="chapter-item expanded "><a href="contribute.html"><strong aria-hidden="true">11.</strong> Contribute</a></li></ol>
<!-- EthicalAds -->
<div
id="docs-sidebar-bottom"
class="dark flat"
data-ea-publisher="xplrdev"
data-ea-type="image"
></div>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky bordered">
<div class="left-buttons">
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</button>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">xplr book</h1>
<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/sayanarijit/xplr" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>
<a href="https://github.com/sayanarijit/xplr/edit/main/docs/en/src/awesome-hacks.md" title="Suggest an edit" aria-label="Suggest an edit">
<i id="git-edit-button" class="fa fa-edit"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script type="text/javascript">
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="awesome-hacks"><a class="header" href="#awesome-hacks">Awesome Hacks</a></h1>
<p>Here's a list of cool xplr hacks, i.e. snippets of code that you can just copy
and paste into your <a href="configuration.html">configuration</a> or the appropriate file, that are
too small or too niche for a full fledge <a href="plugin.html">plugin</a>.</p>
<p>Do you have something cool to share?</p>
<p><a href="https://github.com/sayanarijit/xplr/edit/main/docs/en/src/awesome-hacks.md">Edit this file</a> or <a href="https://github.com/sayanarijit/xplr/discussions/categories/show-and-tell">share them here</a> or <a href="community.html">let us know</a>.</p>
<p>You can try these hacks by writing them to a file, say <code>hack.lua</code> and passing
it to xplr with <code>--extra-config</code> or <code>-C</code>.</p>
<pre><code class="language-bash">xplr -C hack.lua
</code></pre>
<h3 id="cd-on-quit"><a class="header" href="#cd-on-quit">cd on quit</a></h3>
<p>Change directory using xplr.</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/sayanarijit">@sayanarijit</a></li>
<li>Tested on: Linux</li>
</ul>
<p>NOTE: This is a shell hack, rather than Lua config hack. Add this in
<code>.bashrc</code> or <code>.profile</code> file in your home directory.</p>
<p>With this alias set, you can navigate directories using xplr by entering
xcd command, and when you quit by pressing enter, you will enter the
directory.</p>
<p>You can of course, quit with plain Quit (i.e. by pressing q) to
gracefully cancel &quot;cd on quit&quot;.</p>
<pre><code class="language-bash">alias xcd='cd &quot;$(xplr --print-pwd-as-result)&quot;'
</code></pre>
</details>
<h3 id="spawn-multiple-sessions-in-different-tabs-iterm2"><a class="header" href="#spawn-multiple-sessions-in-different-tabs-iterm2">Spawn multiple sessions in different tabs (iTerm2)</a></h3>
<p>Creating a new session that starts with iTerm2.</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/lmburns">@lmburns</a></li>
<li>Requires: iTerm2</li>
<li>Tested on: MacOS</li>
</ul>
<pre><code class="language-lua">xplr.config.modes.builtin.default.key_bindings.on_key[&quot;ctrl-n&quot;] = {
help = &quot;new session&quot;,
messages = {
{ BashExecSilently = [[
osascript &lt;&lt;EOF
tell application &quot;iTerm2&quot;
tell current window
create tab with default profile
tell current session to write text &quot;xplr&quot;
end tell
end tell
]]
},
},
}
</code></pre>
</details>
<h3 id="bookmark"><a class="header" href="#bookmark">Bookmark</a></h3>
<p>Bookmark files using <code>m</code> and fuzzy search bookmarks using backtick.</p>
<details>
<summary>Expand for details</summary>
<p><a href="https://gifyu.com/image/rGSR"><img src="https://s4.gifyu.com/images/xplr-bookmark.gif" alt="xplr-bookmark.gif" /></a></p>
<ul>
<li>Author: <a href="https://github.com/sayanarijit">@sayanarijit</a></li>
<li>Requires: fzf</li>
<li>Tested on: Linux</li>
</ul>
<pre><code class="language-lua">xplr.config.modes.builtin.default.key_bindings.on_key.m = {
help = &quot;bookmark&quot;,
messages = {
{
BashExecSilently0 = [===[
PTH=&quot;${XPLR_FOCUS_PATH:?}&quot;
PTH_ESC=$(printf %q &quot;$PTH&quot;)
if echo &quot;${PTH:?}&quot; &gt;&gt; &quot;${XPLR_SESSION_PATH:?}/bookmarks&quot;; then
&quot;$XPLR&quot; -m 'LogSuccess: %q' &quot;$PTH_ESC added to bookmarks&quot;
else
&quot;$XPLR&quot; -m 'LogError: %q' &quot;Failed to bookmark $PTH_ESC&quot;
fi
]===],
},
},
}
xplr.config.modes.builtin.default.key_bindings.on_key[&quot;`&quot;] = {
help = &quot;go to bookmark&quot;,
messages = {
{
BashExec0 = [===[
PTH=$(cat &quot;${XPLR_SESSION_PATH:?}/bookmarks&quot; | fzf --no-sort)
PTH_ESC=$(printf %q &quot;$PTH&quot;)
if [ &quot;$PTH&quot; ]; then
&quot;$XPLR&quot; -m 'FocusPath: %q' &quot;$PTH&quot;
fi
]===],
},
},
}
</code></pre>
</details>
<h3 id="persistent-multi-session-bookmark"><a class="header" href="#persistent-multi-session-bookmark">Persistent, multi-session bookmark</a></h3>
<p>A bookmark mode that allows for a bookmark file to be used throughout multiples
sessions. It is set to the environment variable <code>$XPLR_BOOKMARK_FILE</code>. A
bookmark can be added, deleted, or jumped to.</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/lmburns">@lmburns</a></li>
<li>Requires: fzf, sd</li>
<li>Tested on: MacOS</li>
</ul>
<pre><code class="language-lua">-- With `export XPLR_BOOKMARK_FILE=&quot;$HOME/bookmarks&quot;`
-- Bookmark: mode binding
xplr.config.modes.builtin.default.key_bindings.on_key[&quot;b&quot;] = {
help = &quot;bookmark mode&quot;,
messages = {
{ SwitchModeCustom = &quot;bookmark&quot; },
},
}
xplr.config.modes.custom.bookmark = {
name = &quot;bookmark&quot;,
key_bindings = {
on_key = {
m = {
help = &quot;bookmark dir&quot;,
messages = {
{
BashExecSilently0 = [[
PTH=&quot;${XPLR_FOCUS_PATH:?}&quot;
if [ -d &quot;${PTH}&quot; ]; then
PTH=&quot;${PTH}&quot;
elif [ -f &quot;${PTH}&quot; ]; then
PTH=$(dirname &quot;${PTH}&quot;)
fi
PTH_ESC=$(printf %q &quot;$PTH&quot;)
if echo &quot;${PTH:?}&quot; &gt;&gt; &quot;${XPLR_BOOKMARK_FILE:?}&quot;; then
&quot;$XPLR&quot; -m 'LogSuccess: %q' &quot;$PTH_ESC added to bookmarks&quot;
else
&quot;$XPLR&quot; -m 'LogError: %q' &quot;Failed to bookmark $PTH_ESC&quot;
fi
]],
},
&quot;PopMode&quot;,
},
},
g = {
help = &quot;go to bookmark&quot;,
messages = {
{
BashExec0 = [===[
PTH=$(cat &quot;${XPLR_BOOKMARK_FILE:?}&quot; | fzf --no-sort)
if [ &quot;$PTH&quot; ]; then
&quot;$XPLR&quot; -m 'FocusPath: %q' &quot;$PTH&quot;
fi
]===],
},
&quot;PopMode&quot;,
},
},
d = {
help = &quot;delete bookmark&quot;,
messages = {
{
BashExec0 = [[
PTH=$(cat &quot;${XPLR_BOOKMARK_FILE:?}&quot; | fzf --no-sort)
sd &quot;$PTH\n&quot; &quot;&quot; &quot;${XPLR_BOOKMARK_FILE:?}&quot;
]],
},
&quot;PopMode&quot;,
},
},
esc = {
help = &quot;cancel&quot;,
messages = {
&quot;PopMode&quot;,
},
},
},
},
}
</code></pre>
</details>
<h3 id="another-bookmark-manager-type-thing-taken-from-wfxrs-zsh-plugin"><a class="header" href="#another-bookmark-manager-type-thing-taken-from-wfxrs-zsh-plugin">Another bookmark manager type thing, taken from <a href="https://github.com/wfxr/formarks">wfxr's zsh plugin</a>.</a></h3>
<p>Another bookmark manager type thing, taken from <a href="https://github.com/wfxr/formarks">wfxr's zsh plugin</a> which has colored output with fzf.</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/lmburns">@lmburns</a></li>
<li>Requires: fzf, exa</li>
<li>Tested on: MacOS</li>
</ul>
<pre><code class="language-lua">xplr.config.modes.builtin.go_to.key_bindings.on_key.b = {
help = &quot;bookmark jump&quot;,
messages = {
&quot;PopMode&quot;,
{ BashExec0 = [===[
field='\(\S\+\s*\)'
esc=$(printf '\033')
N=&quot;${esc}[0m&quot;
R=&quot;${esc}[31m&quot;
G=&quot;${esc}[32m&quot;
Y=&quot;${esc}[33m&quot;
B=&quot;${esc}[34m&quot;
pattern=&quot;s#^${field}${field}${field}${field}#$Y\1$R\2$N\3$B\4$N#&quot;
PTH=$(sed 's#: # -&gt; #' &quot;$PATHMARKS_FILE&quot;| nl| column -t \
| gsed &quot;${pattern}&quot; \
| fzf --ansi \
--height '40%' \
--preview=&quot;echo {}|sed 's#.*-&gt; ##'| xargs exa --color=always&quot; \
--preview-window=&quot;right:50%&quot; \
| sed 's#.*-&gt; ##')
if [ &quot;$PTH&quot; ]; then
&quot;$XPLR&quot; -m 'ChangeDirectory: %q' &quot;$PTH&quot;
fi
]===]
},
}
}
</code></pre>
</details>
<h3 id="fuzzy-search-history"><a class="header" href="#fuzzy-search-history">Fuzzy search history</a></h3>
<p>Fuzzy search the last visited directories.</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/sayanarijit">@sayanarijit</a></li>
<li>Requires: fzf</li>
<li>Tested on: Linux</li>
</ul>
<pre><code class="language-lua">xplr.config.modes.builtin.go_to.key_bindings.on_key.h = {
help = &quot;history&quot;,
messages = {
&quot;PopMode&quot;,
{
BashExec0 = [===[
PTH=$(cat &quot;${XPLR_PIPE_HISTORY_OUT:?}&quot; | sort -z -u | fzf --read0)
if [ &quot;$PTH&quot; ]; then
&quot;$XPLR&quot; -m 'ChangeDirectory: %q' &quot;$PTH&quot;
fi
]===],
},
},
}
</code></pre>
</details>
<h3 id="batch-rename"><a class="header" href="#batch-rename">Batch rename</a></h3>
<p>Batch rename the selected or visible files and directories in $PWD.</p>
<details>
<summary>Expand for details</summary>
<p><a href="https://gifyu.com/image/rGbo"><img src="https://s4.gifyu.com/images/xplr-rename.gif" alt="xplr-rename.gif" /></a></p>
<ul>
<li>Author: <a href="https://github.com/sayanarijit">@sayanarijit</a></li>
<li>Requires: <a href="https://github.com/marcusbuffett/pipe-rename">pipe-rename</a></li>
<li>Tested on: Linux</li>
</ul>
<pre><code class="language-lua">xplr.config.modes.builtin.default.key_bindings.on_key.R = {
help = &quot;batch rename&quot;,
messages = {
{
BashExec = [===[
SELECTION=$(cat &quot;${XPLR_PIPE_SELECTION_OUT:?}&quot;)
NODES=${SELECTION:-$(cat &quot;${XPLR_PIPE_DIRECTORY_NODES_OUT:?}&quot;)}
if [ &quot;$NODES&quot; ]; then
echo -e &quot;$NODES&quot; | renamer
&quot;$XPLR&quot; -m ExplorePwdAsync
fi
]===],
},
},
}
</code></pre>
</details>
<h3 id="serve-pwd"><a class="header" href="#serve-pwd">Serve $PWD</a></h3>
<p>Serve $PWD using a static web server via LAN.</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/sayanarijit">@sayanarijit</a></li>
<li>Requires: <a href="https://github.com/weihanglo/sfz">sfz</a>, fzf</li>
<li>Tested on: Linux</li>
</ul>
<pre><code class="language-lua">xplr.config.modes.builtin.default.key_bindings.on_key.S = {
help = &quot;serve $PWD&quot;,
messages = {
{
BashExec0 = [===[
IP=$(ip addr | grep -w inet | cut -d/ -f1 | grep -Eo '[0-9]{1,3}\.[0-9]{ 1,3}\.[0-9]{1,3}\.[0-9]{1,3}' | fzf --prompt 'Select IP &gt; ')
echo &quot;IP: ${IP:?}&quot;
read -p &quot;Port (default 5000): &quot; PORT
echo
sfz --all --cors --no-ignore --bind ${IP:?} --port ${PORT:-5000} . &amp;
sleep 1 &amp;&amp; read -p '[press enter to exit]'
kill -9 %1
]===],
},
},
}
</code></pre>
</details>
<h3 id="image-viewer-imv"><a class="header" href="#image-viewer-imv">Image viewer (imv)</a></h3>
<p>Preview images using <a href="https://sr.ht/%7Eexec64/imv">imv</a>.</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/sayanarijit">@sayanarijit</a></li>
<li>Requires: <a href="https://sr.ht/%7Eexec64/imv">imv</a>, <a href="https://www.semicomplete.com/projects/xdotool">xdotool</a></li>
<li>Tested on: Linux, FreeBSD 13.1-RELEASE</li>
</ul>
<pre><code class="language-lua">xplr.config.modes.builtin.default.key_bindings.on_key.P = {
help = &quot;preview&quot;,
messages = {
{
BashExecSilently0 = [===[
FIFO_PATH=&quot;/tmp/xplr.fifo&quot;
if [ -e &quot;$FIFO_PATH&quot; ]; then
&quot;$XPLR&quot; -m StopFifo
rm -f -- &quot;$FIFO_PATH&quot;
else
mkfifo &quot;$FIFO_PATH&quot;
&quot;$HOME/.local/bin/imv-open.sh&quot; &quot;$FIFO_PATH&quot; &quot;$XPLR_FOCUS_PATH&quot; &amp;
&quot;$XPLR&quot; -m 'StartFifo: %q' &quot;$FIFO_PATH&quot;
fi
]===],
},
},
}
</code></pre>
<p>$HOME/.local/bin/imv-open.sh</p>
<pre><code class="language-bash">#!/usr/bin/env bash
FIFO_PATH=&quot;$1&quot;
IMAGE=&quot;$2&quot;
MAINWINDOW=&quot;$(xdotool getactivewindow)&quot;
IMV_PID=&quot;$(pgrep imv)&quot;
if [ ! &quot;$IMV_PID&quot; ]; then
imv &quot;$IMAGE&quot; &amp;
IMV_PID=$!
fi
sleep 0.5
xdotool windowactivate &quot;$MAINWINDOW&quot;
while read -r path; do
imv-msg &quot;$IMV_PID&quot; close all
imv-msg &quot;$IMV_PID&quot; open &quot;$path&quot;
done &lt; &quot;$FIFO_PATH&quot;
imv-msg &quot;$IMV_PID&quot; quit
[ -e &quot;$FIFO_PATH&quot; ] &amp;&amp; rm -f -- &quot;$FIFO_PATH&quot;
</code></pre>
</details>
<h3 id="text-preview-pane"><a class="header" href="#text-preview-pane">Text preview pane</a></h3>
<p>Preview text files in a native xplr pane (should be fast enough).</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/sayanarijit">@sayanarijit</a></li>
<li>Requires: none</li>
<li>Tested on: Linux, FreeBSD 13.1-RELEASE</li>
</ul>
<pre><code class="language-lua">local function stat(node)
return xplr.util.to_yaml(xplr.util.node(node.absolute_path))
end
local function read(path, height)
local p = io.open(path)
if p == nil then
return nil
end
local i = 0
local res = &quot;&quot;
for line in p:lines() do
if line:match(&quot;[^ -~\n\t]&quot;) then
p:close()
return
end
res = res .. line .. &quot;\n&quot;
if i == height then
break
end
i = i + 1
end
p:close()
return res
end
xplr.fn.custom.preview_pane = {}
xplr.fn.custom.preview_pane.render = function(ctx)
local title = nil
local body = &quot;&quot;
local n = ctx.app.focused_node
if n and n.canonical then
n = n.canonical
end
if n then
title = { format = n.absolute_path, style = xplr.util.lscolor(n.absolute_path) }
if n.is_file then
body = read(n.absolute_path, ctx.layout_size.height) or stat(n)
else
body = stat(n)
end
end
return { CustomParagraph = { ui = { title = title }, body = body } }
end
local preview_pane = { Dynamic = &quot;custom.preview_pane.render&quot; }
local split_preview = {
Horizontal = {
config = {
constraints = {
{ Percentage = 60 },
{ Percentage = 40 },
},
},
splits = {
&quot;Table&quot;,
preview_pane,
},
},
}
xplr.config.layouts.builtin.default =
xplr.util.layout_replace(xplr.config.layouts.builtin.default, &quot;Table&quot;, split_preview)
</code></pre>
</details>
<h3 id="tere-navigation"><a class="header" href="#tere-navigation">Tere Navigation</a></h3>
<p>Navigate using the <a href="https://github.com/mgunyho/tere">tere</a> file explorer (defaults to type-to-nav system).</p>
<details>
<summary>Expand for details</summary>
<ul>
<li>Author: <a href="https://github.com/sayanarijit">@sayanarijit</a></li>
<li>Requires: <a href="https://github.com/mgunyho/tere">tere</a></li>
<li>Tested on: Linux</li>
</ul>
<pre><code class="language-lua">xplr.config.modes.builtin.default.key_bindings.on_key.T = {
help = &quot;tere nav&quot;,
messages = {
{ BashExec0 = [[&quot;$XPLR&quot; -m 'ChangeDirectory: %q' &quot;$(tere)&quot;]] },
},
}
</code></pre>
</details>
<h2 id="also-see"><a class="header" href="#also-see">Also See:</a></h2>
<ul>
<li><a href="awesome-plugins.html">Awesome Plugins</a></li>
<li><a href="awesome-integrations.html">Awesome Integrations</a></li>
</ul>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="environment-variables-and-pipes.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="plugin.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="environment-variables-and-pipes.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next" href="plugin.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script type="text/javascript">
window.playground_copyable = true;
</script>
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
<script src="book.js" type="text/javascript" charset="utf-8"></script>
<!-- Custom JS scripts -->
</body>
</html>