2021-06-23 10:02:10 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Install - 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 = "icon" href = "favicon.svg" >
< 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 -->
< / 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 ? "navy" : "light";
< / 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('light')
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" >
2021-07-20 16:49:07 +00:00
< 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" class = "active" > < 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 Config< / a > < / li > < li class = "chapter-item expanded " > < a href = "modes.html" > < strong aria-hidden = "true" > 3.2.< / strong > Modes< / a > < / li > < li class = "chapter-item expanded " > < a href = "message.html" > < strong aria-hidden = "true" > 3.3.< / strong > Message< / a > < / li > < li class = "chapter-item expanded " > < a href = "layouts.html" > < strong aria-hidden = "true" > 3.4.< / strong > Layouts< / a > < / li > < li class = "chapter-item expanded " > < a href = "node_types.html" > < strong aria-hidden = "true" > 3.5.< / strong > Node Types< / a > < / li > < li class = "chapter-item expanded " > < a href = "style.html" > < strong aria-hidden = "true" > 3.6.< / strong > Style< / a > < / li > < li class = "chapter-item expanded " > < a href = "sorting.html" > < strong aria-hidden = "true" > 3.7.< / strong > Sorting< / a > < / li > < li class = "chapter-item expanded " > < a href = "filtering.html" > < strong aria-hidden = "true" > 3.8.< / strong > Filtering< / a > < / li > < li class = "chapter-item expanded " > < a href = "column-renderer.html" > < strong aria-hidden = "true" > 3.9.< / strong > Column Renderer< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "default-key-bindings.html" > < strong aria-hidden = "true" > 4.< / strong > Default Key Bindings< / a > < / li > < li class = "chapter-item expanded " > < a href = "plugin.html" > < strong aria-hidden = "true" > 5.< / strong > Plugin< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "installing-plugins.html" > < strong aria-hidden = "true" > 5.1.< / strong > Installing Plugins< / a > < / li > < li class = "chapter-item expanded " > < a href = "writing-plugins.html" > < strong aria-hidden = "true" > 5.2.< / strong > Writing Plugins< / a > < / li > < li class = "chapter-item expanded " > < a href = "awesome-plugins.html" > < strong aria-hidden = "true" > 5.3.< / strong > Awesome Plugins< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "integration.html" > < strong aria-hidden = "true" > 6.< / strong > Integration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "awesome-integrations.html" > < strong aria-hidden = "true" > 6.1.< / strong > Awesome Integrations< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "todo.html" > < strong aria-hidden = "true" > 7.< / strong > TODO< / a > < / 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 > < / div >
2021-06-23 10:02:10 +00:00
< 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 (default)< / 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 >
2021-06-23 11:54:40 +00:00
< 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/install.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
2021-06-23 10:02:10 +00:00
< / 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 = "install" > < a class = "header" href = "#install" > Install< / a > < / h1 >
< p > You can install xplr using one of the following ways. Each has their own
advantages and limitations.< / p >
< p > For example, the < a href = "#direct-download" > Direct Download< / a > ,
< a href = "#from-a-hrefhttpscratesiocratesxplrcratesioa" > From crates.io< / a > , and
< a href = "#build-from-source" > Build From Source< / a > methods allow the users to install the
latest possible version of xplr, but they have one common drawback - the user
will need to keep an eye on the releases, and manually upgrade xplr when a new
version is available.< / p >
2021-07-13 13:35:44 +00:00
< p > One way to keep an eye on the releases is to
2021-06-23 10:02:10 +00:00
< a href = "https://github.com/sayanarijit/xplr/watchers" > watch the repository< / a > .< / p >
< h2 id = "community-maintained-repositories" > < a class = "header" href = "#community-maintained-repositories" > Community Maintained Repositories< / a > < / h2 >
< p > xplr can be installed from one of the following community maintained
repositories:< / p >
< p > < a href = "https://repology.org/project/xplr/versions" > < img src = "https://repology.org/badge/vertical-allrepos/xplr.svg" alt = "packaging status" / > < / a > < / p >
< h3 id = "arch-linux" > < a class = "header" href = "#arch-linux" > Arch Linux< / a > < / h3 >
< h4 id = "a-hrefhttpsarchlinuxorgpackagescommunityx86_64xplrofficial-community-repoa" > < a class = "header" href = "#a-hrefhttpsarchlinuxorgpackagescommunityx86_64xplrofficial-community-repoa" > < a href = "https://archlinux.org/packages/community/x86_64/xplr" > Official Community Repo< / a > < / a > < / h4 >
2021-06-24 17:27:00 +00:00
< pre > < code > sudo pacman -S xplr
2021-06-23 10:02:10 +00:00
< / code > < / pre >
< h4 id = "a-hrefhttpsaurarchlinuxorgpackageso0sebnkxplroutdatedsbnsoapp50do_searchgoaura" > < a class = "header" href = "#a-hrefhttpsaurarchlinuxorgpackageso0sebnkxplroutdatedsbnsoapp50do_searchgoaura" > < a href = "https://aur.archlinux.org/packages/?O=0&SeB=n&K=xplr&outdated=&SB=n&SO=a&PP=50&do_Search=Go" > AUR< / a > < / a > < / h4 >
< p > Binary version:< / p >
< pre > < code > paru -S xplr-bin
< / code > < / pre >
< p > Git version:< / p >
2021-06-23 11:54:40 +00:00
< pre > < code > paru -S xplr-git
2021-06-23 10:02:10 +00:00
< / code > < / pre >
< h3 id = "void-linux" > < a class = "header" href = "#void-linux" > Void Linux< / a > < / h3 >
< h4 id = "a-hrefhttpsgithubcomshubham-cppvoid-pkg-templatesvoid-templates-by-shubhama" > < a class = "header" href = "#a-hrefhttpsgithubcomshubham-cppvoid-pkg-templatesvoid-templates-by-shubhama" > < a href = "https://github.com/shubham-cpp/void-pkg-templates" > void-templates by shubham< / a > < / a > < / h4 >
< h3 id = "nixos" > < a class = "header" href = "#nixos" > Nix(OS)< / a > < / h3 >
< h4 id = "a-hrefhttpsgithubcomnixosnixpkgsblobmasterpkgsapplicationsmiscxplrnixpkgsa" > < a class = "header" href = "#a-hrefhttpsgithubcomnixosnixpkgsblobmasterpkgsapplicationsmiscxplrnixpkgsa" > < a href = "https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/xplr" > Nixpkgs< / a > < / a > < / h4 >
< pre > < code > nix-env -f https://github.com/NixOS/nixpkgs/tarball/master -iA xplr
< / code > < / pre >
< h3 id = "macos" > < a class = "header" href = "#macos" > macOS< / a > < / h3 >
< h4 id = "a-hrefhttpsportsmacportsorgportxplrmacportsa" > < a class = "header" href = "#a-hrefhttpsportsmacportsorgportxplrmacportsa" > < a href = "https://ports.macports.org/port/xplr" > MacPorts< / a > < / a > < / h4 >
< pre > < code > sudo port selfupdate
sudo port install xplr
< / code > < / pre >
< h4 id = "a-hrefhttpsformulaebrewshformulaxplrhomebrewa" > < a class = "header" href = "#a-hrefhttpsformulaebrewshformulaxplrhomebrewa" > < a href = "https://formulae.brew.sh/formula/xplr" > Homebrew< / a > < / a > < / h4 >
< p > Stable branch:< / p >
< pre > < code > brew install xplr
< / code > < / pre >
< p > HEAD branch:< / p >
< pre > < code > brew install --head xplr
< / code > < / pre >
< h3 id = "freebsd" > < a class = "header" href = "#freebsd" > FreeBSD< / a > < / h3 >
< h4 id = "a-hrefhttpscgitfreebsdorgportsplainmiscxplrportsa" > < a class = "header" href = "#a-hrefhttpscgitfreebsdorgportsplainmiscxplrportsa" > < a href = "https://cgit.freebsd.org/ports/plain/misc/xplr/" > ports< / a > < / a > < / h4 >
2021-07-06 10:07:08 +00:00
< pre > < code > pkg install xplr
< / code > < / pre >
< p > Or< / p >
2021-06-23 10:02:10 +00:00
< pre > < code > cd /usr/ports/misc/xplr
2021-07-06 10:07:08 +00:00
make install clean
2021-06-23 10:02:10 +00:00
< / code > < / pre >
< h3 id = "netbsd" > < a class = "header" href = "#netbsd" > NetBSD< / a > < / h3 >
< h4 id = "a-hrefhttpspkgsrcsesysutilsxplrpkgsrca" > < a class = "header" href = "#a-hrefhttpspkgsrcsesysutilsxplrpkgsrca" > < a href = "https://pkgsrc.se/sysutils/xplr" > pkgsrc< / a > < / a > < / h4 >
< pre > < code > pkgin install xplr
< / code > < / pre >
2021-07-06 10:07:08 +00:00
< p > Or< / p >
2021-06-23 10:02:10 +00:00
< pre > < code > cd /usr/pkgsrc/sysutils/xplr
make install
< / code > < / pre >
< h2 id = "direct-download" > < a class = "header" href = "#direct-download" > Direct Download< / a > < / h2 >
< p > One can directly download the standalone binary from the
< a href = "https://github.com/sayanarijit/xplr/releases" > releases< / a > .< / p >
< p > Currently, the following options are available for direct download:< / p >
< ul >
< li > < a href = "https://github.com/sayanarijit/xplr/releases/latest/download/xplr-linux.tar.gz" > Linux< / a > < / li >
< li > < a href = "https://github.com/sayanarijit/xplr/releases/latest/download/xplr-macos.tar.gz" > macOS< / a > < / li >
< / ul >
< p > Command-line instructions:< / p >
< pre > < code class = "language-bash" > platform=" linux" # or " macos"
# Download
wget https://github.com/sayanarijit/xplr/releases/latest/download/xplr-$platform.tar.gz
# Extract
tar xzvf xplr-$platform.tar.gz
# Place in $PATH
sudo mv xplr /usr/local/bin/
< / code > < / pre >
< h2 id = "from-a-hrefhttpscratesiocratesxplrcratesioa" > < a class = "header" href = "#from-a-hrefhttpscratesiocratesxplrcratesioa" > From < a href = "https://crates.io/crates/xplr" > crates.io< / a > < / a > < / h2 >
< p > Prerequisites:< / p >
< ul >
< li > < a href = "https://www.rust-lang.org/tools/install" > Rust toolchain< / a > ,< / li >
< li > < a href = "https://gcc.gnu.org/" > gcc< / a > < / li >
< li > < a href = "https://www.gnu.org/software/make/" > make< / a > < / li >
< / ul >
< p > Command-line instructions:< / p >
2021-09-27 15:10:33 +00:00
< pre > < code class = "language-bash" > cargo install --locked --force xplr
2021-06-23 10:02:10 +00:00
< / code > < / pre >
< h2 id = "build-from-source" > < a class = "header" href = "#build-from-source" > Build From Source< / a > < / h2 >
< p > Prerequisites:< / p >
< ul >
< li > < a href = "https://git-scm.com/" > git< / a > < / li >
< li > < a href = "https://www.rust-lang.org/tools/install" > Rust toolchain< / a > < / li >
< li > < a href = "https://gcc.gnu.org/" > gcc< / a > < / li >
< li > < a href = "https://www.gnu.org/software/make/" > make< / a > < / li >
< / ul >
< p > Command-line instructions:< / p >
< pre > < code class = "language-bash" > # Clone the repository
git clone https://github.com/sayanarijit/xplr.git
cd xplr
# Build
2021-09-27 15:10:33 +00:00
cargo build --locked --release --bin xplr
2021-06-23 10:02:10 +00:00
# Place in $PATH
sudo cp target/release/xplr /usr/local/bin/
< / code > < / pre >
< h2 id = "android" > < a class = "header" href = "#android" > Android< / a > < / h2 >
< h3 id = "a-hrefhttpstermuxcomtermuxa" > < a class = "header" href = "#a-hrefhttpstermuxcomtermuxa" > < a href = "https://termux.com/" > Termux< / a > < / a > < / h3 >
< p > < a href = "https://gifyu.com/image/tF2D" > < img src = "https://s3.gifyu.com/images/xplr-termuxfd3c398d3cf4bcbc.md.jpg" alt = "xplr-termuxfd3c398d3cf4bcbc.md.jpg" / > < / a > < / p >
< blockquote >
< p > Please note that xplr isn't heavily tested on Termux, hence things might
need a little tweaking and fixing for a smooth usage experience.< / p >
< / blockquote >
< ul >
< li >
< p > Install build dependencies< / p >
< pre > < code class = "language-bash" > pkg install rustc cargo make
< / code > < / pre >
< / li >
< li >
< p > Install < code > xplr< / code > < / p >
2021-09-27 15:10:33 +00:00
< pre > < code class = "language-bash" > cargo install --locked --force xplr
2021-06-23 10:02:10 +00:00
< / code > < / pre >
< / li >
< li >
< p > Setup storage< / p >
< pre > < code class = "language-bash" > termux-setup-storage
< / code > < / pre >
< / li >
< li >
< p > Setup config and runtime dir< / p >
< pre > < code class = "language-bash" > export XDG_CONFIG_HOME=" $PWD/storage/.config"
export XDG_RUNTIME_DIR=" $PWD/storage/run"
mkdir -p " $XDG_CONFIG_HOME" " $XDG_RUNTIME_DIR"
< / code > < / pre >
< / li >
< li >
< p > Run< / p >
< pre > < code class = "language-bash" > ~/.cargo/bin/xplr
< / code > < / pre >
< / li >
< / ul >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "quickstart.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 = "post-install.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 = "quickstart.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 = "post-install.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 >
